fix(logger): ensure state is cleared for custom formatters #1072
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available: #1042
Description of changes:
This ensures custom logger formatters receive Lambda context keys and their state can be cleared upon each invocation when using
clear_state
. This PR also takes into account those usinglog_record_order
with custom formatters, if the state is ever cleared.The reason we use an
abstractmethod
is to ensure all functionalities (as docs suggested) will work for the ~1% of customers creating highly customized loggers that can work in more than Lambda environments. We initially thought in having warnings but given this is a bug behavior and the extreme edge case, it makes it worthwhile to enforce it early and improve documentation on use cases forLambdaPowertoolsFormatter
(common, no change required) vsBasePowertoolsFormatter
(edge case).Checklist
Breaking change checklist
RFC issue #:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.