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
8 changes: 3 additions & 5 deletions aws_lambda_powertools/logging/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def copy_config_to_registered_loggers(
exclude : set[str] | None, optional
List of logger names to exclude, by default None
"""
level = log_level or source_logger.log_level
level = source_logger.log_level if log_level in (None, "") else log_level

# Assumptions: Only take parent loggers not children (dot notation rule)
# Steps:
Expand All @@ -54,10 +54,8 @@ def copy_config_to_registered_loggers(
# from receiving/pushing updates to keys being added/removed
source_logger_name = source_logger.name.split(".")[0]

if exclude:
exclude.update([source_logger_name, PACKAGE_LOGGER])
else:
exclude = {source_logger_name, PACKAGE_LOGGER}
# Build a new set so the caller's exclude set is not changed
exclude = {*(exclude or ()), source_logger_name, PACKAGE_LOGGER}

# Prepare loggers set
if include:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,53 @@ def test_copy_config_to_ext_loggers_custom_log_level(stdout, logger, log_level,
assert log["level"] == log_level.WARNING.name


def test_copy_config_to_ext_loggers_keeps_caller_exclude_set(stdout, logger, log_level):
# GIVEN an external logger and Powertools for AWS Lambda (Python) logger initialized
logger = logger()
powertools_logger = Logger(service=service_name(), level=log_level.INFO.value, stream=stdout)
exclude = {logger.name}

# WHEN configuration copied with a caller-owned exclude set
utils.copy_config_to_registered_loggers(source_logger=powertools_logger, exclude=exclude)

# THEN the caller's exclude set is not changed
assert exclude == {logger.name}
assert not logger.handlers


def test_copy_config_to_ext_loggers_log_level_notset(stdout, logger, log_level):
# GIVEN an external logger and Powertools for AWS Lambda (Python) logger initialized
logger = logger()
powertools_logger = Logger(service=service_name(), level=log_level.CRITICAL.value, stream=stdout)

# WHEN configuration copied with log_level NOTSET (0)
utils.copy_config_to_registered_loggers(
source_logger=powertools_logger,
log_level=log_level.NOTSET.value,
include={logger.name},
)

# THEN external logger uses NOTSET instead of the source logger level
assert powertools_logger.level == log_level.CRITICAL.value
assert logger.level == log_level.NOTSET.value

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A test for the empty string. It fails on this branch with ValueError: Unknown level: '' and passes with the change above.

Suggested change
assert logger.level == log_level.NOTSET.value
assert logger.level == log_level.NOTSET.value
def test_copy_config_to_ext_loggers_empty_log_level_uses_source_level(stdout, logger, log_level):
# GIVEN an external logger and Powertools for AWS Lambda (Python) logger initialized
logger = logger()
powertools_logger = Logger(service=service_name(), level=log_level.CRITICAL.value, stream=stdout)
# WHEN configuration copied with an empty log_level
utils.copy_config_to_registered_loggers(
source_logger=powertools_logger,
log_level="",
include={logger.name},
)
# THEN external logger falls back to the source logger level
assert logger.level == log_level.CRITICAL.value

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added this test too. It fails without the change and passes with it.



def test_copy_config_to_ext_loggers_empty_log_level_uses_source_level(stdout, logger, log_level):
# GIVEN an external logger and Powertools for AWS Lambda (Python) logger initialized
logger = logger()
powertools_logger = Logger(service=service_name(), level=log_level.CRITICAL.value, stream=stdout)

# WHEN configuration copied with an empty log_level
utils.copy_config_to_registered_loggers(
source_logger=powertools_logger,
log_level="",
include={logger.name},
)

# THEN external logger falls back to the source logger level
assert logger.level == log_level.CRITICAL.value


def test_copy_config_to_ext_loggers_should_not_break_append_keys(stdout, log_level):
# GIVEN Powertools for AWS Lambda (Python) logger initialized
powertools_logger = Logger(service=service_name(), level=log_level.INFO.value, stream=stdout)
Expand Down