Reference — generated from the toolkit
Source of truth: toolkit/templates/runbook.md. Edit it there; this page is regenerated on build.
Runbook — {service name}
- Service owner: … On-call: … Version: 0.1.0
Overview
What the service does, its dependencies, and its place in the system.
Dashboards & alerts
Links to the golden-signal dashboards and the alerts that page. What each alert means.
Diagnostics
Step-by-step checks for a reported problem. Mark each step:
- 🤖 agent-executable — an agent may run this to gather evidence (read-only / reversible).
- 👤 human-only — anything irreversible (restart in prod, failover, data change) needs a named human.
Known failure modes
| Symptom | Likely cause | Action | Linked gotcha |
|---|---|---|---|
| … | … | … | memory/… |
Escalation
Who to escalate to, when, and how. Severity thresholds and the rapid-fix path.
Recovery
Backup/restore and rollback procedures, and how to verify recovery succeeded.