写能解释发生了什么的日志
收录 2026-11-02
带上下文、可检索、能回答「为什么这次失败」。
我要给一段流程加日志(流程稍后说明)。请:1)列出这一行必须包含的字段(事件、对象、结果、耗时、关联 ID);2)写一条示例,说明每个字段为什么必要;3)指出哪些字段会泄露敏感信息,需要脱敏;4)给一个「只靠这行日志能回答的问题」清单;5)提醒我日志级别用错会怎样。不要打太多日志。
本站原创
中文原文
使用建议
好的日志是写给三个月后半夜排错的自己。
可以这样改
- 要求它先复述需求与约束,确认无误再写代码。
- 让它给出最小改动 + 回滚方式,而不是整文件重写。
交付物(这次应拿到什么)
- 可运行的最小改动(含直接可用的代码块)
- 影响面清单:改了哪些文件、哪些调用点要跟着改
常见错法
- 一次让它改十个文件,最后分不清哪处改动导致了新问题。
- 只贴报错不贴代码和版本,拿到无法落地的修法。
输出验收(怎么判断能用)
- 改动可运行、可回滚,且没顺手改无关代码。
- 边界条件(空值、超长、并发)有说明或测试。
适用场景与注意
- 适合:让它先复述需求和约束,再给最小可运行改动。
- 注意:贴报错时同时给版本号与最小复现,否则它容易给出看似合理但不适配的写法。