如何在 Loguru 中自定义日志结构并输出精简 JSON 格式

酷晨姑娘_3023

酷晨姑娘_3023

2026-07-30

180人浏览

原创

如何在 Loguru 中自定义日志结构并输出精简 JSON 格式

本文详解如何绕过 Loguru 默认的冗余 JSON 序列化逻辑,通过自定义 serialize 处理器与 format 字符串,实现完全可控的轻量级 JSON 日志输出(如仅保留 time 和 error 字段),适配 FastAPI 等生产环境。

本文详解如何绕过 loguru 默认的冗余 json 序列化逻辑,通过自定义 `serialize` 处理器与 `format` 字符串,实现完全可控的轻量级 json 日志输出(如仅保留 `time` 和 `error` 字段),适配 fastapi 等生产环境。

Loguru 默认的 JSON 序列化(如 _serialize_record)会嵌套大量字段(process、thread、file、extra 等),而实际业务中常需极简结构——例如仅输出 {"time": "5:30pm", "error": "Type error"}。关键在于:不能修改内部私有方法,而应通过 add() 的 serialize + format 组合实现完全定制。

✅ 正确做法:使用 serialize=True + 自定义 format + 手动序列化

Loguru 提供了 serialize=True 参数,它会将 record 交由你控制的 format 字符串处理;此时 format 不再是纯字符串模板,而是可执行的函数(返回字符串),我们可在其中构造任意 JSON 结构:

Aria2 Json Rpc
Aria2 Json Rpc

通过 JSON‑RPC 2.0 与 aria2 下载管理器交互,使用自然语言命令管理下载、查询状态并控制任务。适用于 aria2、下载管理或种子操作。

下载
import json
from datetime import datetime
from loguru import logger

def custom_json_format(record):
    # 提取并格式化时间(如 "5:30pm")
    time_obj = record["time"]
    formatted_time = time_obj.strftime("%I:%M%p").lower()  # → "5:30pm"

    # 提取错误信息(仅当存在异常时)
    error_msg = ""
    if record["exception"]:
        exc = record["exception"]
        error_msg = f"{exc.type.__name__}: {exc.value}"

    # 构建最小化 JSON 对象
    data = {
        "time": formatted_time,
        "error": error_msg or record["message"],
    }
    return json.dumps(data, ensure_ascii=False) + "\n"

# 移除默认处理器,添加自定义 JSON 输出
logger.remove()
logger.add(
    "app.log",
    format=custom_json_format,  # ← 关键:传入函数而非字符串
    serialize=True,             # ← 启用 record 传递模式
    level="INFO",
    rotation="10 MB"
)

# 测试
logger.info("正常日志")
logger.error("发生类型错误")  # 无异常堆栈时
try:
    1 / 0
except Exception:
    logger.exception("捕获到异常")  # 此时 error 字段含异常类型+消息

⚠️ 注意事项与最佳实践

  • serialize=True 是开关:它让 Loguru 将 record 作为参数传给 format 函数,否则 format 仅支持 {time} {message} 等占位符,无法访问原始异常对象。
  • 避免重写 _serialize_record:该方法为私有静态方法,非公开 API,强行 monkey patch 易导致版本升级后崩溃。
  • FastAPI 集成建议:在应用启动时配置 logger(如 main.py 中 configure_logger()),并通过 logger.bind(request_id=...).info(...) 添加上下文字段,并在 custom_json_format 中从 record["extra"] 提取。
  • 性能提示:若高频日志,可预编译 json.dumps 或使用 orjson 替代标准库以提升序列化速度。

✅ 总结

Loguru 的灵活性在于“解耦格式化与序列化”:format 控制内容结构,serialize=True 提供数据源,json.dumps 执行最终输出。无需侵入源码,即可精准输出符合 SRE 规范或 ELK 入口要求的扁平化 JSON 日志——这才是生产级日志定制的正确路径。

相关专题

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

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

2023.07.20

1631

4

python能做什么
python能做什么

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

2023.07.25

3984

7

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

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

2023.07.31

1629

3

python教程
python教程

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

2023.08.03

22937

23

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

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

2023.08.04

2807

5

python eval
python eval

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

2023.08.04

2847

5

scratch和python区别
scratch和python区别

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

2023.08.11

1123

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2223

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 20.7万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.7万人学习