fw-logging 2.3.0

Logging helper library.

fw-logging

Logging helper library for standard logging configuration, JSON formatting, and for tailing (non-)structured logs re-formatted and colorized for humans.

Installation

pip install fw-logging

Usage

logformat

Use the CLI utility logformat to re-format (Flywheel) logs for humans:

# pipe json and/or text logs directly
kubectl logs my-pod | logformat
# OR pass a filename containing the same
kubectl logs my-pod > my-pod.log
logformat my-pod.log
# OR pass a rich text file (.rtf) of logs
logformat my-pod-log.rtf

Library

Use the fw_logging module to set up python logging in 2 lines:

import fw_logging
fw_logging.setup_logging()

The default configuration sets up logging at level INFO to stdout, formatted as text with colorized levels and caller information.

To emit structured JSON logs in production just override the formatter using an environment variable: FW_LOG_FORMATTER=json.

Table of main config options and the corresponding envvars:

Envvar	Default	Alternative / Example
FW_LOG_LEVEL	INFO	DEBUG
FW_LOG_HANDLER	stdout	stderr
FW_LOG_FORMATTER	text	json
FW_LOG_LOGGERS		{"pika":"ERROR"}
FW_LOG_FILTERS		{"lgr":{"msg":"rgx"}}

License