使用 logging 模块配合自定义 formatter 可构建规范、可复用、易维护的日志模板,核心是结构化、语义化日志字段并解耦 logger/handler;需包含可读时间戳、环境标识、并发上下文、结构化锚点;模板应通过 formatter 初始化而非字符串拼接,支持多 handler 输出及 json 结构化。

直接用 Python 的 logging 模块配合自定义 Formatter,就能构建出规范、可复用、易维护的系统日志变量模板。关键不是拼字符串,而是把日志字段结构化、语义化,并与 Logger/Handler 解耦。
明确日志模板需要承载的核心信息
一个生产可用的日志模板不能只写“时间+消息”,要包含可追溯、可筛选、可聚合的关键上下文:
-
可读时间戳:用
%(asctime)s,配合datefmt统一为%Y-%m-%d %H:%M:%S.%f(毫秒级,避免同秒日志顺序混乱) -
执行环境标识:
%(name)s(服务名)、%(module)s(模块)、%(funcName)s(函数)、%(lineno)d(行号) -
并发上下文:
%(threadName)s(线程名)、%(process)d(进程 ID),尤其在多线程/异步场景中不可少 -
结构化锚点:固定字段如
%(levelname)s和%(message)s,便于后续用正则或 JSON 解析器提取
用 Formatter 定义可复用的模板字符串
模板不是硬编码在 print() 或 f-string 里,而是作为 Formatter 的初始化参数——这样一套模板可被多个 Handler 复用:
'%(asctime)s | %(levelname)-8s | %(name)-12s | %(threadName)-12s | %(module)s.%(funcName)s:%(lineno)d | %(message)s'
说明:
- %(levelname)-8s 左对齐、占 8 字符,让 INFO / ERROR 对齐,提升控制台可读性
- %(name)-12s 固定宽度,服务名如 auth、order 清晰分隔
- 模块+函数+行号连写成 auth.py.login:42,一键跳转源码
结合 Handler 实现多目标、多格式输出
同一套模板可同时用于控制台(开发调试)和文件(生产归档),只需绑定不同 Handler:
- 控制台输出:用
StreamHandler,启用颜色(借助第三方如colorama或自定义 Formatter 子类) - 文件输出:用
RotatingFileHandler,自动按大小轮转,避免单文件爆炸 - 结构化输出:将
format改为 JSON 字段格式(如%(asctime)s %(levelname)s %(name)s %(message)s),再由python-json-logger封装为标准 JSON 行,直通 ELK
避免常见陷阱:模板 ≠ 字符串拼接
不要在业务代码里用 f-string 或 % 拼日志内容,否则会丢失结构化能力:
- ❌ 错误:
logger.info(f"用户{uid}登录失败,IP:{ip},耗时{duration}s") - ✅ 正确:
logger.info("用户登录失败", extra={"uid": uid, "ip": ip, "duration": duration}),再在 Formatter 中通过%(uid)s等自定义字段渲染(需继承 Formatter 并重写format方法) - 更推荐:用字典传参 + JSON 日志,天然支持字段提取与过滤











