mcpField
O
observability-audit

observability-audit

github.com/marcioaltoe测试与质量059 次安装1 天前更新
代码仓库

关于 observability-audit

Observability Audit 是用于检查软件变更发布后是否便于运行和诊断的技能。它指导审查 API、后台任务、同步流程和外部适配器，并关注可追踪证据与敏感数据处理。

主要功能

  1. 01按场景分类的审计问题
  2. 02API 与任务证据清单
  3. 03外部适配器日志指导
  4. 04结构化日志质量检查
  5. 05发现项与证据缺失报告格式

适用场景

  1. 01发布前审查可观测性
  2. 02发现任务与同步遥测缺口
  3. 03检查日志是否暴露敏感数据

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/marcioaltoe/skills --skill observability-audit

安装后在 Claude Code 中输入/observability-audit确认已加载。

详细介绍

可观测性审计

使用此技能，验证变更发布后是否可运维。

审计问题

  • 运维人员能否判断工作流是否运行？
  • 能否按原因对故障进行归类？
  • 用户报告能否追溯到请求、作业、租户、账户或外部系统 ID？
  • 重试、部分故障和跳过的记录是否可见？
  • 日志和证据中是否排除了密钥和个人数据？
  • 代码是否保留外部请求 ID 或提供商关联 ID？

各类场景所需的证据

HTTP API
  • 请求 ID 或关联 ID
  • 路由或操作名称
  • 状态码和耗时
  • 安全时记录已认证的操作者或租户 ID
  • 规范化的错误类型
后台作业和同步
  • 运行 ID
  • 源系统
  • 前后检查点
  • 已获取、已更改、已跳过、失败的数量
  • 重试次数
  • 故障类别
外部适配器
  • 外部系统名称
  • 操作名称
  • 安全的外部标识符
  • 提供商返回的请求 ID
  • 超时／重试分类

日志质量检查清单

  • 日志采用结构化格式，而非插值拼接的内容。
  • 日志级别与运维严重性相符。
  • 敏感字段已脱敏或省略。
  • 日志行包含足够的上下文，以关联相关事件。
  • 预期内的验证失败不会被记录为进程错误。
  • 在处理异常的边界保留堆栈跟踪。

审查结果

审计时，请报告：

## Observability Findings

- [severity] [file:line] Finding and operational impact.

## Missing Evidence

- Request/job/correlation IDs:
- Counts/status summaries:
- External provider metadata:
- Redaction concerns:

## Recommended Fixes

- Concrete code or logging changes.

常见错误

  • 只在启动和最终失败时记录日志。
  • 记录原始请求正文、令牌、标头或预签名 URL。
  • 没有数量或检查点证据，却记录“成功”。
  • 隐藏提供商请求 ID。
  • 把可观测性当作注释，而非可执行的代码路径。

评论

支持 Markdown