Python 日志规范在团队中的落地方法

1次阅读

日志级别选择需严格匹配场景:debug仅开发测试用且上线必关;info是唯一长期开启级别,记录业务动作;warning表潜在问题但未崩溃;Error必须带exc_info=true;格式化须用懒求值参数传递而非拼接或f-String

Python 日志规范在团队中的落地方法

日志级别怎么选才不被同事喷

团队里最常吵的不是用不用 Logging,而是谁把 logging.debug() 提到生产环境、谁又把 logging.error()print() 乱打。关键不是“能不能用”,而是“在哪用、为什么用这个级别”。

  • DEBUG 只在开发/测试环境有效,上线前必须关掉(靠 logging.basicConfig(level=...) 或配置文件控制),否则磁盘爆得比日志内容还快
  • INFO 是唯一该长期开启的级别,只记录“业务发生了什么”——比如 "user_id=123 logged in",不记录变量快照、不打印
  • WARNING 不代表“问题不大”,而是“可能出错但没崩”,比如第三方 API 返回非预期状态码但兜底逻辑已生效
  • ERROR 必须带异常上下文:logger.error("failed to send email", exc_info=True),否则查问题时只剩一句“失败了”

格式化字符串别用 % 或 .format() 打日志

看似只是写法偏好,实则影响性能和可读性:字符串拼接会在日志未启用时也执行,而 logging 的懒求值机制只在真正输出时才解析参数。

  • 错:logger.info("user %s paid %d" % (user.name, amount)) —— 拼接提前发生,哪怕日志级别是 WARNING
  • 对:logger.info("user %s paid %d", user.name, amount) —— 参数延迟传入,不触发计算
  • python 3.7+ 可用 f-string?不行。f-string 总是立即求值,f"user {user.name} paid {amount}"% 一样危险

多模块共享 logger 时别用 getLogger(__name__) 就完事

看似标准写法,但实际团队协作中容易导致日志归属混乱、配置失效或重复输出。

  • 每个模块用 getLogger(__name__) 没问题,但必须确保根 logger(getLogger())已配置 handler,否则日志静默消失
  • 避免在模块里调 basicConfig() —— 它只生效一次,后加载的模块会覆盖前者的配置
  • 推荐统一入口初始化:在 main.pyapp/__init__.py 里调 logging.config.dictConfig(...),用 YAML/json 配置所有 handler、Filter、formatter
  • 如果要用 JSON 配置,注意 class 字段必须是完整路径,比如 "class": "logging.handlers.RotatingFileHandler",少个点就报 ValueError: Unable to configure handler 'file'

结构化日志字段不能靠手拼 JSON

想加 trace_iduser_id 这类字段?别在每条 logger.info() 里手动塞字典,一来易漏,二来破坏日志解析一致性。

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

  • LoggerAdapter 注入上下文:adapter = LoggerAdapter(logger, {"trace_id": "abc123"}),之后 adapter.info("order created") 自动带上字段
  • 若用 structlog,务必禁用默认的 stdlib.BoundLogger 包装器,否则和原生 logging 配置冲突,出现双时间戳、双 level 字段
  • 字段名统一用小写+下划线(request_id 而非 requestId),避免不同服务解析规则打架
  • 敏感字段如 passwordToken 必须在 formatter 层过滤,不能依赖“大家自觉不打”

事情说清了就结束。真正难的不是写几行配置,是让所有人改掉 print() 习惯、接受日志要像接口一样约定字段含义、以及接受 ERROR 级别日志必须能直接触发告警而不是等人翻文件。

text=ZqhQzanResources