tierkreis.logger_setup

Sets up the Tierkreis logger.

Module Contents

Functions

set_tkr_logger	Set up the ‘tierkreis’ logger.
add_handler_from_environment	Add a handler to a logger from TKR env variables.

Data

LOGGER_NAME

API

LOGGER_NAME = 'tierkreis'

set_tkr_logger(file_name: pathlib.Path, level: int | str = logging.INFO) → None

Set up the ‘tierkreis’ logger.

Adds a filehandler for use in the controller.

Parameters:

• file_name (Path) – The file to use for the logging.

• level (int | str, optional) – The log level, defaults to logging.INFO

add_handler_from_environment(logger: logging.Logger) → logging.Handler

Add a handler to a logger from TKR env variables.

Adds a stream handler on stderr with log level, format and date format taken from the environment variables $TKR_LOG_LEVEL, $TKR_LOG_FMT and $TKR_DATE_FORMAT. Returns the created handler so it can be removed later if needed.

Parameters:

logger (logging.Logger) – The logger to add the handler to.

Returns:

The created handler.

Return type:

logging.Handler