Runbook

A runbook automates rote tasks that must kick off when an incident occurs. It improves assembly time by executing crucial actions for addressing the incident.

What is a runbook?

Runbooks automate some of the routine procedures needed to resolve an incident. They look similar to playbooks, which describe standard, manual processes to follow when incidents happen. But unlike playbooks, runbooks automatically execute crucial actions to address the incident upon an incident declaration. These actions could include forming a Slack channel, initiating a Zoom call, or generating a Jira ticket.

Why are runbooks important?

Runbooks activate pre-configured steps when an incident is declared, automating some of the incident response process. They can do several tasks, such as creating a new ticket in Jira or updating status pages — simultaneously, if needed. 

These pre-set actions streamline incident response processes by reducing manual tasks and increasing efficiency. By automating certain aspects of an incident response process, teams can resolve the incident more effectively. Runbooks also help reduce errors and refocus the team on problem-solving by handling rote tasks.

What are some runbook best practices? 

As you and your team build out runbooks for automating parts of the incident management process, keep the following best practices in mind:

• Keep it simple.

• Use conditions.

• Don’t reinvent the wheel; use pre-made templates and go from there.

Keep it simple

Keep each runbook single-purpose and descriptive — similar to writing a function in a programming language. These steps simplify diagnosing  issues and upkeep your runbooks in the long run.

Use conditions

Any number of runbooks can be added to an incident to "compose" the best response. For instance, you could set a default runbook to always attach when you declare an incident. But then you could configure severity-based runbooks to only attach after the given severity is set. Similarly, you can set the advanced runbooks to attach conditionally based on services or functionality.

Don’t reinvent the wheel

It can seem overwhelming to write runbooks from scratch. Instead, start with pre-made templates and go from there. The FireHydrant team wrote up some common patterns to help users get started. As we created these templates, we aimed for both simplicity and flexibility.