当前位置:首页 > 文章列表 > 文章 > python教程 > {"title":"logging结构化输出JSON设置方法"}

{"title":"logging结构化输出JSON设置方法"}

2026-03-18 16:48:35 0浏览 收藏
Python 的 logging 模块默认不支持结构化 JSON 日志输出,因其内置 Formatter 仅生成不可控的字符串,要实现可靠、可解析、可扩展的 JSON 日志,必须自定义 Formatter 子类——精准过滤不可序列化字段(如 exc_info、threading.Lock)、规范处理异常堆栈、统一时间格式,并通过 LoggerAdapter 或 Filter 安全注入 trace_id 等上下文字段;同时需规避多进程写入错乱、单文件多行 JSON 解析失败、序列化性能瓶颈等生产级陷阱,真正让日志既“机器友好”又“运维可靠”。

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

理论要掌握,实操不能落!以上关于《{"title":"logging结构化输出JSON设置方法"}》的详细介绍,大家都掌握了吧!如果想要继续提升自己的能力,那么就来关注golang学习网公众号吧!

Golang日志与性能配置全攻略Golang日志与性能配置全攻略
上一篇
Golang日志与性能配置全攻略
Go 中处理 TCP 流式变长命令消息技巧
下一篇
Go 中处理 TCP 流式变长命令消息技巧
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • ljg-skills -
    ljg-skills
    ljg-skills 是李继刚开源的 AI 技能与提示词集合,面向大模型使用者整理了一批可复用的 prompt、角色设定和任务技能模板,适合用于学习提示词设计、搭建个人 AI 工作流和沉淀团队常用智能体能力。
    1354次使用
  • MELO音乐 - AI 音乐生成平台,支持多模态创作能力
    MELO音乐
    MELO音乐是一站式AI视频与音乐制作助手,对标suno, udio的高品质体验。提供伴奏生成、原创写词、无损导出、哼唱识曲、混音变声等全套音频与短视频编辑工具。无论是流行Kpop、电音说唱、民谣古风、摇滚儿歌还是商用轻音乐,MELO为你免费谱曲,轻松做同款!
    1292次使用
  • UniScribe - AI 免费在线音视频转文字平台
    UniScribe
    UniScribe 是一款 AI 音视频转文字与内容整理工具,支持上传音频、视频文件或粘贴 YouTube 链接,自动生成转写文本、摘要、思维导图和关键问题,并支持多格式导出,适合会议记录、课程学习、访谈整理和内容创作复盘。
    1237次使用
  • 剧云 - 免费 AI 智能中文剧本创作平台
    剧云
    剧云是专业中文剧本创作平台,安全稳定运行十余年,集成AI编剧、剧本医生审核、人物小传、剧情关系图、大纲编写、多人协作、Word导入导出、版权管控功能,数据安全防护,轻松高效创作剧本。
    1414次使用
  • 万象有声 - AI 一站式有声内容创作平台
    万象有声
    万象有声,一个专为有声创作者打造的新一代智能有声内容创作平台。平台提供专业的智能拆章、智能画本编辑、AI配音、AI生成音效、后期制作、智能对轨、智能审听等有声创作全流程工具,可以帮助创作者高效、低成本创作出引人入胜的有声作品。立即体验,让有声书制作更简单!
    1415次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码