Python logging 配置为JSON格式

logging

字数统计: 458阅读时长: 2 min

 2021/06/25   Share

前言

将日志json化输出

基本信息

模块format显示消息的内置格式

如果需要更改消息显示格式, 需要指定format

import logging
logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG)
logging.debug('This message should appear on the console')
logging.info('So should this')
logging.warning('And this, too')

将输出

1
2
3

DEBUG:This message should appear on the console
INFO:So should this
WARNING:And this, too

可参考: LogRecord属性

配置JSON输出

安装 python-json-logger

配置JSON输出,我们需要安装第三方的包

1	pip install python-json-logger

Pypi
https://pypi.python.org/pypi/python-json-logger

创建配置文件

logging.conf

[loggers]
keys=root,jsonmodule

[handlers]
keys=consoleHandler,fileHandler

[formatters]
keys=simpleFormatter,json

[logger_root]
level=DEBUG
handlers=consoleHandler

[logger_jsonmodule]
level=DEBUG
handlers=fileHandler
qualname=jsonmodule

[handler_consoleHandler]
class=StreamHandler
level=DEBUG
formatter=simpleFormatter
args=(sys.stdout,)

[handler_fileHandler]
class=handlers.TimedRotatingFileHandler
level=INFO
formatter=json
args=("./app.log", 'd', 1, 15, 'utf-8')

[formatter_json]
class=pythonjsonlogger.jsonlogger.JsonFormatter
format=%(asctime)s %(threadName)s %(thread)d %(levelname)s %(lineno)d %(module)s %(funcName)s %(message)s

[formatter_simpleFormatter]
format=%(asctime)s %(funcName)s %(filename)s [line: %(lineno)d] %(levelname)s:%(message)s

默认前台输出,以及后台写文件. 日志文件已天分割, 并且保留15天.

使用

import logging.config

logging.config.fileConfig('logging.conf')
logger = logging.getLogger('jsonmodule')

logger.error('dawdwad')

输出

前台: 
2021-06-25 16:54:32,185 <module> logger.py [line: 7] ERROR:dawdwad

日志:
{"asctime": "2021-06-25 16:54:32,185", "threadName": "MainThread", "thread": 18348, "levelname": "ERROR", "lineno": 7, "module": "logger", "funcName": "<module>", "message": "dawdwad"}

配置默认自定义字段

You can also use the add_fields method to add to or generally normalize the set of default set of fields, it is called for every log event. For example, to unify default fields with those provided by structlog you could do something like this:

class CustomJsonFormatter(jsonlogger.JsonFormatter):
    def add_fields(self, log_record, record, message_dict):
        super(CustomJsonFormatter, self).add_fields(log_record, record, message_dict)
        if not log_record.get('timestamp'):
            # this doesn't use record.created, so it is slightly off
            now = datetime.utcnow().strftime('%Y-%m-%dT%H:%M:%S.%fZ')
            log_record['timestamp'] = now
        if log_record.get('level'):
            log_record['level'] = log_record['level'].upper()
        else:
            log_record['level'] = record.levelname

更改配置文件

1
2
3

[formatter_json]
class=log.formatter.CustomJsonFormatter
format=%(threadName)s %(thread)d  %(lineno)d %(module)s %(funcName)s %(message)s

参考

[1]logging模块基础教程

原文作者：Momo

原文链接：https://mo.xmomo521.top/2021/06/25/Python-logging-配置为JSON格式/

发表日期：June 25th 2021, 2:45:48 pm

更新日期：December 21st 2021, 3:32:58 pm

Next Post

制作一个通用的镜像构建流水线
Previous Post

Kubernetes 部署时提示 'Failed create pod sandbox'

CATALOG

1. 前言
2. 基本信息
1. 2.1. 模块format显示消息的内置格式
3. 配置JSON输出
1. 3.1. 安装 python-json-logger
2. 3.2. 创建配置文件
  1. 3.2.1. logging.conf
  2. 3.2.2. 使用
4. 配置默认自定义字段
1. 4.1. 更改配置文件
5. 参考

