← 返回全部文章

让日志在离开终端后仍然有用

时间、来源、动作和结果写清楚,一份朴素的日志也能帮助下一次定位问题。

先想将来会怎样查找

日志不只是给当时盯着终端的人看的。过几天再次寻找某次失败时,最有用的往往是时间、对象、执行的动作和结果。如果这些信息分别散在几个窗口里,重新拼起来会很费力。

同一种事件尽量采用一致的字段和写法。字段名称稳定,后来就容易按时间、对象或结果筛选,而不必猜测同一件事曾经用了多少种说法。

一行保存一件事

对于小脚本,逐行保存 JSON 是一种便于追加和读取的方式。下面是一条说明结构的示例;它只表达事件与状态,不包含真实认证信息。

{"time":"2026-10-26T10:30:00+08:00","task":"check","target":"example","status":"failed","reason":"timeout"}
  • 保留带时区的时间。
  • 错误类型与可读说明分开。
  • 成功、失败和重试各自记录。
  • 凭据和完整请求体按需要限制保存。

简明也需要保留证据

普通记录可以只保留必要的摘要,把更完整的原始材料放在适当的位置,并写明如何关联。摘要太少会失去排查价值,原样复制所有输出也可能带来噪声和敏感信息。

日志格式本身不能保证判断正确。真正有帮助的是持续保留相同口径的事实:发生了什么,执行到哪一步,哪一项条件没有满足。让记录能够被重新核对,比让每一行都显得漂亮更重要。

静花手记 · 工具与方法查看文章归档 →
找到下一篇想读的笔记
↑ ↓ 选择 · Enter 打开文章、花园与小工具。