You need to sign in or sign up before continuing.
Add runbooks to Gitlab Alerts
Problem to solve
When an incident occurs, knowing how to respond can be difficult, especially if on-call engineers are not the individuals who wrote the code causing an incident. Having access to runbooks or knowledge about a metric causing alerts is critical to solving a problem and identifying the root cause cause quickly. Add runbooks to the alerts you configure in GitLab so that when the alert triggers, you have immediate access to it.
Intended users
Further Details
This work supports the direction of the Alert Management product category.
Proposal
Runbooks should be associated with alerts. If an alert is configured for an application, then it stands to reason that there should also be a corresponding runbook.
- Allow a url for a runbook to be associated with an alert
- The link should be injected into the prometheus alerting rules, so when an alert is triggered, the link to the runbook will be present in the alert (and thus in the incident issue that is created from the alert).
- Right now, if users click on the alert badge, a modal opens up for them to add a new alert. We should change this behavior so that clicking on the alert badge opens up the alert that's been configured, so users can more easily add/edit the runbook. If a user needs to add an additional alert, they can still do so through the "more options" menu.
| Add runbook URL when adding alert | Access runbook url from incident |
|---|---|
 |
 |
Release Post Image
Permissions and Security
Documentation
Documentation required. Please add detail here and here.
Availability & Testing
What does success look like, and how can we measure that?
What is the type of buyer?
Links / references
Edited by Sarah Waldner