跳到主要内容
佳益手记

企业博客

技术专栏 · 发布 2026年3月3日

日志规范:三个月后还能看懂

日志写给未来的同事看,也写给凌晨三点的自己看。结构化是底线。

排查线上问题时,最难处理的不是没有日志,而是日志看不懂:只有一句“处理失败”,没有请求号,没有参数,也没有上下文。我们因此定了一份简单的日志规范。

四条约定

每条日志包含时间、级别、模块、请求号和关键参数,用统一字段格式输出。

错误日志必须带堆栈和可定位的业务标识,比如订单号或客户编号,而不是内部自增主键。

不要在循环里打大量日志,用汇总替代,避免把磁盘写满。

敏感信息脱敏:手机号、身份证号、支付信息一律不落明文。

分级要克制

INFO 用于关键业务节点,WARN 用于可恢复的异常,ERROR 用于需要人介入的问题。

如果 ERROR 每天出现上百条,说明分级失效了,团队会对告警麻木。

上线前检查一遍日志输出,确保关键路径都有记录,而不是靠事后再加。

好的日志让排查从几小时缩短到几分钟。它是最便宜的可观测性投入。

返回博客列表

想把文章里的方法用到您的项目里?

我们乐于分享更多实施细节,也欢迎您带着具体问题与我们交流。

开始一次对话 →
— 编辑部 · 佳益方圆EST. 2019 · JYFY