Configuring the logger

Almost all configurations can and should be passed through environment variables, to follow the 12-factor app principles.

Common Environment variables

Variable name(s)	From Python	Default value	Description
LOGGIA_LEVEL	set_general_level	INFO	The log level number or name.
LOGGIA_SUB_LEVEL	set_logger_level	INFO	The log level number or name for any given named logger.
LOGGIA_PRESETS	only during LoggerConfiguration construction	prod	Preferences for Loggia Presets

Advanced Environment variables

These variables are not commonly modified, and changing them requires a good understanding of Loggia's internals --- at least while the documentation remains sparse.

Variable name(s)	From Python	Default value	Description
LOGGIA_FORMATTER	set_default_formatter	(unset)	The fully qualified name of a logging.Formatter - see loggia.stdlib_formatters for available options.
LOGGIA_SET_EXCEPTHOOK	set_excepthook	(unset)	Whether the logger should set the sys.excepthook.
LOGGIA_SET_UNRAISABLEHOOK	set_unraisablehook	(unset)	Whether the logger should set the sys.unraisablehook.
LOGGIA_SET_THREADING_EXCEPTHOOK	set_threading_excepthook	(unset)	Whether the logger should set the threading.excepthook.
LOGGIA_CAPTURE_WARNINGS	set_capture_warnings	(unset)	Whether the logger should capture warnings from the warnings module.
LOGGIA_CAPTURE_LOGURU	set_loguru_capture	(unset)	Whether the logger should capture logs emitted through loguru.
LOGGIA_EXTRA_FILTERS	add_log_filter	(unset)
LOGGIA_DISALLOW_LOGURU_RECONFIG	set_loguru_reconfiguration_block	(unset)	Explicitely allow loguru to be reconfigured.
LOGGIA_SUB_PROPAGATION	set_logger_propagation	(unset)

Environment variable parsers

Note

For boolean values coming from the environment, most values are truthy, and a few values are falsy: FALSE, 0, F, NO and DISABLED will be interpreted as False.

The falsy values are case-insentive, i.e. disabled is also False.

Warning

This library will not load .env files for you.

You are responsible for loading them yourself, using source .env or your favorite library. Possible libraries are python-dotenv or python-decouple to load your .env files.

Configuration precedence

Loggia is configured through four different ways (see how), each overriding the previous one.

stateDiagram-v2
defaults : Loggia default dictconfig
presets: Presets
args : LoggerConfiguration.__init__ API
env : Environment
calls : LoggerConfiguration API


defaults --> presets
presets --> args
args --> env
env --> calls

1. The static base configuration. NB: We go with only one handler to stdout in true cloud-native fashion.
2. Presets are loaded according to preferences (see Presets)
3. Options passed to the LoggerConfiguration constructor override the above (if any)
4. Environment variables override the above (if any)
5. Methods called on a LoggerConfiguration instance in Python have the last word.