File size: 4,069 Bytes
26e6f31 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 | from __future__ import annotations
import logging
from typing import TYPE_CHECKING, Callable
if TYPE_CHECKING:
from aws_lambda_powertools.logging.logger import Logger
PACKAGE_LOGGER = "aws_lambda_powertools"
LOGGER = logging.getLogger(__name__)
def copy_config_to_registered_loggers(
source_logger: Logger,
log_level: int | str | None = None,
ignore_log_level=False,
exclude: set[str] | None = None,
include: set[str] | None = None,
) -> None:
"""Copies source Logger level and handler to all registered loggers for consistent formatting.
Parameters
----------
ignore_log_level
source_logger : Logger
Powertools for AWS Lambda (Python) Logger to copy configuration from
log_level : int | str, optional
Logging level to set to registered loggers, by default uses source_logger logging level
ignore_log_level: bool
Whether to not touch log levels for discovered loggers. log_level param is disregarded when this is set.
include : set[str] | None, optional
List of logger names to include, by default all registered loggers are included
exclude : set[str] | None, optional
List of logger names to exclude, by default None
"""
level = log_level or source_logger.log_level
# Assumptions: Only take parent loggers not children (dot notation rule)
# Steps:
# 1. Default operation: Include all registered loggers
# 2. Only include set? Only add Loggers in the list and ignore all else
# 3. Include and exclude set? Add Logger if it’s in include and not in exclude
# 4. Only exclude set? Ignore Logger in the excluding list
# Exclude source and Powertools for AWS Lambda (Python) package logger by default
# If source logger is a child ensure we exclude parent logger to not break child logger
# 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}
# Prepare loggers set
if include:
loggers = include.difference(exclude)
filter_func = _include_registered_loggers_filter
else:
loggers = exclude
filter_func = _exclude_registered_loggers_filter
registered_loggers = _find_registered_loggers(loggers=loggers, filter_func=filter_func)
for logger in registered_loggers:
_configure_logger(source_logger=source_logger, logger=logger, level=level, ignore_log_level=ignore_log_level)
def _include_registered_loggers_filter(loggers: set[str]):
return [logging.getLogger(name) for name in logging.root.manager.loggerDict if "." not in name and name in loggers]
def _exclude_registered_loggers_filter(loggers: set[str]) -> list[logging.Logger]:
return [
logging.getLogger(name) for name in logging.root.manager.loggerDict if "." not in name and name not in loggers
]
def _find_registered_loggers(
loggers: set[str],
filter_func: Callable[[set[str]], list[logging.Logger]],
) -> list[logging.Logger]:
"""Filter root loggers based on provided parameters."""
root_loggers = filter_func(loggers)
LOGGER.debug(f"Filtered root loggers: {root_loggers}")
return root_loggers
def _configure_logger(
source_logger: Logger,
logger: logging.Logger,
level: int | str,
ignore_log_level: bool = False,
) -> None:
# customers may not want to copy the same log level from Logger to discovered loggers
if not ignore_log_level:
logger.setLevel(level)
LOGGER.debug(f"Logger {logger} reconfigured to use logging level {level}")
logger.handlers = []
logger.propagate = False # ensure we don't propagate logs to existing loggers, #1073
source_logger.append_keys(name="%(name)s") # include logger name, see #1267
for source_handler in source_logger.handlers:
logger.addHandler(source_handler)
LOGGER.debug(f"Logger {logger} reconfigured to use {source_handler}")
|