知识卡片

普通读书笔记卡 · 2277.q.1

日志该有与不该有

理解等级:未标注

好日志不在多少而在恰当。不该有的:敏感信息,清理极难,但用户 ID 应保留;慢操作,为打日志去查库或远程调用得不偿失;追踪诊断信息,如方法入参、返回值、耗时,诊断应交给追踪系统或 Arthas 这类工具;误导性内容,如已处理的异常仍打印堆栈。不该少的:贯穿调用链并返回客户端的 TraceID;操作、异常、定时任务等关键事件;启动时的配置信息,因为初始化只执行一次、难以复现。

这张卡片看不懂?

已有反馈 · 0 / 10 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    • 可观测性 10.1.1 输出 · 查看原书依据

      避免打印敏感信息。不用专门提醒,任何程序员肯定都知道不该将密码、银行账号、身份证件这些敏感信息打到日志里,但笔者曾见过不止一个系统的日志中能直接找到这些信息。一旦这些敏感信息随日志流到了后续的索引、存储、归档等步骤中,清理起来将非常麻烦。不过,日志中应当包含必要的非敏感信息,譬如当前用户的

    参考来源

    - 位置:《凤凰架构:构建可靠的大型分布式系统》第10章"可观测性"10.1.1节 "输出"(源文件:_epub-src/OEBPS/Text/chapter114.xhtml) - 结论依据:原文分别列举避免打印敏感信息、避免引用慢操作、避免打印 追踪诊断信息、避免误导他人四类"不应该有"的内容,以及TraceID、关键 事件、启动配置信息三类"不应该少"的内容,并解释每一条的具体理由, 直接支撑本卡片结论。 - 原始内容:日志中不要打印方法输入参数、输出结果、方法执行时长之类的调试信息……之所以将其归为反模式,是因为上面说的敏感信息、慢操作等的主要源头就是这些原本想用于调试的日志……处理请求时的TraceID……应该自动生成唯一的TraceID来对请求进行标记