docs(logger): improve mkdocs and examples of sample rate feature #389
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
saragerion
added
documentation
ijemmy
approved these changes
Jan 3, 2022
dreamorosi
reviewed
Jan 3, 2022
| // of being printed in a Lambda invocation | ||
| logger.debug("This is a DEBUG log that has 50% chance of being printed"); | ||
| logger.info("This is an INFO log that has 50% chance of being printed"); | ||
| logger.warn("This is a WARN log that has 50% chance of being printed"); | ||
|
|
||
| // Optional: refresh sample rate calculation on runtime |
There was a problem hiding this comment.
Just for my benefit, not trying to be annoying but only to understand myself.
Would this command reset the sample rate count, meaning that from here below all logs would have the original chance (set by sampleRateValue)? What's an example in which I'd use this?
There was a problem hiding this comment.
meaning that from here below all logs would have the original chance (set by sampleRateValue)?
Almost! Not "from here below", but for all logs produced by that logger instance
What's an example in which I'd use this?
If I remember correctly this was a feature request by the community for the python tool, I need to find the conversation
dreamorosi
approved these changes
Jan 3, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of your changes
The current version of the docs related to sample rate might be confusing and misleading, as they don't clarify the expected behaviour enough.
This PR includes some updates to mkdocs and examples of sample rate feature to clarify the feature and its behaviour.
How to verify this change
You can build and start a local docs website by running these two commands.
npm run docs-buildDockerImageORdocker build -t squidfunk/mkdocs-material ./docs/npm run docs-runLocalDockerORdocker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-materialVerify: http://0.0.0.0:8000/core/logger/#sampling-logs
Related issues, RFCs
#388
PR status
Is this ready for review?: YES
Is it a breaking change?: NO
Checklist
Breaking change checklist
N/A
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.