Skip to content
Open
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
13 changes: 13 additions & 0 deletions aws_lambda_powertools/logging/logger.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
from aws_lambda_powertools.logging.filters import SuppressFilter
from aws_lambda_powertools.logging.formatter import (
RESERVED_FORMATTER_CUSTOM_KEYS,
RESERVED_LOG_ATTRS,
BasePowertoolsFormatter,
LambdaPowertoolsFormatter,
)
Expand Down Expand Up @@ -808,6 +809,12 @@ def exception(
)

def append_keys(self, **additional_keys: object) -> None:
for key, value in additional_keys.items():
if key in RESERVED_LOG_ATTRS and value and not isinstance(value, str):
raise ValueError(
f"Key '{key}' is a reserved LogRecord attribute and needs a str value, "
f"instead got '{type(value).__name__}'.",
)
self.registered_formatter.append_keys(**additional_keys)

def get_current_keys(self) -> dict[str, Any]:
Expand Down Expand Up @@ -856,6 +863,12 @@ def clear_state(self) -> None:
# They prevent race conditions and ensure data consistency across multiple threads.
def thread_safe_append_keys(self, **additional_keys: object) -> None:
# Append additional key-value pairs to the context safely in a thread-safe manner.
for key, value in additional_keys.items():
if key in RESERVED_LOG_ATTRS and value and not isinstance(value, str):
raise ValueError(
f"Key '{key}' is a reserved LogRecord attribute and needs a str value, "
f"instead got '{type(value).__name__}'.",
)
self.registered_formatter.thread_safe_append_keys(**additional_keys)

def thread_safe_get_current_keys(self) -> dict[str, Any]:
Expand Down
30 changes: 30 additions & 0 deletions tests/functional/logger/required_dependencies/test_logger.py
Original file line number Diff line number Diff line change
Expand Up @@ -1618,3 +1618,33 @@ def handler(event, context):
log = capture_logging_output(stdout)
assert log["function_name"] == lambda_context.function_name
assert log["function_request_id"] == lambda_context.aws_request_id


def test_append_keys_rejects_reserved_log_attrs(stdout, service_name):
# GIVEN a Logger is initialized
logger = Logger(service=service_name, stream=stdout)

# WHEN attempting to append a reserved LogRecord attribute
# THEN it should raise ValueError with clear message
with pytest.raises(ValueError, match="Key 'lineno' is a reserved LogRecord attribute"):
logger.append_keys(lineno=5)

# AND subsequent logs should still work normally
logger.info("after rejected append")
output = stdout.getvalue()
assert "after rejected append" in output


def test_thread_safe_append_keys_rejects_reserved_log_attrs(stdout, service_name):
# GIVEN a Logger is initialized
logger = Logger(service=service_name, stream=stdout)

# WHEN attempting to append a reserved LogRecord attribute in thread-safe method
# THEN it should raise ValueError
with pytest.raises(ValueError, match="Key 'levelname' is a reserved LogRecord attribute"):
logger.thread_safe_append_keys(levelname=20)

# AND subsequent logs should still work normally
logger.info("after rejected thread-safe append")
output = stdout.getvalue()
assert "after rejected thread-safe append" in output