logs

Util functions to declare/define a robust logger + respective handlers/formatter

Classes:

• MicrosecondFormatter –

  Logging formatter enabling microsecond formatting

Functions:

• configure_external_logging –

  Function to configure external logging

• get_file_handler –

  Function to build a valid file handler

• get_formatter –

  Function to build a valid logging formatter

• get_logger –

  Function to get a valid logger instance

• get_loki_handler –

  Function to build a valid Loki logging handler

• get_stream_handler –

  Function to build a valid logging stream handler

• get_time_rotating_file_handler –

  Function to build a valid timed rotating file handler

• setup_logger –

  Function to set up a valid root (geotag) logger

MicrosecondFormatter

Bases: Formatter

Logging formatter enabling microsecond formatting (overloading of built-in logging.Formatter)

Methods:

• formatTime –

  Function to format time

formatTime

formatTime(record: LogRecord, datefmt: str | None = None) -> str

Function to format time (overloading of logging.Formatter.formatTime(...))

Parameters:

• record

  (LogRecord) –

  Log record

• datefmt

  (str | None, default: None ) –

  Date format (if specified)

Returns:

• str –

  Formatted time for a given log record instance

configure_external_logging

configure_external_logging(log_level: int = WARNING) -> None

Function to configure external logging

Returns:

• None –

  Nothing

get_file_handler

get_file_handler() -> Handler

Function to build a valid file handler

Returns:

• FileHandler –

  File handler

get_formatter

get_formatter() -> Formatter

Function to build a valid logging formatter

Returns:

• logging.Formatter –

  Formatter object

get_logger

get_logger(name: str) -> Logger

Function to get a valid logger instance

Parameters:

• name

  (str) –

  Logger name

Returns:

• logging.Logger –

  Valid logger instance

get_loki_handler

get_loki_handler() -> Handler

Function to build a valid Loki logging handler

Returns:

• logging.Handler –

  Loki Logger handler

get_stream_handler

get_stream_handler() -> Handler

Function to build a valid logging stream handler (stdout/stderr)

Returns:

• logging.Handler –

  Stream handler

get_time_rotating_file_handler

get_time_rotating_file_handler() -> Handler

Function to build a valid timed rotating file handler

Returns:

• TimedRotatingFileHandler –

  Timed rotating file handler

setup_logger

setup_logger() -> None

Function to set up a valid root (geotag) logger This function must only be called on project's entry points It also disables external packages logging

Returns:

• None –

  Nothing