让日志回答接下来的问题
好的日志能说明发生了什么,而不要求读者重新理解整个应用。
最有用的日志通常不是最长的那条,而是能回答具体问题的那条:哪个操作受到了影响,做出了什么决定,接下来发生了什么?
从事件开始
用清楚的语言描述事件,把变化的细节放进结构化字段。稳定的事件名称让统计和比较更容易,不必解析每次发布都会改变的句子。
下游调用失败时,有用的信息包括依赖名称、耗时、尝试次数和错误类别。完整的请求正文通常没那么有用,还可能包含不该进入日志的信息。
谨慎传递上下文
请求标识能串起相关事件。在自己负责的处理链路中传递它,并在重要边界处记录。不要把它和认证令牌、会话秘密或其他能授予访问权限的值混为一谈。
关联标识只是一个引用,并不能证明两个事件存在因果关系。后台任务、队列和并行调用可能还需要单独的操作标识,才能把关系说清楚。
用严重程度指导行动
正常的重试不一定都要记为错误。预期内的拒绝可能适合统计次数,却不适合触发告警。把最强的信号留给确实需要关注的情况。
也不要在每一层重复报告同一个失败。让拥有足够上下文的那层解释结果;更底层的日志只有在补充不同事实时才有必要。
从头到尾读一次失败
在认为日志修改完成之前,触发一个有代表性的失败,并阅读产生的记录。能否区分依赖变慢和输入被拒绝?能否找到最终结果?有没有暴露敏感数据?
日志应该减少维护者需要追问的问题。如果一条日志只说“出了点问题”,这就是下一次改进的起点。