日志写给未来的自己:让排查问题有据可查
出问题的时候,最先被找来帮忙的往往不是代码,而是日志。日志写得好不好,直接决定了排查问题要花十分钟还是半天。写日志的时候,不妨把它当成写给未来的自己的便条:未来的那个人,可能就是凌晨被叫起来处理故障的你。
一、只记有用的事,不记流水账
不是所有动作都值得记。用户点开一个页面、系统完成一次心跳,这些正常状态不必逐条写进日志。真正值得记的,是状态变化和决策点:任务开始、任务完成、关键参数变化、外部调用失败。日志少而精,出了问题才找得到重点。
二、把上下文写全,别只留一句话
一句“处理失败”帮不上忙,排查的人还得再去翻代码、猜参数。好的日志会把关键上下文写在一起:是哪一个任务、处在哪一步、涉及哪一个对象、失败原因是什么。上下文写全了,日志自己就能讲清楚事情的经过。
三、级别要分清,别全都当错误
信息、警告、错误各有各的用途。正常流程用信息级,暂时还能继续但值得留意的情况用警告级,确实处理不下去才用错误级。如果所有日志都是错误级,真正出问题时反而分不清轻重。级别分清了,监控和告警才有依据。
四、别把敏感内容写进日志
口令、密钥、证件号码、完整的个人信息都不应该出现在日志里。日志会被多人阅读、长期保存,一旦混入敏感内容,排查就变成了泄密。写日志之前,先想一想:这条内容被别人看到,会不会有问题。
五、定时回头看,别等出事才翻
日志不是写完就完。定期翻一翻近期的警告和错误,就能发现一些正在变坏的趋势,比如某个接口偶尔超时、某个任务偶发失败。早一点发现,处理起来就从容得多。
日志的价值不在写的那一刻,而在用的时候。写得清楚、写得克制、写得安全,日志就能在关键时刻替你说话。
- 点赞
- 收藏
- 关注作者
评论(0)