A JSON logger for map colonies project
Project description
json-logger
Dependencies
install python-json-logger
pip3 install python-json-logger
Usage Example
NOTICE: the example assumes that logger.py is in the same directory as your calling module, else a different import method should be used
import os, sys
from logger import JSONLogger
# logging config yaml file path
LOG_CONFIG_PATH = os.environ.get('LOG_CONFIG_PATH', 'log.yaml')
APP_NAME = 'my-service'
# there should be a formatter that uses these fields in configuration yaml (e.g. format: '%(timestamp)s %(service)s')
additional_constant_fields = {'service': APP_NAME}
# NOTICE: there should be a matching logger name in configuration yaml (e.g. main-debug)
log = JSONLogger('main-info', LOG_CONFIG_PATH, additional_constant_fields).get_logger()
log.critical('system crashed')
log.error('incorrect input')
log.warn('not ready')
log.info('some info', extra={'action_id': 3}) # extra fields
log.debug('some info', extra={'action_id': 4}) # will not be logged because logger level set to INFO ('main-info')
Example Configuration YAML
version: 1
formatters:
brief:
format: '%(message)s'
json:
format: '%(timestamp)s %(service)s %(loglevel)s %(message)s'
class: logger.CustomJsonFormatter
handlers:
console:
class: logging.StreamHandler
formatter: json
stream: ext://sys.stdout
file:
class : logging.handlers.RotatingFileHandler
formatter: json
filename: logfile.log # log files full path
maxBytes: 5242880 # 5 MB
backupCount: 10
loggers:
main-debug:
handlers: [console, file]
level: DEBUG
main-info:
handlers: [console, file]
level: INFO
main-warning:
handlers: [console, file]
level: WARNING
main-error:
handlers: [console, file]
level: ERROR
main-critical:
handlers: [console, file]
level: CRITICAL
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
Close
Hashes for MapColoniesJSONLogger-0.0.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 868047c96058f3ad15cf5a8b1ba24610f1033a8223cbfaa632a23b8c555892fa |
|
MD5 | db7be9853eac3cf213442abbbfc07cd0 |
|
BLAKE2b-256 | 359bdb9af02f56060fed5e4666a87ebd429dece95b41fa32e98358b1a79d9401 |
Close
Hashes for MapColoniesJSONLogger-0.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f0d9ba15f3926124aa0da3e4a4b406c5dc76f1d337e55f8b3600343344975a6 |
|
MD5 | da4a60207ad31d4f90333fe64756b3ad |
|
BLAKE2b-256 | 9a8c7df1b37840f0679bc97ddf59997c5a10192095da49f30e05c18b9240fcff |