0

0

logging 如何实现结构化日志输出(JSON formatter)

舞夢輝影

舞夢輝影

发布时间:2026-01-25 20:16:03

|

426人浏览过

|

来源于php中文网

原创

默认 logging 不能直接输出 JSON,因其 Formatter 将日志拼为字符串且字段不可控;需自定义 Formatter 子类重写 format(),过滤不可序列化字段、处理异常堆栈、用 json.dumps() 输出合法 JSON,并通过 LoggerAdapter 或 Filter 注入 trace_id 等上下文字段。

logging 如何实现结构化日志输出(json formatter)

为什么默认的 logging 不能直接输出 JSON

Python 标准库logging 默认使用 Formatter,它把日志拼成字符串,字段顺序、类型、嵌套结构都不可控。想让日志变成 JSON,关键不是“加个参数”,而是替换掉格式化逻辑——必须自定义一个继承自 logging.Formatter 的类,重写 format() 方法,让它返回合法 JSON 字符串。

如何写一个可靠的 JSON Formatter

核心是:在 format() 中提取 record.__dict__,剔除不可序列化的字段(比如 exc_infostack_info),再把异常和堆转成字符串后塞进新字典,最后用 json.dumps() 输出。常见错误是直接 dump 整个 record.__dict__,结果遇到 threading.Lock 或函数对象就报 TypeError: Object of type Lock is not JSON serializable

  • 必须过滤掉 exc_infostack_infomsg(原始格式化字符串)、args(未格式化的元组)这些非基础类型字段
  • self.formatException(record)self.formatStack(record) 获取可序列化的异常/堆栈字符串
  • 推荐设置 ensure_ascii=Falseseparators=(',', ':') 减少体积
  • 时间字段建议用 record.createddatetime.fromtimestamp(record.created),别依赖 record.asctime(那是字符串,且格式不统一)

如何让 JSON 日志包含 trace_id 或 request_id

结构化日志的价值在于关联请求链路,但 logging.Record 默认不带上下文字段。不能靠全局变量或线程局部存储硬塞——并发下会错乱。正确做法是用 LoggerAdapterFilter 动态注入字段。

易可图
易可图

电商人都在用的设计平台

下载
  • LoggerAdapter 最简单:初始化时传入 extra={'trace_id': 'xxx'},之后所有 logger.info() 调用都会自动带上该字段
  • 如果需要动态值(比如从 Flask 请求中取 request.headers.get('X-Request-ID')),必须写自定义 Filter,在 filter(record) 里设置 record.trace_id = get_current_trace_id()
  • 注意:Filter 注入的字段名必须在 JSON Formatter 的 format() 中显式读取,否则不会出现在输出里

FileHandler + JSON Formatter 的实际坑点

本地开发时用 FileHandler 配 JSON Formatter 没问题,但上生产常被忽略三点:

  • 日志文件不能被多个进程同时写(比如 gunicorn 多 worker),否则 JSON 行会错乱——必须用 RotatingFileHandler + delay=True,或改用 QueueHandler + 单独写入进程
  • 每行一个 JSON 是业界共识(方便 Logstash、Fluentd 解析),所以不要用 indent=2,也别把多条日志 dump 到一个大 JSON 数组里
  • 如果日志量大,频繁调用 json.dumps() 有性能开销,可考虑用 ujson 替代标准库 json(需自行测兼容性)

JSON Formatter 不难写,难的是字段一致性、上下文注入时机、以及多进程下的输出可靠性——这三个地方出问题,日志就既不好查,也不好解析。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

774

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

684

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

767

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

719

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1425

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

571

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

579

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

751

2023.08.11

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

45

2026.01.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 20.4万人学习

Django 教程
Django 教程

共28课时 | 3.5万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号