X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=logging_utils.py;h=6ceba65f7b8ee2413ae8e1595bf653d169856e95;hb=532df2c5b57c7517dfb3dddd8c1358fbadf8baf3;hp=3fd2b849a3dcc2d030de28e0abe6c70cb1d9fe02;hpb=7ff2af6fe7bffea90dc4a31c93140c189917c659;p=python_utils.git diff --git a/logging_utils.py b/logging_utils.py index 3fd2b84..6ceba65 100644 --- a/logging_utils.py +++ b/logging_utils.py @@ -1,4 +1,7 @@ #!/usr/bin/env python3 +# -*- coding: utf-8 -*- + +# © Copyright 2021-2022, Scott Gasch """Utilities related to logging.""" @@ -13,7 +16,7 @@ import random import sys from logging.config import fileConfig from logging.handlers import RotatingFileHandler, SysLogHandler -from typing import Any, Callable, Dict, Iterable, List, Mapping, Optional +from typing import Any, Callable, Dict, Iterable, List, Optional import pytz from overrides import overrides @@ -174,8 +177,8 @@ cfg.add_argument( ), ) -built_in_print = print -logging_initialized = False +BUILT_IN_PRINT = print +LOGGING_INITIALIZED = False # A map from logging_callsite_id -> count of logged messages. @@ -223,8 +226,8 @@ class SquelchRepeatedMessagesFilter(logging.Filter): """ def __init__(self) -> None: - self.counters: collections.Counter = collections.Counter() super().__init__() + self.counters: collections.Counter = collections.Counter() @overrides def filter(self, record: logging.LogRecord) -> bool: @@ -257,9 +260,7 @@ class DynamicPerScopeLoggingLevelFilter(logging.Filter): per_scope_logging_levels: str, ) -> None: super().__init__() - self.valid_levels = set( - ['NOTSET', 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'] - ) + self.valid_levels = set(['NOTSET', 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']) self.default_logging_level = default_logging_level self.level_by_scope = {} if per_scope_logging_levels is not None: @@ -286,9 +287,9 @@ class DynamicPerScopeLoggingLevelFilter(logging.Filter): file=sys.stderr, ) continue - self.level_by_scope[ - scope - ] = DynamicPerScopeLoggingLevelFilter.level_name_to_level(level) + self.level_by_scope[scope] = DynamicPerScopeLoggingLevelFilter.level_name_to_level( + level + ) @overrides def filter(self, record: logging.LogRecord) -> bool: @@ -386,92 +387,97 @@ class MillisecondAwareFormatter(logging.Formatter): @overrides def formatTime(self, record, datefmt=None): - ct = MillisecondAwareFormatter.converter( - record.created, pytz.timezone("US/Pacific") - ) + ct = MillisecondAwareFormatter.converter(record.created, pytz.timezone("US/Pacific")) if datefmt: s = ct.strftime(datefmt) else: t = ct.strftime("%Y-%m-%d %H:%M:%S") - s = "%s,%03d" % (t, record.msecs) + s = f"{t},{record.msecs:%03d}" return s def log_about_logging( - logger, default_logging_level, preexisting_handlers_count, fmt, facility_name + logger, + default_logging_level, + preexisting_handlers_count, + fmt, + facility_name, ): - level_name = logging._levelToName.get( - default_logging_level, str(default_logging_level) - ) - logger.debug(f'Initialized global logging; default logging level is {level_name}.') - if ( - config.config['logging_clear_preexisting_handlers'] - and preexisting_handlers_count > 0 - ): - msg = f'Logging cleared {preexisting_handlers_count} global handlers (--logging_clear_preexisting_handlers)' - logger.warning(msg) - logger.debug(f'Logging format specification is "{fmt}"') - if config.config['logging_debug_threads']: - logger.debug( - '...Logging format spec captures tid/pid (--logging_debug_threads)' + level_name = logging._levelToName.get(default_logging_level, str(default_logging_level)) + logger.debug('Initialized global logging; default logging level is %s.', level_name) + if config.config['logging_clear_preexisting_handlers'] and preexisting_handlers_count > 0: + logger.warning( + 'Logging cleared %d global handlers (--logging_clear_preexisting_handlers)', + preexisting_handlers_count, ) + logger.debug('Logging format specification is "%s"', fmt) + if config.config['logging_debug_threads']: + logger.debug('...Logging format spec captures tid/pid. (--logging_debug_threads)') if config.config['logging_debug_modules']: logger.debug( - '...Logging format spec captures files/functions/lineno (--logging_debug_modules)' + '...Logging format spec captures files/functions/lineno. (--logging_debug_modules)' ) if config.config['logging_syslog']: logger.debug( - f'Logging to syslog as {facility_name} with priority mapping based on level' + 'Logging to syslog as %s with priority mapping based on level. (--logging_syslog)', + facility_name, ) if config.config['logging_filename']: - logger.debug(f'Logging to filename {config.config["logging_filename"]}') logger.debug( - f'...with {config.config["logging_filename_maxsize"]} bytes max file size.' + 'Logging to file "%s". (--logging_filename)', config.config["logging_filename"] + ) + logger.debug( + '...with %d bytes max file size. (--logging_filename_maxsize)', + config.config["logging_filename_maxsize"], ) logger.debug( - f'...and {config.config["logging_filename_count"]} rotating backup file count.' + '...and %d rotating backup file count. (--logging_filename_count)', + config.config["logging_filename_count"], ) if config.config['logging_console']: - logger.debug('Logging to the console (stderr).') + logger.debug('Logging to the console (stderr). (--logging_console)') if config.config['logging_info_is_print']: logger.debug( - 'Logging logger.info messages will be repeated on stdout (--logging_info_is_print)' + 'Logging logger.info messages will be repeated on stdout. (--logging_info_is_print)' ) if config.config['logging_squelch_repeats']: logger.debug( - 'Logging code allowed to request repeated messages be squelched (--logging_squelch_repeats)' + 'Logging code allowed to request repeated messages be squelched. (--logging_squelch_repeats)' ) else: logger.debug( - 'Logging code forbidden to request messages be squelched; all messages logged (--no_logging_squelch_repeats)' + 'Logging code forbidden to request messages be squelched; all messages logged. (--no_logging_squelch_repeats)' ) if config.config['logging_probabilistically']: logger.debug( - 'Logging code is allowed to request probabilistic logging (--logging_probabilistically)' + 'Logging code is allowed to request probabilistic logging. (--logging_probabilistically)' ) else: logger.debug( - 'Logging code is forbidden to request probabilistic logging; messages always logged (--no_logging_probabilistically)' + 'Logging code is forbidden to request probabilistic logging; messages always logged. (--no_logging_probabilistically)' ) if config.config['lmodule']: logger.debug( - f'Logging dynamic per-module logging enabled (--lmodule={config.config["lmodule"]})' + f'Logging dynamic per-module logging enabled. (--lmodule={config.config["lmodule"]})' ) if config.config['logging_captures_prints']: logger.debug( - 'Logging will capture printed data as logger.info messages (--logging_captures_prints)' + 'Logging will capture printed data as logger.info messages. (--logging_captures_prints)' ) def initialize_logging(logger=None) -> logging.Logger: - global logging_initialized - if logging_initialized: + global LOGGING_INITIALIZED + if LOGGING_INITIALIZED: return logging.getLogger() - logging_initialized = True + LOGGING_INITIALIZED = True if logger is None: logger = logging.getLogger() + # --logging_clear_preexisting_handlers removes logging handlers + # that were registered by global statements during imported module + # setup. preexisting_handlers_count = 0 assert config.has_been_parsed() if config.config['logging_clear_preexisting_handlers']: @@ -479,6 +485,8 @@ def initialize_logging(logger=None) -> logging.Logger: logger.removeHandler(logger.handlers[0]) preexisting_handlers_count += 1 + # --logging_config_file pulls logging settings from a config file + # skipping the rest of this setup. if config.config['logging_config_file'] is not None: fileConfig(config.config['logging_config_file']) return logger @@ -486,13 +494,13 @@ def initialize_logging(logger=None) -> logging.Logger: handlers: List[logging.Handler] = [] handler: Optional[logging.Handler] = None - # Global default logging level (--logging_level) - default_logging_level = getattr( - logging, config.config['logging_level'].upper(), None - ) + # Global default logging level (--logging_level); messages below + # this level will be silenced. + default_logging_level = getattr(logging, config.config['logging_level'].upper(), None) if not isinstance(default_logging_level, int): - raise ValueError('Invalid level: %s' % config.config['logging_level']) + raise ValueError(f'Invalid level: {config.config["logging_level"]}') + # Custom or default --logging_format? if config.config['logging_format']: fmt = config.config['logging_format'] else: @@ -500,11 +508,18 @@ def initialize_logging(logger=None) -> logging.Logger: fmt = '%(levelname).1s:%(filename)s[%(process)d]: %(message)s' else: fmt = '%(levelname).1s:%(asctime)s: %(message)s' + + # --logging_debug_threads and --logging_debug_modules both affect + # the format by prepending information about the pid/tid or + # file/function. if config.config['logging_debug_threads']: fmt = f'%(process)d.%(thread)d|{fmt}' if config.config['logging_debug_modules']: fmt = f'%(filename)s:%(funcName)s:%(lineno)s|{fmt}' + # --logging_syslog (optionally with --logging_syslog_facility) + # sets up for logging to use the standard system syslogd as a + # sink. facility_name = None if config.config['logging_syslog']: if sys.platform not in ('win32', 'cygwin'): @@ -521,6 +536,9 @@ def initialize_logging(logger=None) -> logging.Logger: ) handlers.append(handler) + # --logging_filename (with friends --logging_filename_count and + # --logging_filename_maxsize) set up logging to a file on the + # filesystem with automatic rotation when it gets too big. if config.config['logging_filename']: handler = RotatingFileHandler( config.config['logging_filename'], @@ -535,6 +553,7 @@ def initialize_logging(logger=None) -> logging.Logger: ) handlers.append(handler) + # --logging_console is, ahem, logging to the console. if config.config['logging_console']: handler = logging.StreamHandler(sys.stderr) handler.setFormatter( @@ -547,23 +566,37 @@ def initialize_logging(logger=None) -> logging.Logger: if len(handlers) == 0: handlers.append(logging.NullHandler()) - for handler in handlers: logger.addHandler(handler) + # --logging_info_is_print echoes any message to logger.info(x) as + # a print statement on stdout. if config.config['logging_info_is_print']: handler = logging.StreamHandler(sys.stdout) handler.addFilter(OnlyInfoFilter()) logger.addHandler(handler) + # --logging_squelch_repeats allows code to request repeat logging + # messages (identical log site and message contents) to be + # silenced. Logging code must request this explicitly, it isn't + # automatic. This option just allows the silencing to happen. if config.config['logging_squelch_repeats']: for handler in handlers: handler.addFilter(SquelchRepeatedMessagesFilter()) + # --logging_probabilistically allows code to request + # non-deterministic logging where messages have some probability + # of being produced. Logging code must request this explicitly. + # This option just allows the non-deterministic behavior to + # happen. Disabling it will cause every log message to be + # produced. if config.config['logging_probabilistically']: for handler in handlers: handler.addFilter(ProbabilisticFilter()) + # --lmodule is a way to have a special logging level for just on + # module or one set of modules that is different than the one set + # globally via --logging_level. for handler in handlers: handler.addFilter( DynamicPerScopeLoggingLevelFilter( @@ -574,8 +607,9 @@ def initialize_logging(logger=None) -> logging.Logger: logger.setLevel(0) logger.propagate = False + # --logging_captures_prints, if set, will capture and log.info + # anything printed on stdout. if config.config['logging_captures_prints']: - global built_in_print import builtins def print_and_also_log(*arg, **kwarg): @@ -584,7 +618,7 @@ def initialize_logging(logger=None) -> logging.Logger: logger.warning(*arg) else: logger.info(*arg) - built_in_print(*arg, **kwarg) + BUILT_IN_PRINT(*arg, **kwarg) builtins.print = print_and_also_log @@ -679,7 +713,7 @@ class OutputMultiplexer(object): self.h: Optional[List[Any]] = None if handles is not None: - self.h = [handle for handle in handles] + self.h = list(handles) else: if destination_bitv & OutputMultiplexer.Destination.FILEHANDLES: raise ValueError("Handle argument is required if bitv & FILEHANDLES")