Dev
Générateur de runbook d'astreinte
An on-call runbook generator produces a template for the document an engineer reaches for at 3 a.m. when a service is paging. Name the service or alert and it returns the structure a useful runbook needs: what the service does, which alerts fire and what they mean, first diagnostic checks, common causes and their fixes, escalation contacts, and links to dashboards and logs. SRE and on-call teams use runbooks to respond faster and let anyone on rotation handle an alert without deep prior knowledge of the system. A good runbook turns a panicked investigation into a calm checklist — the difference between a quick mitigation and a prolonged outage. Fill the placeholders with the real checks, fixes, and links for your service, and keep it updated after each incident. The best time to write a runbook is before you need it.
How to use
- Choose your options above
- Click Generate
- Copy your result
Detailed instructions
- 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 should a runbook contain
What the service does, which alerts fire and their meaning, the first diagnostic checks, common causes and fixes, escalation contacts, and links to dashboards and logs. The goal is a calm checklist anyone on call can follow.
why write runbooks in advance
During an incident there is no time to figure out the system from scratch. A runbook written calmly beforehand turns a panicked investigation into a sequence of known checks, which speeds mitigation and lowers stress.
how do i keep a runbook useful
Update it after each incident with what you learned — new symptoms, better checks, fixes that worked. A stale runbook erodes trust; one refined by real incidents becomes the team's most valuable on-call asset.
What is the difference between a runbook and a playbook?
A runbook gives step-by-step instructions for a specific, often routine task or known failure ("restart the queue worker"), while a playbook is broader strategy for a class of situations ("how we handle a major outage"), coordinating people and decisions. The generator helps you draft the concrete, procedural runbook — the precise steps an on-call engineer follows at 3am when a specific alarm fires.
When should I create a runbook for a service?
Write one for anything that can page someone — as soon as a service is on-call-supported, and especially after any incident, capturing what you learned while it is fresh. A runbook turns hard-won 3am knowledge into something the next person can follow. The generator gives you a structured starting point, so creating a runbook for a new alert is quick rather than a chore you postpone.
You might also like
Popular tools from other categories that share themes with this one.
Try these next
More free tools from other corners of the catalog, picked by shared themes.