首页/AI 提示词库/编程开发/日志规范设计

日志规范设计

⌨ 编程开发 适配:Claude / GPT / DeepSeek难度:进阶 4 个变量一键复制
使用说明

日志乱成浆糊排查全靠猜:设计一套打日志的标准——分级、结构化字段、trace 贯穿和保留策略。

出问题翻日志翻不到关键信息、微服务间请求串不起来、日志量爆炸找不到重点的团队。

提示词模板未填写变量以红色标出
帮我们团队定一套能落地的日志规范。

【系统情况】{{系统形态}}
【现在的痛点】{{现状痛点}}
【技术栈】{{技术栈}}
【团队】{{团队规模}}

请输出:
一、分级标准:ERROR/WARN/INFO/DEBUG 各自的判定标准(举 3 个本系统场景的例子),以及「禁止用 ERROR 打业务失败」这类常见的分级误用。
二、结构化字段规范:每条日志必带的公共字段(时间、级别、服务名、traceId、userId),业务日志怎么补充上下文(订单号用 MDC 还是手动传),给出一条符合规范的日志样例和一条反面样例。
三、链路贯穿:traceId 怎么从入口服务透传到下游和定时任务(没上全链路追踪的情况下,最轻量的透传做法),跨服务搜日志的操作流程。
四、量与保留:按我的流量估算日志量级,各级别保留时长建议、哪些日志必须脱敏(手机号/订单地址)、哪些场景不打日志改打指标。
五、落地机制:5 人团队怎么让规范被执行——code review 检查项、lint 规则、存量日志改造的优先级排序(先改核心链路)。

要求:规范条目控制在能背下来的数量,宁少而严,不多而虚;样例代码贴合我的技术栈。
填变量变量会自动替换进上方模板,可随时复制
已填 0 / 4
使用步骤
  1. 先统一公共字段和 traceId,这一步收益最大。
  2. 核心交易链路第一批改造,边角服务慢慢迁。
  3. 把规范贴进 code review 清单,靠流程不靠自觉。
日志是写给三个月后的自己
判断标准很简单:这条日志在凌晨排障时能不能直接回答「发生了什么、涉及谁」。
先上 traceId 再谈平台
没有 traceId 之前上 ELK,只是把乱日志搬了个地方;串起来才有价值。
常见问题
要不要直接上 ELK/Loki?

先规范后平台。把结构化字段和 traceId 落地后,无论用什么平台都能查;顺序反了就是花冤枉钱。

敏感信息怎么防漏打?

在日志框架层加脱敏 pattern(手机号、身份证正则替换),靠 review 拦不住所有人。