小服务的日志:先写给未来的自己看
小服务出问题的时候,最先被翻出来的往往不是代码,而是日志。可是很多日志写的时候图省事,出问题的时候才发现:该记的没记,记了的看不懂,看懂了又对不上时间。日志不是写给机器看的运行痕迹,而是写给未来的自己看的排障笔记。写日志之前先想清楚一个问题:三个月后半夜被叫起来的人,凭这几行字能不能定位问题?能,就是好日志;不能,写再多也是噪音。
先说记什么。我的标准是:只记“事后无法从别处还原的信息”。一次请求进来,记它的关键标识,比如请求 ID、用户或租户的脱敏标识、入口和关键参数的摘要;一次关键决策发生,记决策的结果和依据,比如走了哪条分支、命中了哪条规则、拒绝的原因是什么;一次外部调用失败,记对方返回的状态、耗时和重试次数。至于那些从代码里一眼能看出的流程——“进入函数 A”“开始处理 B”——不记也罢,它们只会把真正重要的几行淹没。日志的密度要克制,一次请求留下一条能讲清来龙去脉的主线,远胜于几十行流水账。
再说级别。级别不是心情,而是给读日志的人的筛选器。错误级只留给“需要人介入”的事:数据写坏了、外部依赖彻底不可用、任务重试耗尽了。警告级留给“现在还能跑,但已经不对劲”的信号:重试成功了、配额快用完了、某个依赖慢得超出预期。信息级记录正常的业务里程碑:任务完成、配置生效、批量处理跑完一批。最忌讳的是把一切都打成错误,或者把错误打成信息——前者让人对报警麻木,后者让真正的故障在信息流里悄悄溜走。级别定下来就要全服务统一,同一个事件在不同模块里不能一会儿是警告一会儿是错误,否则筛选就失去了意义。
第三个容易踩的坑,是日志里混进了不该记的东西。密码、令牌、完整的身份证号、银行卡号,哪怕只是调试时顺手打出来的,都会跟着日志文件、日志平台一路扩散,事后清理的成本远高于当时多写两行脱敏代码。我的做法是:参数只记摘要和脱敏后的形式,敏感字段在写日志的入口处统一处理,而不是靠每个开发自觉。日志要能长期保存、能放心地给接手的人看,脱敏不是可选项,是底线。
还有两个实操细节,平时不起眼,出问题时很要命。一是时间:所有服务用同一时区、同一格式,最好带毫秒和时区标识,否则跨服务对时间线的时候,几分钟的时差就能把因果关系完全打乱。二是关联:一次请求从入口到出口共用一个请求 ID,每条日志都带上它,排障时按 ID 一搜,整条链路就串起来了;没有这个 ID,日志就是一堆互不相干的碎片,只能靠时间硬猜。
最后说保留和成本。日志不是越多越久越好:调试级日志只在排查期间开,开完记得关;常规日志按天滚动、按量清理,过期就删。小服务的日志策略,做到这几点就够用了:记无法还原的信息、级别统一且有意义、敏感信息脱敏、时间格式统一、请求全程可追踪。日志写得少一点没关系,关键是出问题那天,未来的自己打开它,能在十分钟内说出“问题出在哪一步”。写日志的时候多替那个人想一分钟,半夜排障的时候就能少折腾一小时。
- 点赞
- 收藏
- 关注作者
评论(0)