feat(logger): add use_rfc3339 and auto-complete formatter opts in Logger

[heitorlessa]

Issue number: #946

Summary

This makes it easier to use a compatible date format with RFC3339 and ISO8601: 2022-10-27T16:27:43.738+02:00

Changes

Please provide a summary of what's being changed

User experience

Please share what the user experience looks like before and after this change

You can now simply use use_rfc3339 flag to enable it

logger = Logger(service=service_name, stream=stdout, use_rfc3339=True)

This PR also raised a suboptimal UX we had on propagating LambdaPowertoolsFormatter options in Logger as kwargs. When implementing this feature, it made it difficult to remember the entire param. For this reason, this PR exposes all of them within Logger constructor, so that: Logger(utc=, ...) autocompletes.

Checklist

If your change doesn't seem to apply, please leave them unchecked.

• Meet tenets criteria
• I have performed a self-review of this change
• Changes have been tested
• Changes are documented
• PR title follows conventional commit semantics

Is this a breaking change?

RFC issue number:

Checklist:

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

Acknowledgment

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.

[heitorlessa]

@leandrodamascena need your review as this must be included in today's release

[codecov-commenter]

Codecov Report

Base: 99.35% // Head: 99.35% // Increases project coverage by +0.00% 🎉

Coverage data is based on head (fdd9261) compared to base (87de70c).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #1662   +/-   ##
========================================
  Coverage    99.35%   99.35%           
========================================
  Files          128      128           
  Lines         5908     5917    +9     
  Branches       373      375    +2     
========================================
+ Hits          5870     5879    +9     
  Misses          18       18           
  Partials        20       20           

Impacted Files	Coverage Δ
aws_lambda_powertools/logging/formatter.py	100.00% <100.00%> (ø)
aws_lambda_powertools/logging/logger.py	100.00% <100.00%> (ø)
...da_powertools/utilities/idempotency/idempotency.py	100.00% <0.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[leandrodamascena]

Hi @heitorlessa! I tested it locally and it's working as expected!

I just made a comment, but if you don't agree with that I think this PR is read to merge.

[heitorlessa]

Addressed your feedback and shorten to use_rfc3339. I'll work on docs now to make this more visible.

[heitorlessa]

Docs done - @leandrodamascena if you approve, feel free to merge.

[leandrodamascena]

Docs done - @leandrodamascena if you approve, feel free to merge.

Amazing @heitorlessa!

[jplock]

Question on the usage of this, if I set use_rfc3339=True in the main Logger, and then reference another logger in another file with Logger(child=True), do I also have to set use_rfc3339=True in the child loggers?

[heitorlessa]

Nope it should just work, as a child logger will use the parent Logger formatter. I’ve also updated docs on Child Loggers that unless you truly need an explicit child Logger, you can use a Logger() if POWERTOOLS_SERVICE_NAME is set (Logger(service=service) otherwise)

…

On Mon, 31 Oct 2022 at 19:46, Justin Plock ***@***.***> wrote: Question on the usage of this, if I set use_rfc3339=True in the main Logger, and then reference another logger in another file with Logger(child=True), do I also have to set use_rfc3339=True in the child loggers? — Reply to this email directly, view it on GitHub <#1662 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAZPQBBUE5B5XBDIYLT6VN3WGAHZLANCNFSM6AAAAAARQJFQYA> . You are receiving this because you were mentioned.Message ID: ***@***.***>