Skip to content

Access alert runbooks from metrics chart

Problem to solve

When an incident occurs, knowing how to respond can be difficult, especially if you are not the engineer 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. In GitLab 13.3, any runbook that you've added to an alert configured via a chart on your metrics dashboard is now easily accessible via the drop-down menu in the upper righthand corner of the chart.

Intended users

Further details

This work supports the direction of the Alert Management product category.

Proposal

When a runbook has been added to an alert, surface a View runbook option within the associated metric's more options menu:

Screen_Shot_2020-02-28_at_4.22.32_PM

Note: dropdown link should be initial caps so, it should read View runbook

In addition, we are discussing adding an icon button to the end of the runbook entry field within the alert modal. This button would utilize the external link icon and have the following behaviors:

  • When no URL has been added, the icon button is disabled
  • When a URL has been enabled, the icon button is enabled
  • Clicking on the icon button will open the associated runbook in a new tab

Release Post Image

mockup

Permissions and Security

Documentation

Documentation required.

Availability & Testing

What does success look like, and how can we measure that?

What is the type of buyer?

Is this a cross-stage feature?

Links / references

Edited by Amelia Bauerly