structlog-configfile

Helpers to configure structlog together with standard-library logging from a small configuration module.

Installation

pip install structlog-configfile

Quick start

Replace the standard structlog logger factory with the package helper:

import structlog_configfile

logger = structlog_configfile.get_logger()
logger.info("hello", user="alice")

This loads the built-in defaults and configures both structlog and stdlib logging.

Using a custom configuration file

You can point the helper at your own Python configuration module:

import structlog_configfile

logger = structlog_configfile.get_logger(config_file="path/to/my_config.py" [, struct_log_logger_args])

Using a custom configuration file

You can point the helper at your own Python configuration module:

import custom_module.logging.config

logger = structlog_configfile.get_logger(config_file=custom_module.logging.config [, struct_log_logger_args])

You can also set the environment variable STRUCTLOG_CONFIG_FILE to avoid passing the path explicitly.

Example configuration module:

from pathlib import Path
import structlog

logging_config_file = Path(__file__).parent.joinpath("logging.yaml")

pre_process_processors = [
    structlog.processors.TimeStamper(fmt="iso"),
]

structlog_processors = []
logging_processors = []
post_process_processors = []
renderer = structlog.processors.JSONRenderer()
handleStdlib = True

Supported configuration knobs

The configuration module can define the following values:

• logging_config_file: path to the stdlib logging configuration file (https://docs.python.org/3/library/logging.config.html)
• pre_process_processors: processors applied before other processors
• structlog_processors: processors used for structlog logs
• logging_processors: processors used for stdlib logging
• post_process_processors: processors applied after all others
• renderer: the final renderer used by the logging formatter
• stdlib_preprocessor: processors for stdlib log preparation
• stdlib_processor: processors for stdlib log handling
• stdlib_postprocessor: processors applied after stdlib processing
• embeds_std_lib: enable or disable stdlib logging setup

Logging configuration file formats

The file referenced by logging_config_file can be a Jinja template or a YAML, JSON, or TOML file. The package will load it and use it for stdlib logging configuration.

Notes

The package exposes both get_logger() and getLoger() for compatibility.