如何在Python Flask中记录结构化JSON日志到文件

小浩酱_4809

小浩酱_4809

2026-11-17

251人浏览

原创

Flask默认日志不支持直接写JSON,需替换FileHandler为自定义handler或使用python-json-logger;须正确处理exc_info、上下文字段、日志轮转及UTF-8编码。

如何在python flask中记录结构化json日志到文件

Flask 默认日志不支持直接写 JSON,得自己封装 handler

Flask 的 app.logger 底层用的是 Python 标准 logging 模块,默认输出纯文本。想写结构化 JSON 到文件,不能只靠 Formatter 改格式——得替换掉默认的 FileHandler,换成能序列化字典的自定义 handler。

常见错误是只改 Formatter,比如继承 logging.Formatter 并在 format() 里 json.dumps(),这会导致日志字段丢失(如 exc_info、stack_info 不被自动提取),而且时间戳、行号等元信息容易错乱。

实操建议:

  • 继承 logging.FileHandler,重写 emit() 方法,在写入前把 record.__dict__ 转成字典并补全关键字段(asctime、levelname、message 等)
  • 用 logging.setLogRecordFactory() 注入一个工厂函数,确保所有 log record 都带 request_id、endpoint 等上下文字段(需配合 Flask 中间件)
  • 避免在 emit() 里做耗时操作(如每次调用都 datetime.now().isoformat()),优先复用 record.asctime

用 python-json-logger 是最省事的方案

python-json-logger 是专为这个场景设计的第三方包,它提供 JsonFormatter,能正确处理 exc_info、stack_info、extra 字段,并兼容标准 FileHandler。

安装和配置示例:

pip install python-json-logger

在 Flask 初始化后加:

import logging
from pythonjsonlogger import jsonlogger
<p>handler = logging.FileHandler("app.log")
formatter = jsonlogger.JsonFormatter(
"%(asctime)s %(name)s %(levelname)s %(message)s %(funcName)s %(lineno)d",
rename_fields={"asctime": "@timestamp", "levelname": "level"}
)
handler.setFormatter(formatter)</p><p>app.logger.addHandler(handler)
app.logger.setLevel(logging.INFO)</p>

注意点:

  • rename_fields 只影响顶层 key 名,不递归重命名嵌套结构(比如 exc_info 里的字段)
  • 如果用了 app.logger.info("msg", extra={"user_id": 123}),user_id 会平级出现在 JSON 顶层,无需额外处理
  • Windows 下文件路径含中文时,FileHandler 要显式传 encoding="utf-8",否则 JSON 中文会乱码

在请求生命周期中注入 request 相关字段

纯 JSON 日志没上下文价值很低。想让每条日志带 method、path、status_code、duration_ms,不能靠全局变量——要用 Flask 的 before_request / after_request + g 对象或 logging.LoggerAdapter。

Python 环境工具基础版
Python 环境工具基础版

管理 Python 项目环境,支持虚拟环境创建、依赖安装与环境诊断

下载

推荐用 LoggerAdapter 动态注入:

from flask import g, request, after_this_request
import time
<p>class RequestContextAdapter(logging.LoggerAdapter):
def process(self, msg, kwargs):
context = {
"method": getattr(g, "method", request.method),
"path": getattr(g, "path", request.path),
"request_id": getattr(g, "request_id", "unknown"),
}
kwargs["extra"] = {<strong>kwargs.get("extra", {}), </strong>context}
return msg, kwargs</p><p>app.logger = RequestContextAdapter(app.logger, {})  # 绑定到 app.logger</p><p>@app.before_request
def before_req():
g.start_time = time.time()</p><p>@app.after_request
def after_req(response):
duration = (time.time() - g.start_time) * 1000
app.logger.info(
"request completed",
extra={"status_code": response.status_code, "duration_ms": round(duration, 2)}
)
return response</p>

关键细节:

  • 别在 before_request 里直接往 app.logger 写日志——此时响应状态还没出来,status_code 不可知
  • after_this_request 比 after_request 更安全,它在 response 已生成但尚未发送时执行,适合记耗时
  • 如果用了 Gunicorn,要禁用其访问日志(--access-logfile "-" --error-logfile "-" ),否则重复记录

日志文件滚动和 Unicode 处理容易被忽略

生产环境必须轮转日志,否则单个文件无限增长。Python 标准 RotatingFileHandler 或 TimedRotatingFileHandler 都支持,但和 JSON 配合时有两个坑:

  • 轮转后新文件开头不是完整 JSON(没有 [),导致下游解析失败——JSON 日志本质是“每行一个 JSON 对象”(NDJSON),不是单个大 JSON 数组,所以轮转本身没问题,但别指望用 json.load() 读整个文件
  • TimedRotatingFileHandler 在 Windows 上按秒轮转可能失效(系统时钟精度问题),建议用 RotatingFileHandler + maxBytes 控制
  • 所有 handler 必须显式指定 encoding="utf-8",否则含中文的 JSON 写入后无法被 jq 或 Python json.loads() 正确解析

示例配置:

from logging.handlers import RotatingFileHandler
<p>handler = RotatingFileHandler(
"app.log",
maxBytes=10 <em> 1024 </em> 1024,  # 10MB
backupCount=5,
encoding="utf-8"
)</p>

真正难的是日志消费端——别指望用 tail -f 实时看 JSON 日志,得配 jq 或 ELK;如果只是调试,加个简易格式化中间件更实用:

@app.after_request
def pretty_json_log(response):
    if request.path.startswith("/api/") and response.is_json:
        try:
            app.logger.debug("response body", extra={"body": response.get_json()})
        except Exception:
            pass
    return response

这种写法会把响应体塞进日志,但要注意:大响应体(>1MB)会拖慢请求、撑爆磁盘,线上务必加大小限制和开关控制。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python js json flask

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1931

4

python能做什么
python能做什么

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

2023.07.25

5484

7

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

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

2023.07.31

1889

3

python教程
python教程

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

2023.08.03

33497

23

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

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

2023.08.04

3927

5

python eval
python eval

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

2023.08.04

3947

5

scratch和python区别
scratch和python区别

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

2023.08.11

1283

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

636

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

3063

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程