Skip to content

docs: Update metrics docs to mention correct POWERTOOLS_METRICS_DISABLED variable name. #3848

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.

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

jorovipe97
Copy link

@jorovipe97 jorovipe97 commented Apr 22, 2025

Summary

Changes

Please provide a summary of what's being changed

The metrics docs mention POWERTOOLS_METRICS_ENABLED can be used to not log the metrics. However this env variable is not used. Insted it uses POWERTOOLS_METRICS_DISABLED.

Check line where env variables for Metrics are defined.

Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed

Issue number: #3847


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

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

Docs mentions POWERTOOLS_METRICS_ENABLED however the library does not uses this environment variable to control metrics logs. Instead it uses POWERTOOLS_METRICS_DISABLED
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Apr 22, 2025
Copy link

boring-cyborg bot commented Apr 22, 2025

Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
In the meantime, check out the #typescript channel on our Powertools for AWS Lambda Discord: Invite link

@pull-request-size pull-request-size bot added the size/XS PR between 0-9 LOC label Apr 22, 2025

This comment was marked as outdated.

@github-actions github-actions bot added do-not-merge This item should not be merged need-issue This PR needs an issue before it can be reviewed/worked on further labels Apr 22, 2025
@dreamorosi dreamorosi removed do-not-merge This item should not be merged need-issue This PR needs an issue before it can be reviewed/worked on further labels Apr 22, 2025
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

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

Could you please also update the env variable here?

Other than that it's ok.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/XS PR between 0-9 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants