Skip to content

docs(logger): improvements extensibility & new features #415

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

Conversation

heitorlessa
Copy link
Contributor

@heitorlessa heitorlessa commented May 3, 2021

Issue #, if available: #404

Description of changes:

Checklist

  • Meet tenets criteria
  • Update tests
  • Update docs
  • PR title follows conventional commit semantics
  • Update timestamp value to include timezone
  • Bare minimal attrs (level, message, service)
  • Update that all keys can be reordered including new ones
  • Document UTC support
  • Document default JSON fn for unserializable (json.dumps(data, default=json_default))
  • Bring your own formatter
  • Bring your own handler
  • Bringing orjson for those seeking to gain every possible microsecond - json_serializer, json_deserializer
  • Update Testing your code section to include how to use stream=sys.stdout

Breaking change checklist

RFC issue #:

  • Migration process documented
  • Implement warnings (if it can live side by side)

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

@heitorlessa heitorlessa added documentation Improvements or additions to documentation area/logger labels May 3, 2021
@heitorlessa heitorlessa changed the title chore: adjust content to fit improved timestamp docs(logger): improvements to reflect new features & extensibility May 3, 2021
@codecov-commenter
Copy link

codecov-commenter commented May 3, 2021

Codecov Report

Merging #415 (3ed5038) into develop (51c4c2d) will decrease coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #415      +/-   ##
===========================================
- Coverage    99.89%   99.89%   -0.01%     
===========================================
  Files          101      101              
  Lines         3976     3975       -1     
  Branches       198      198              
===========================================
- Hits          3972     3971       -1     
  Misses           1        1              
  Partials         3        3              
Impacted Files Coverage Δ
aws_lambda_powertools/logging/formatter.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 51c4c2d...3ed5038. Read the comment docs.

@heitorlessa heitorlessa marked this pull request as ready for review May 3, 2021 16:47
@heitorlessa heitorlessa changed the title docs(logger): improvements to reflect new features & extensibility docs(logger): improvements extensibility & new features May 3, 2021
@heitorlessa heitorlessa merged commit daa35aa into aws-powertools:develop May 3, 2021
@heitorlessa heitorlessa deleted the docs/logger-improvements branch May 3, 2021 16:53
@heitorlessa heitorlessa added this to the 1.15.0 milestone May 4, 2021
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants