On-Call Runbook Generator
Generates an on-call runbook template for a service or alert
About this generator
When a service is paging at 3 a.m., the on-call engineer should not be reverse-engineering how the system works. A runbook turns panicked investigation into a calm checklist — first checks, common causes, and who to escalate to. This generator gives you the structure before you need it. One input drives the output: the Service or alert field — payment API, high-latency alert, or queue backlog warning. The generator returns a Markdown runbook with six sections: What it does, Alerts (which fire and what each means), First checks as a numbered list, Common causes and fixes, Escalation, and Useful links. Fill the runbook when you set up a new service or add a new alert. Update it after every incident. A runbook is only valuable when it reflects real hard-won knowledge — the specific dashboard URL and the exact command that restarts a stuck worker.
How to use
- Name the service or alert.
- Click Generate to produce the runbook template.
- Fill in the real checks, fixes, and links.
- Update it after each incident.
Use Cases
- •Writing an on-call runbook for a service
- •Documenting how to respond to a specific alert
- •Letting anyone on rotation handle an incident
- •Reducing the stress and time of incident response
- •Standardising runbooks across services
Tips
- →Write the runbook before you need it, not during an incident.
- →List the first checks in the order to actually do them.
- →Include direct links to dashboards and logs.
- →Refine it after every incident with new lessons.
FAQ
what sections does the runbook template include
Six: What it does, Alerts (which alert fires and what it means), First checks (a numbered diagnostic checklist), Common causes and fixes (symptom-to-action mappings), Escalation (who to contact and when), and Useful links (dashboards, logs, code).
when should I write a runbook
As soon as a service can page someone, and again immediately after any incident while the details are fresh. The best time to write a runbook is before you need it; the second best is right after an incident.
how do I keep a runbook accurate over time
Update it after every incident with new failure modes, better checks, and fixes that worked. A stale runbook that sends engineers to a dashboard that no longer exists erodes trust faster than having no runbook.
what is the difference between a runbook and a postmortem
A runbook is a prospective guide for responding to a known alert during an incident. A postmortem is a retrospective review written after an incident resolves to identify causes and prevent recurrence. Both are operational documents; they serve opposite directions in time.
You might also like
Popular tools from other categories that share themes with this one.