SuperAPI AI 工具集

incident-report

部署与运维

查看项目

更新于 10-15 08:10

技能介绍

用途

Incident Report Skill 用于在故障发生后生成结构化的无责事后复盘报告(blameless postmortem)。其目标不是追责,而是帮助团队从事件中学习并防止再次发生。报告会分析 Git 历史、近期部署、代码变更、日志与错误模式,最终输出一份 Markdown 文件。

主要能力

  • 事实收集:通过 Git 命令获取近期部署、合并、标签、代码变更热点、关键区域(如 auth、payment、db)变更、配置与基础设施变更、依赖变更等。
  • 错误模式检查:检查近期变更文件中的错误处理、TODO/FIXME/HACK、已知问题、缺失的错误处理等。
  • 环境与配置检查:查看 .env.example、配置文件、Docker/基础设施配置、健康检查与监控配置。
  • 数据库状态检查:查看近期迁移、schema 变更等。
  • 事件分类:按严重级别(SEV-1 至 SEV-4)和类别(可用性、性能、数据、安全、功能、集成、基础设施、部署、容量、依赖)分类。
  • 时间线构建:记录从正常状态、触发事件、首次症状、检测、响应、诊断、缓解、部分恢复、完全恢复、验证到事件关闭的时间线,并计算 TTD、TTR、TTM 等关键指标。
  • 根因分析:使用 5 Whys 方法,识别贡献因素并分类(代码缺陷、配置错误、部署问题、基础设施、依赖失败、数据问题、容量、流程缺口、沟通、设计缺陷),复杂事件可绘制故障树。
  • 影响评估:评估用户影响、系统影响与业务影响,包括受影响用户数、失败请求、收入影响、数据影响、SLA 影响、支持工单等。
  • 响应评价:总结做得好的地方、做得不好的地方以及侥幸之处。
  • 行动项:按紧急程度(立即 0-48 小时、短期 1-2 周、中期 1-3 个月)分类,并标注类型(修复、检测、预防、韧性、流程、文档、架构)、负责人、截止日期与状态。
  • 经验教训与预防框架:提炼关键要点,并从检测、流程、架构三方面提出改进。

使用方式

该技能以结构化流程执行,包含以下步骤:

  1. 输出设置:创建 project-decisions 目录(若不存在),文件保存为 project-decisions/YYYY-MM-DD-incident-[kebab-case-topic].md。
  2. 事件发现:运行 Git 命令收集近期部署、代码变更、错误模式、环境配置与数据库状态。
  3. 事件分类:确定严重级别与类别。
  4. 时间线构建:整理事件时间线并计算关键指标。
  5. 根因分析:使用 5 Whys、贡献因素表、原因分类与故障树。
  6. 影响评估:评估用户、系统与业务影响。
  7. 响应评价:总结做得好、不好与侥幸之处。
  8. 行动项:按紧急程度分类并指定负责人与截止日期。
  9. 经验教训:提炼关键要点。
  10. 预防框架:从检测、流程、架构三方面提出改进。

适用场景

  • 生产环境发生故障后需要生成复盘报告。
  • 团队希望以无责方式分析事件、改进系统与流程。
  • 需要从 Git 历史、部署记录、代码变更中快速提取事件相关事实。
  • 需要标准化的事件报告格式与行动项跟踪。

限制

  • 该技能依赖 Git 仓库与相关配置文件的存在,若项目未使用 Git 或缺少配置,部分分析可能无法进行。
  • 报告中的具体数据(如用户影响、收入影响)需要团队根据实际情况填写,技能本身不提供这些数据。
  • 该技能不执行实际修复或监控配置,仅生成报告与建议。
  • 关于收费、价格、平台支持等具体信息,资料中暂未提供。