A collection of useful log formats for Python Loggers.
Project description
pyLogFormats
A collection of Logging Formats for the Pyton Standard Logger. Thats it.
Right now, this is a fairly small list, however there are a few log formats that I'd like to add. Checkout the Future Additions Section below.
Github-flavored Markdown to write your content.
Formats Included:
- BunyanFormat (https://github.com/trentm/node-bunyan)
{
"time": "2021-02-04T23:01:00.781Z",
"name": "root",
"pid": 15504,
"level": 40,
"msg": "TEST",
"hostname": "Sophie",
"v": 0
}
- JSONFormat
{
"logger": "root",
"timestamp": "2021-02-04T23:01:46.435011",
"message": "TEST",
"level": "ERROR",
"levelno": 40,
"function": "<module>",
"process": {
"number": 13316,
"name": "MainProcess"
},
"thread": {
"number": 10704,
"name": "MainThread"
},
"v": 1
}
- AdvJSONFormat (For Verbose JSON Logging)
{
"logger": "root",
"timestamp": "2021-02-04T23:02:52.522958",
"rtimestamp": "2021-02-04T23:02:37.518800",
"message": "TEST",
"level": "ERROR",
"levelno": 40,
"location": {
"pathname": "<FULL_PATH>\\test_logger.py",
"module": "test_logger",
"filename": "test_logger.py",
"function": "<module>",
"line": 16
},
"process": {
"number": 2300,
"name": "MainProcess"
},
"thread": {
"number": 12516,
"name": "MainThread"
},
"v": 1
}
Installation
Install via pip
python3 -m pip install pylogformats
Usage
Use the formatter as you would any other Python Formatter:
import pylogformats
import logging
import sys
logger = logging.getLogger()
logHandler = logging.StreamHandler(sys.stdout)
formatter = pylogformats.JSONFormat()
logHandler.setFormatter(formatter)
logger.addHandler(logHandler)
logger.setLevel(logging.DEBUG)
You can also use dictConfig
:
LOG_CONFIG = {
'formatters': {
'jsonformatter': {
'()' : 'pylogformats.JSONFormat'
}
},
'handlers': {
'debug': {
'class': 'logging.StreamHandler',
'formatter': 'jsonformatter',
'stream': 'ext://sys.stdout'
},
},
'root': {
'level': 'DEBUG',
'handlers': ['debug']
},
'version': 1
}
import logging.config
logging.config.dictConfig(LOG_CONFIG)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pyLogFormats-0.2.0.tar.gz
(10.8 kB
view hashes)
Built Distribution
Close
Hashes for pyLogFormats-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f208fff8c36a72fb560b65c6cb5db02d5139f1979ff99e367f238143707baf3 |
|
MD5 | 21370e201bdc9d20edb7aec59ab2de9b |
|
BLAKE2b-256 | dc1f923a110abd1358247cd9fcb0880bd331b1076d6421c573626cb2cefaf172 |