Skip to content

docs(metrics): remove serializeMetrics and fix cloudwatch excerpt #376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

docs(metrics): remove serializeMetrics and fix cloudwatch excerpt #376

wants to merge 2 commits into from

Conversation

flochaz
Copy link
Contributor

@flochaz flochaz commented Jan 3, 2022

Description of your changes

Following @ijemmy remarks, this PR improve metrics docs by

  • removing mention of serializeMetrics() method
  • add tabs for cloudwatch log output examples

How to verify this change

  1. build and run doc
npm run docs-buildDockerImage && npm run docs-runLocalDocker
  1. go to http://localhost:8000/core/metrics/

Related issues, RFCs

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published in downstream module
  • The PR title follows the conventional commit semantics

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

dreamorosi
dreamorosi reviewed Jan 3, 2022
View reviewed changes
@dreamorosi dreamorosi added documentation Improvements or additions to documentation metrics This item relates to the Metrics Utility labels Jan 3, 2022
@dreamorosi dreamorosi added this to the beta-release milestone Jan 3, 2022
ijemmy
ijemmy approved these changes Jan 3, 2022
View reviewed changes
Copy link
Contributor

@ijemmy ijemmy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small nit. But it looks ok overall.

saragerion
saragerion reviewed Jan 3, 2022
View reviewed changes
Copy link
Contributor

@saragerion saragerion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Florian! Added some minor comments

saragerion
saragerion approved these changes Jan 4, 2022
View reviewed changes
Copy link
Contributor

@saragerion saragerion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a couple of comments, but looks good already

@flochaz
Copy link
Contributor Author

flochaz commented Jan 4, 2022

Closing since it will be covered by @dreamorosi CR on homogenized doc

@flochaz flochaz closed this Jan 4, 2022
dreamorosi added a commit that referenced this pull request Jan 4, 2022
@dreamorosi
Added changes from #376
a93e905
@dreamorosi dreamorosi mentioned this pull request Jan 4, 2022
Merged
12 tasks
dreamorosi added a commit that referenced this pull request Jan 5, 2022
@dreamorosi @flochaz
@saragerion @ijemmy
docs(all): make docs more coherent (#387)
a08bf76 
* chore(test): test

* docs(metrics): remove serializeMetrics and fix cloudwatch excerpt

* fix: tracer construct initializer

* Conformed tracer & logger

* Added changes from #376

* Added lambdaInterface to logger examples

* docs: update docs/core/logger.md

Co-authored-by: Sara Gerion <[email protected]>

* docs: updated return type for all async handlers

* docs: update docs/core/metrics.md

Co-authored-by: Sara Gerion <[email protected]>

* docs: update docs/core/metrics.md

Co-authored-by: Sara Gerion <[email protected]>

* docs: update docs/core/metrics.md

Co-authored-by: Sara Gerion <[email protected]>

* docs: updated all references to publishStoredMetrics

* docs: replaced extends w/ implements keyword in classes

* docs: switched to serviceName according to #401

* docs: switched to serviceName according to #401

* docs: update docs/core/tracer.md

Co-authored-by: Florian Chazal <[email protected]>

* docs: update docs/core/metrics.md

Co-authored-by: Florian Chazal <[email protected]>

* docs: update docs/core/tracer.md

Co-authored-by: Florian Chazal <[email protected]>

* docs: update docs/core/logger.md

Co-authored-by: Florian Chazal <[email protected]>

* docs: update note on patching all modules

* docs: updated text in captureMethod section

* docs: update docs/core/metrics.md

Co-authored-by: ijemmy <[email protected]>

* docs: update docs/core/metrics.md

Co-authored-by: ijemmy <[email protected]>

* docs: updated other references to serverlessAirline

Co-authored-by: Florian CHAZAL <[email protected]>
Co-authored-by: Sara Gerion <[email protected]>
Co-authored-by: ijemmy <[email protected]>
@flochaz flochaz deleted the docs/fixMetrics branch January 7, 2022 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dreamorosi dreamorosi dreamorosi left review comments

@ijemmy ijemmy ijemmy approved these changes

@saragerion saragerion saragerion approved these changes

Assignees

@flochaz flochaz

Labels
documentation Improvements or additions to documentation metrics This item relates to the Metrics Utility
Projects
None yet
Milestone
beta-release
Development

Successfully merging this pull request may close these issues.
4 participants
@flochaz @ijemmy @dreamorosi @saragerion