Python JSON Logger 技术文档

1. 安装指南

通过Pip安装

pip install python-json-logger

通过PyPI安装

访问 PyPI 下载对应的安装包，然后进行安装。

手动安装

python setup.py install

2. 项目的使用说明

本项目提供了一个可以将标准Python日志输出为JSON对象的库，这样可以使日志更易于被机器阅读，并且不需要编写自定义的解析器来处理日志。

集成Python的日志框架

import logging
from pythonjsonlogger import jsonlogger

logger = logging.getLogger()

logHandler = logging.StreamHandler()
formatter = jsonlogger.JsonFormatter()
logHandler.setFormatter(formatter)
logger.addHandler(logHandler)

自定义字段

可以通过覆盖 JsonFormatter 的 fmt 解析器来定义所需的字段。

class CustomJsonFormatter(jsonlogger.JsonFormatter):
    def parse(self):
        return self._fmt.split(';')

formatter = CustomJsonFormatter('one;two')

添加额外的字段

可以在日志记录中添加额外的字段，这些字段将添加到日志条目的根级别。

formatter = jsonlogger.JsonFormatter('%(message)s', extra={'user': 'admin'})
logger.info("This is a log message", extra={'user': 'admin'})

自定义对象序列化

可以指定默认的JSON对象翻译器或提供自定义的编码器。

def json_translate(obj):
    if isinstance(obj, MyClass):
        return {"special": obj.special}

formatter = jsonlogger.JsonFormatter(json_default=json_translate,
                                     json_encoder=json.JSONEncoder)
logHandler.setFormatter(formatter)

使用配置文件

可以使用配置文件来配置日志，配置文件中指定 JsonFormatter。

[loggers]
keys = root,custom

[logger_root]
handlers =

[logger_custom]
level = INFO
handlers = custom
qualname = custom

[handlers]
keys = custom

[handler_custom]
class = StreamHandler
level = INFO
formatter = json
args = (sys.stdout,)

[formatters]
keys = json

[formatter_json]
format = %(message)s
class = pythonjsonlogger.jsonlogger.JsonFormatter

3. 项目API使用文档

具体API使用文档请参考项目在 PyPI 的官方文档。

4. 项目安装方式

请参照上述“安装指南”部分进行安装。