Runbook 是什么
Runbook 是面向值班人员的可执行操作手册:触发条件、前置检查、分步骤操作、验证点与回退路径,目标是让当班工程师在压力下也能安全处置。它假设读者没有上下文,所以命令要能直接复制,权限与预期输出都要写明。它与知识库文章的分工是:知识库解释为什么,Runbook 规定怎么做。Runbook 必须随变更更新并定期演练,否则会与实际流程脱节。
基本信息
| 读者 | 值班工程师(不假设已有上下文) |
|---|---|
| 结构 | 触发/前置/步骤/验证/回退/升级 |
| 维护 | 变更后更新并定期演练 |
| 颗粒度 | 一个告警或一个场景对应一份 |
| 存放位置 | 与监控告警联动,可一键打开 |
| 关键要求 | 每步写明预期结果与耗时 |
典型使用场景
- 夜间告警处置:值班人员按手册逐步执行,降低误操作风险
- 新成员上手:新人依靠手册独立值班,缩短培养周期
- 高频操作标准化:扩容、重启、主从切换统一手法
- 自动化前的过渡:先写清人工步骤,再逐步脚本化
- 演练与培训:用手册做桌面演练与故障注入
- 审计与复盘:处置过程有据可查,便于事后分析
Runbook 步骤模板
Runbook 步骤模板
1 确认现象:检查 X 指标与 Y 日志
2 前置判断:若 Z 条件不满足 → 升级
3 执行:运行命令 A(预期输出 B)
4 验证:指标恢复至 C
5 回退:15 分钟未恢复 → 执行 D 并通知
6 记录:在工单中粘贴关键输出与时间点质量检查项
| 检查项 | 合格标准 | 不合格表现 |
|---|---|---|
| 触发条件 | 明确对应哪个告警或场景 | 写得含糊,不知道何时使用 |
| 步骤 | 可复制的命令与预期输出 | 只讲原理,不给命令 |
| 回退 | 明确回退动作与触发阈值 | 只有正向步骤 |
| 维护 | 有更新记录与责任人 | 长时间未更新,与现状脱节 |
命令要可直接复制并注明权限与耗时:现场心算和临时查参数,是错操作的主要来源。
Runbook 与自动化是渐进替代关系:先固化为手册,再把稳定步骤脚本化,最后把判定条件也交给自动化。