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

Python如何实现自定义日志格式_继承logging.Formatter并捕获异常字段

秋瑶姑娘_4394

秋瑶姑娘_4394

发布时间:2026-06-22 13:18:48

|

935人浏览过

|

来源于php中文网

原创

直接继承 logging.Formatter 无法拿到异常信息,因为 record.exc_text 默认为 None,需在 format() 中显式调用 self.formatException(record) 才生成;自定义 Formatter 应判断 record.exc_info 是否存在,手动格式化并注入,避免依赖 %(exc_text)s 占位符。

python如何实现自定义日志格式_继承logging.formatter并捕获异常字段

为什么直接继承 logging.Formatter 无法拿到异常信息

因为默认情况下,Formatter.format() 接收到的 record 对象在没有触发 record.exc_info 时,record.exc_text 是 None,且 record.stack_info 也不会自动填充。即使你写了 logger.error("msg", exc_info=True),异常文本也只在调用 format() 前由 Formatter 内部的 formatException() 处理并写入 record.exc_text —— 但这个过程发生在你自定义的 format() 执行之后。所以如果你没显式调用 self.formatException(record),就看不到异常堆栈。

如何在自定义 Formatter 中安全捕获并格式化异常字段

必须重写 format(),并在其中判断 record.exc_info 是否存在;若存在,手动调用 self.formatException(record) 获取字符串,再注入到你想放的位置(比如追加到消息末尾,或塞进 JSON 字段)。注意:不要直接拼接 record.exc_text,因为它可能为空或未生成。

  • record.exc_info 是三元组 (type, value, traceback),非空即表示有异常待格式化
  • 调用 self.formatException(record) 才会真正生成人类可读的堆栈字符串
  • 如果用了 %(exc_text)s 占位符但没提前生成 exc_text,该位置会显示为空字符串
  • 若想把异常作为结构化字段(如 JSON 日志),建议单独提取为 record.exc_formatted,再在 format() 中使用

一个能同时输出行号、函数名、异常详情的实战 Formatter 示例

import logging
import traceback
<p>class RichFormatter(logging.Formatter):
def format(self, record):</p><h1>确保异常文本已生成</h1><pre class="brush:php;toolbar:false;">    if record.exc_info:
        record.exc_formatted = self.formatException(record)
    else:
        record.exc_formatted = ""
    # 补充缺失字段(避免 %()s 引发 KeyError)
    if not hasattr(record, 'func_name'):
        record.func_name = record.funcName
    return super().format(record)

使用方式

handler = logging.StreamHandler() formatter = RichFormatter( fmt="%(asctime)s | %(levelname)-8s | %(name)s | %(func_name)s:%(lineno)d | %(message)s%(exc_formatted)s", datefmt="%Y-%m-%d %H:%M:%S" ) handler.setFormatter(formatter) logger = logging.getLogger("demo") logger.addHandler(handler) logger.setLevel(logging.DEBUG)

测试

try: 1 / 0 except Exception: logger.error("出错了", exc_info=True)

这段代码的关键在于:不依赖 %(exc_text)s 自动展开,而是主动控制 exc_formatted 的生成时机和内容;同时兼容无异常场景(避免 AttributeError)。

temporal-python-testing
temporal-python-testing

使用 pytest、时间跳转和模拟策略测试 Temporal 工作流。涵盖单元测试、集成测试、回放测试以及本地开发服务器。

下载

JSON 日志中嵌入异常字段的注意事项

如果用 python-json-logger 或手写 json.dumps() 输出,别把 record.exc_text 直接当字段值——它含换行符和缩进,JSON 会解析失败。应该先用 traceback.format_exception(*record.exc_info) 得到列表,再 "\n".join() 或转成单行(用 repr() 包裹)。

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

  • 推荐做法:在 format() 中预处理异常为单行字符串,例如 repr("".join(traceback.format_exception(*record.exc_info)))
  • 避免在 extra 参数里传异常对象,Logger.log() 不会序列化它
  • 如果用了 concurrent.futures 或异步任务,exc_info 可能在主线程丢失,需显式捕获后传入 logger.error(..., exc_info=sys.exc_info())

异常字段不是“开了 exc_info=True 就自动好使”的黑盒,它依赖 formatter 主动触发和清理。最常被忽略的是:没检查 record.exc_info 就直接访问 record.exc_text,结果日志里异常位置永远是空的。

热门AI工具

更多
Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

豆包大模型

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

DeepSeek

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

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

Lovart
Lovart Hot

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

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

WorkBuddy

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

相关专题

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

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

1711

2023.07.20

python能做什么
python能做什么

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

4324

2023.07.25

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

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

1689

2023.07.31

python教程
python教程

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

25217

2023.08.03

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

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

3067

2023.08.04

python eval
python eval

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

3087

2023.08.04

scratch和python区别
scratch和python区别

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

1163

2023.08.11

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

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

596

2023.08.10

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

40

2026.10.10

热门下载

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

精品课程

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

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