Supplements a default formatter configuration for machine-readable JSON logging and applies it
Project description
python-logger
Supplements a default formatter configuration for machine-readable JSON logging and applies it.
This module should be included as a sub-module in python projects with logging. Please avoid copy-pasting as no updates can be supplied that way.
Usage
- Install the module via the
requirements.txt
or per CLI:pip install python-json-log-formatter
- Please include the
PythonLogger
module, using afrom module import class
statement. - After the imports, please declare a version constant.
This constant should use semantic versioning, with a prepended date(YYYY/MM/DD)
.
Other examples, without the date, can be found here - Before any argument parsing or any other logging, the logger should be initialized
- In EVERY file, the logger needs to be imported using
LOGGER = logging.getLogger(__name__)
from python_json_log_formatter import PythonLogger
import logging
VERSION = "1.0.0 (2022/11/24)"
PythonLogger.setup_logger(VERSION)
LOGGER = logging.getLogger(__name__)
Optionally, it is also possible to change the log level:
from python_json_log_formatter import PythonLogger
import logging
VERSION = "1.0.0 (2022/11/24)"
PythonLogger.setup_logger(VERSION, logging.DEBUG)
LOGGER = logging.getLogger(__name__)
Features
Sets the logging format for the root logger and thus for every child logger.
In EVERY file where logging happens, please use LOGGER = logging.getLogger(__name__)
to get an individual logger.
Allows printing exception information on any logging level, not only on the EXCEPTION
level but also for INFO
or DEBUG
.
Supply exec_info
to print these.
Sets pipeline_status
and job_status
to failed
on CRITICAL
, supports minor logging levels (41, etc).
To disable the logging on local machines, supply disable_log_formatting=True
when configuring the logger.
Alternatively, without code changes, you can supply the ENV var DISABLE_LOG_FORMATTING"=True
to generally disable it.
Every attribute of the LogRecord will be included in the formatted message unless specified in the excluded_logging_context_keys
list.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for python_json_log_formatter-3.3.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9abd388b35d8ef575b3242a1fdac98d7bc8e0577b62badadc532408ba1ee2d65 |
|
MD5 | 89d18b33c8ecfe5048c6395d9daa0b74 |
|
BLAKE2b-256 | d3ed133d601fbabdf723c45af24d520b914acc015da5fc27719c48022cc2c9ba |
Hashes for python_json_log_formatter-3.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d0e27548df6a5a04fbd8936ad92cabda75e4693b4bb28cdce2ad9ed5a15bf7ba |
|
MD5 | a818eddf94ac7504aa51aae7870e289b |
|
BLAKE2b-256 | 7fe591431e0054cac2d438bfd117c4a05556d16e9c539d78fb582d5895fbb786 |