python-json-logger 使用指南

python-json-logger 使用指南

python-json-loggerJson Formatter for the standard python logger项目地址:https://gitcode.com/gh_mirrors/py/python-json-logger

1. 项目目录结构及介绍

python-json-logger 是一个简单的Python库，用于将日志记录格式化为JSON，以便于在各种日志处理基础设施（如ELK、EFK、AWS CloudWatch、GCP Stackdriver等）中轻松检索和搜索。以下是项目的基础目录结构：

python-json-logger/
│
├── src/          # 主要代码源目录
│   └── pythonjsonlogger/
│       └── jsonlogger.py    # JSON日志格式化器的主要实现
│
├── tests/        # 测试用例目录
│   ├── __init__.py
│   └── tests.py      # 单元测试
│
├── README.md     # 项目说明文件
└── setup.py       # 安装脚本

• src/pythonjsonlogger/jsonlogger.py: 包含JsonFormatter类，这是主要的日志格式化器。
• tests/*: 测试代码，验证JsonFormatter的功能。
• README.md: 提供项目概述，安装和使用信息。
• setup.py: Python包的安装脚本，用于安装依赖并构建软件包。

2. 项目启动文件介绍

该项目不是一个独立运行的应用程序，而是一个库。因此没有传统的“启动文件”。要使用这个库，你需要在自己的Python应用中导入pythonjsonlogger.jsonlogger.JsonFormatter，然后配置你的日志处理器。

例如，你可以这样设置日志记录器：

import logging
from pythonjsonlogger import jsonlogger

logger = logging.getLogger(__name__)
log_handler = logging.StreamHandler()
formatter = jsonlogger.JsonFormatter()
log_handler.setFormatter(formatter)
logger.addHandler(log_handler)

# 然后可以使用logger记录日志
logger.info("This is a structured log entry")

3. 项目配置文件介绍

python-json-logger 不包含内置的配置文件支持，因为它是作为一个模块直接集成到你的应用程序中的。不过，你可以根据你的应用需求创建自定义的配置文件来控制日志级别、过滤器和其他高级特性。

例如，如果你正在使用configparser模块管理配置，你可以在config.ini文件中指定日志记录器的配置：

[loggers]
keys=root

[handlers]
keys=stream

[formatters]
keys=json

[handler_stream]
class=StreamHandler
args=(sys.stdout,)
level=DEBUG
formatter=json

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

接着，你的主程序可以读取这些配置并创建相应的日志设置：

import configparser
import logging.config
from pythonjsonlogger import jsonlogger

config = configparser.ConfigParser()
config.read('config.ini')
logging.config.dictConfig(config)

logger = logging.getLogger(__name__)

# 日志现在已经按配置进行初始化
logger.debug("Using config file settings")

请注意，自定义配置需要你自己实现，上述示例仅作为参考。实际的配置项可能根据你的应用程序需求有所不同。

python-json-loggerJson Formatter for the standard python logger项目地址:https://gitcode.com/gh_mirrors/py/python-json-logger