Skip to content

fix(logger): clear_state regression on absent standard keys #1088

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
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions aws_lambda_powertools/logging/formatter.py
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@ def remove_keys(self, keys: Iterable[str]):

def clear_state(self):
self.log_format = dict.fromkeys(self.log_record_order)
self.log_format.update(**self._build_default_keys())

@staticmethod
def _build_default_keys():
Expand Down
38 changes: 38 additions & 0 deletions tests/functional/test_logger.py
Original file line number Diff line number Diff line change
Expand Up @@ -663,6 +663,44 @@ def handler(event, context):
assert "my_key" not in second_log


def test_clear_state_keeps_standard_keys(lambda_context, stdout, service_name):
# GIVEN
logger = Logger(service=service_name, stream=stdout)
standard_keys = ["level", "location", "message", "timestamp", "service"]

# WHEN clear_state is set
@logger.inject_lambda_context(clear_state=True)
def handler(event, context):
logger.info("Foo")

# THEN all standard keys should be available as usual
handler({}, lambda_context)
handler({}, lambda_context)

first_log, second_log = capture_multiple_logging_statements_output(stdout)
for key in standard_keys:
assert key in first_log
assert key in second_log


def test_clear_state_keeps_exception_keys(lambda_context, stdout, service_name):
# GIVEN
logger = Logger(service=service_name, stream=stdout)

# WHEN clear_state is set and an exception was logged
@logger.inject_lambda_context(clear_state=True)
def handler(event, context):
try:
raise ValueError("something went wrong")
except Exception:
logger.exception("Received an exception")

# THEN we expect a "exception_name" to be "ValueError"
handler({}, lambda_context)
log = capture_logging_output(stdout)
assert "ValueError" == log["exception_name"]


def test_inject_lambda_context_allows_handler_with_kwargs(lambda_context, stdout, service_name):
# GIVEN
logger = Logger(service=service_name, stream=stdout)
Expand Down