讲师中心 微信公众号
AI工具推荐 视频效率加速

Python structured logging 的 JSON 格式约定

千明酱_4080

千明酱_4080

发布时间:2026-02-16 15:32:03

|

852人浏览过

|

来源于php中文网

原创

Python结构化JSON日志需自定义Formatter或用python-json-logger,字段名小写加下划线,显式传exc_info=True,时间用ISO 8601,extra键禁用点号,异常和上下文必须完整捕获,字符串需转义防解析失败。

python structured logging 的 json 格式约定

Python structured logging 输出 JSON 的核心约束

logging 本身不生成 JSON,必须靠自定义 Formatter 或第三方库(如 python-json-logger)把日志字段序列化。直接用 json.dumps() 拼字符串容易漏掉异常堆栈、丢失上下文字段,或在多线程下破坏日志结构。

  • 日志记录必须走 logger.info() 等标准方法,不能手动 print JSON 字符串
  • 所有字段名应小写、下划线分隔(如 service_name、trace_id),避免大小写混用导致下游解析失败
  • exc_info=True 必须显式传入,否则 json.dumps() 无法自动捕获异常对象,只会输出空 "exc_info": null
  • 时间字段建议统一用 ISO 8601 格式(datetime.now().isoformat()),不要依赖 %(asctime)s,它默认是字符串且格式不可控
import json
import logging
from datetime import datetime
<p>class JsonFormatter(logging.Formatter):
def format(self, record):
log_entry = {
"timestamp": datetime.fromtimestamp(record.created).isoformat(),
"level": record.levelname,
"message": record.getMessage(),
"logger": record.name,
"module": record.module,
"function": record.funcName,
"line": record.lineno,
}
if record.exc_info:
log_entry["exception"] = self.formatException(record.exc_info)
return json.dumps(log_entry)</p>

python-json-logger 库的字段映射陷阱

python-json-logger 默认只输出基础字段,比如 levelname、message,但不会自动带 exc_info 或 stack_info。更隐蔽的问题是:它把 extra 字典里的键原样塞进 JSON,但如果键名含点号(如 "request.id"),某些日志平台(如 Datadog、Loki)会把它当嵌套对象解析,实际却只是字符串字段。

  • 使用 extra 传参时,键名只能用字母、数字、下划线,禁用点、连字符、斜杠
  • 若需嵌套结构(如 {"request": {"id": "abc", "path": "/api"}} ),必须提前构造好字典再传给 logger.info("msg", extra={"request": req_dict}),不能指望库自动展开
  • JsonFormatter 初始化时传 reserved_attrs 可覆盖默认保留字段,但别删掉 exc_info,否则异常日志永远不完整
  • 不要重命名 levelname 为 level 后就以为符合 OpenTelemetry 规范——OTel 要求的是 severity_text 和 severity_number,得额外加字段

LogRecord extra 字段的生命周期问题

logger.info("msg", extra={"user_id": 123}) 看似简单,但 extra 字典只作用于当前日志条目。如果想让所有日志都带 service_name,不能靠反复传 extra,而要用 LoggerAdapter 或 Filter 注入。

Python Pep Authoring
Python Pep Authoring

依据官方 python/peps仓库规则起草、审阅、编辑或准备 Python 改进提案(PEP),用于处理 PEP 文本和元数据头部。

下载
  • LoggerAdapter 是最轻量的方式,但它的 process() 方法里修改 extra 时,不能覆盖原有键(比如 extra["message"]),否则会丢原始消息
  • Filter 更底层,适合动态注入(如从 thread-local 获取 trace_id),但要注意它在 LogRecord 创建后才运行,此时 exc_info 已固化,无法补异常信息
  • 如果用了 structlog,它和 logging 的 extra 不兼容,混用会导致字段丢失或重复,选一个体系到底

JSON 日志在生产环境的性能与兼容性雷区

纯文本日志可直接 tail -f 查看,JSON 日志一旦格式出错(比如字段值含未转义换行符),整个日志行就解析失败,Kibana 或 Loki 会显示为空或截断。更麻烦的是,有些云厂商的日志代理(如 AWS CloudWatch Logs Agent)对单行 JSON 长度有限制(默认 256KB),超长日志会被静默截断。

立即学习“Python免费学习笔记(深入)”;

  • 所有字符串字段在写入前应做基本清洗:value.replace("\n", "\n").replace("\r", "\r"),尤其 message 和 exception
  • 不要在日志里 dump 整个 request body 或数据库 record,用摘要代替(如 "body_size": len(body))
  • 测试阶段务必用 json.loads() 对每条日志反序列化验证,不能只靠肉眼扫一眼是否“看起来像 JSON”
  • 如果用 RotatingFileHandler,注意 JSON 行日志不能跨行,必须确保 maxBytes 不会把一条 JSON 切成两半,否则后续解析全崩

字段命名一致性、异常处理完整性、extra 注入时机、JSON 安全转义——这四点没对齐,日志看着是 JSON,其实下游系统根本没法可靠消费。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2255

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

3642

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

1216

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

4199

2025.09.10

python中print函数的用法
python中print函数的用法

python中print函数的语法是“print(value1, value2, ..., sep=' ', end=' ', file=sys.stdout, flush=False)”。本专题为大家提供print相关的文章、下载、课程内容,供大家免费下载体验。

3260

2023.09.27

python print用法与作用
python print用法与作用

本专题整合了python print的用法、作用、函数功能相关内容,阅读专题下面的文章了解更多详细教程。

269

2026.02.03

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

549

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

1698

2024.03.01

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

0

2026.11.05

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn