关键业务路径日志需精准、可追溯、低侵入,聚焦用户核心体验与资金/数据安全环节,如登录、支付、订单、退款等,通过结构化日志+trace_id串联请求,分入口、决策、异常三层记录,并脱敏敏感信息、JSON格式输出。

Python 如何记录关键业务路径日志  第1张

在关键业务路径中记录日志,核心是“精准、可追溯、低侵入”,而不是无差别打满日志。重点不是记多少,而是记对地方、带关键上下文、能快速定位问题。

明确哪些路径算“关键业务路径”

通常指直接影响用户核心体验或资金/数据安全的环节,例如:

  • 用户登录、支付下单、订单创建、退款审核
  • 库存扣减、消息推送触发、定时任务主逻辑入口
  • 调用外部支付网关、风控服务、短信平台等出站请求

这些节点一旦出错,必须能立刻知道“谁、什么时候、传了什么、返回了什么、耗时多少”。

用结构化日志 + 关键字段打点

避免用 logger.info("下单成功") 这类模糊语句。推荐用字典形式记录结构化日志,方便后续检索和聚合分析:

logger.info("order_created", extra={
    "order_id": order.id,
    "user_id": user.id,
    "amount": order.amount,
    "items_count": len(order.items),
    "elapsed_ms": int((end_time - start_time) * 1000),
    "trace_id": getattr(request, "trace_id", "N/A")
})

其中 trace_id 是关键——它串联一次请求的所有日志(建议集成 OpenTelemetry 或简单用 uuid4() 生成并透传)。

分层记录:入口、关键决策点、出错兜底

不要只在函数开头和结尾打日志,而要覆盖三个层次:

  • 入口层:记录原始输入(脱敏后)、身份信息(如 user_id、app_id)、请求来源
  • 决策层:比如“库存不足跳过扣减”、“风控拦截返回拒绝”,这类分支逻辑必须显式记录原因和结果
  • 异常层:所有 except 块里,用 logger.exception 记录完整 traceback,并附带当前上下文(如订单号、参数快照)

配置与输出要适配生产环境

本地开发可以打印到控制台,但上线必须满足:

  • 日志级别设为 INFO 或更高(避免 DEBUG 污染)
  • 输出格式为 JSON(便于 ELK / Loki 解析),每行一条
  • 敏感字段(手机号、身份证、银行卡号)在写入前自动脱敏(可用正则或专用库如 logurufilter
  • 避免在循环体或高频路径中记录日志(可加采样,如每 100 次记 1 条)

示例 Loguru 配置片段:

from loguru import logger
import json

logger.remove() logger.add( "app.log", format=lambda record: json.dumps({ "time": record["time"].isoformat(), "level": record["level"].name, "message": record["message"], "extra": record["extra"] }) + "\n", level="INFO", rotation="100 MB" )

不复杂但容易忽略:日志不是越多越好,而是要在故障发生时,用最少的日志行还原出关键事实链。