日志该记什么:从一次线上排障反推日志规范
一、先想清楚「排障时需要什么」
一次典型的线上问题排查,顺序通常是:什么时候开始出错 → 影响了哪些请求 → 具体哪一步失败 → 为什么失败。日志要支撑的就是这四步,缺任何一环,排查就会退化成猜。
对应下来,每条日志至少要带:时间戳(精确到毫秒)、请求 ID、关键业务标识(用户/订单/任务 ID)、当前步骤、结果状态。
二、请求 ID 是收益最高的一行
没有请求 ID,跨服务排查基本靠时间戳对齐,多个请求并发时直接失效。做法很简单:入口生成一个 ID,写进 MDC 或上下文,沿途所有日志自动带上。
String traceId = UUID.randomUUID().toString().replace("-", "");
MDC.put("traceId", traceId);
try {
handle(request);
} finally {
MDC.clear();
}
这一行的成本几乎为零,却能把散落在五个服务里的日志串成一条时间线。
三、不要打印整个对象
log.info("request={}", JSON.toJSONString(req)) 是最常见也最危险的写法:体积大、可能带敏感信息、字段一多就没法检索。
更好的做法是显式挑字段:只打印参与判断的那几个值。既控制体积,也顺便说明这段逻辑关心什么。
四、异常日志要带上下文,不要只打堆栈
只有 e.printStackTrace() 的日志,在线上几乎没有价值——它告诉你哪里炸了,但不告诉你为什么。
正确写法是把「出错时的关键变量」一起打出来:
log.error("pay failed, orderId={}, amount={}, gatewayCode={}",
orderId, amount, code, e);
堆栈交给日志框架,人只需要读前半句就能定位。
五、分级要真的分级
把业务异常打成 ERROR,告警立刻爆炸;把真正的故障打成 WARN,故障就沉底了。判断标准:需要人立即介入的才是 ERROR,可自愈的用 WARN,正常流程用 INFO,调试细节用 DEBUG 且默认关闭。
小结
日志不是越多越好,是「排障时能回答那四个问题」才好。三件事优先级最高:加请求 ID、异常日志补上下文、把 ERROR 留给真正需要人处理的情况。
- 点赞
- 收藏
- 关注作者
评论(0)