SuperAPI AI 工具集

common-observability

部署与运维

查看项目

更新于 10-16 05:51

技能介绍

用途:为后端服务建立统一的可观测性标准,覆盖日志、追踪与指标三方面,优先级为 P1(高)。

主要能力与要求: 日志与追踪:始终输出 JSON 结构化日志,生产环境禁止纯文本;提取 X-Request-Id 或 traceparent 并附加到异步上下文;使用 OpenTelemetry 并传播 W3C traceparent;span 命名采用 <HTTP_METHOD> <route> 形式,如 GET /users/:id。资料提到可参考使用 Pino 的结构化日志实现示例。 指标:必需项包括请求速率、错误率、延迟直方图(p50/p95/p99)与饱和度;告警应基于 SLO 燃烧率,而非原始阈值尖峰。

使用方式(插桩工作流):先定义操作与路由归一化的 span 名称,再写代码;在每个异步或服务边界传播请求/追踪上下文;记录一条带关联字段的结构化事件,并脱敏密钥与请求体;添加带路由安全标签的 RED 指标,再定义 SLO 与燃烧率告警;最后验证成功与失败路径,确认 span 正常结束且 ID 能将日志与追踪关联起来。

反模式:生产环境不要用 console.log,应使用结构化日志库(pino、zap);日志中禁止记录令牌、密码或完整请求体等 PII;避免动态 span 名称(如 GET /users/123 会导致基数爆炸,应使用 GET /users/:id);务必结束追踪 span。

限制:资料未提供具体安装命令、代码示例全文、支持的平台或收费信息。