fw-logging 0.2.1

Logging helper library.

fw-logging

Logging helper module standardizing logging and reducing boilerplate.

Installation

Add as a poetry dependency to your project:

poetry add fw-logging

Usage

Dev

The default config is recommended for development, sending logs to stdout and colorizing level names if a TTY is detected.

import fw_logging
fw_logging.setup_logging()

Prod

Production apps should emit JSON-formatted structured logs instead, which can be enabled via the envvar FW_LOG_FORMATTER=json in a ConfigMap.

Config

fw_logging may be further configured using envvars and/or kwargs passed to setup_logging or get_log_config, where keyword arguments take precedence using the LogConfig pydantic model. See the most important envvars with their defaults below or check out fw_logging.py for more details.

Envvar	Default
FW_LOG_HANDLER	"stdout"
FW_LOG_FORMATTER	"text"
FW_LOG_LEVEL	"INFO"

Development

Install the project using poetry and enable pre-commit:

poetry install
pre-commit install

License