Skip to content

Document how Grafana Alerting is enabled

Summary

Our current documentation doesn't seem to discuss how to enable Grafana alerting (default: disabled). After the users configure Grafana, users can observe that the Alert tab is not readily available in their Grafana Dashboard. They need to set grafana['alerting_enabled'] to true and reconfigure their instance for this to be available.

Implementation Guide

Add a section in https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/settings/grafana.md discussing how to enable Grafana Alerting. For Example:

Grafana Alerts

Grafana can provide the ability to create alerts based on rules that you configure in your dashboard.

By default, alerts are disabled in the bundled Grafana instance.

Enabling Grafana’s Alerts

To enable Grafana’s Alerts:

  • Edit /etc/gitlab/gitlab.rb and add/edit the following lines:
grafana['alerting_enabled'] = true
  • Save the file and reconfigure GitLab for the changes to take effect.

References

Edited by DJ Mountney