Skip to content

Docs: improve docs and examples of sample rate feature for Logger #388

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
saragerion opened this issue Jan 3, 2022 · 1 comment · Fixed by #389
Closed

Docs: improve docs and examples of sample rate feature for Logger #388

saragerion opened this issue Jan 3, 2022 · 1 comment · Fixed by #389
Assignees
@saragerion
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation logger This item relates to the Logger Utility
Milestone
beta-release

Comments

@saragerion
Copy link
Contributor

Description of the improvement

Summary of the proposal

The current version of the docs related to sample rate might be confusing and misleading, as they don't clarify the expected behaviour enough.

How, where did you look for information

Github pages docs, sample rate section + code examples

Missing or unclear documentation

https://awslabs.github.io/aws-lambda-powertools-typescript/0.2.0-beta.15/core/logger/#sampling-logs

Improvement

Clarify the expected behaviour.

Related existing documentation

Related issues, RFCs

N/A
@saragerion saragerion added the documentation Improvements or additions to documentation label Jan 3, 2022
@saragerion saragerion self-assigned this Jan 3, 2022
@saragerion saragerion added the logger This item relates to the Logger Utility label Jan 3, 2022
@saragerion saragerion added this to the beta-release milestone Jan 3, 2022
This was referenced Jan 3, 2022
Closed
Merged
@saragerion saragerion linked a pull request Jan 3, 2022 that will close this issue
docs(logger): improve mkdocs and examples of sample rate feature #389
Merged
10 tasks
@github-actions
Copy link
Contributor

github-actions bot commented Jan 4, 2022

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@dreamorosi dreamorosi changed the title Logger: improve docs and examples of sample rate feature Docs: improve docs and examples of sample rate feature for Logger Nov 14, 2022
@dreamorosi dreamorosi added the completed This item is complete and has been merged/shipped label Nov 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@saragerion saragerion

Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation logger This item relates to the Logger Utility
Projects
None yet
Milestone
beta-release
2 participants
@dreamorosi @saragerion