Skip to content

refactor(logger): align implementation to spec + docs #3701

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

Merged
merged 6 commits into from
Mar 7, 2025

Conversation

dreamorosi
Copy link
Contributor

Summary

Changes

Please provide a summary of what's being changed

This PR aligns the implementation of the log buffering feature in Logger so that it aligns with the spec defined in the RFC. The implementation we got to differed slightly in a couple of important ways, namely:

  • it prioritized the log level decision over the buffering decision
  • it did not pass buffering configs to child loggers

This PR addresses these two differences and slightly refactors some of the internal props in the Logger related to the new feature so that they are all grouped together.

The PR also adds the documentation for the feature, largely mirroring the version written in aws-powertools/powertools-lambda-python#6060.

Integration tests will be added in a future PR in this iteration.

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

Issue number: closes #3700


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.

@dreamorosi dreamorosi self-assigned this Mar 6, 2025
@boring-cyborg boring-cyborg bot added documentation Improvements or additions to documentation logger This item relates to the Logger Utility tests PRs that add or change tests labels Mar 6, 2025
@pull-request-size pull-request-size bot added the size/XL PRs between 500-999 LOC, often PRs that grown with feedback label Mar 6, 2025
@github-actions github-actions bot added the enhancement PRs that introduce minor changes, usually to existing features label Mar 6, 2025
@dreamorosi dreamorosi requested a review from am29d March 6, 2025 19:32
Copy link

sonarqubecloud bot commented Mar 6, 2025

@dreamorosi dreamorosi merged commit 1ca4b26 into main Mar 7, 2025
77 checks passed
@dreamorosi dreamorosi deleted the refactor/logger_buffer branch March 7, 2025 08:36
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 enhancement PRs that introduce minor changes, usually to existing features logger This item relates to the Logger Utility size/XL PRs between 500-999 LOC, often PRs that grown with feedback tests PRs that add or change tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: align log buffering to spec
2 participants