DocumentationGrafana documentationAlertingConfigure alert rulesConfigure data source-managed alert rules

Configure data source-managed alert rules

Create alert rules for an external Grafana Mimir or Loki instance that has ruler API enabled; these are called data source-managed alert rules.

Note:

Alert rules for an external Grafana Mimir or Loki instance can be edited or deleted by users with Editor or Admin roles.

If you delete an alerting resource created in the UI, you can no longer retrieve it. To make a backup of your configuration and to be able to restore deleted alerting resources, create your alerting resources using file provisioning, Terraform, or the Alerting API.

Before you begin

• Verify that you have write permission to the Prometheus or Loki data source. Otherwise, you will not be able to create or update Grafana Mimir managed alert rules.

• For Grafana Mimir and Loki data sources, enable the Ruler API by configuring their respective services.

  • Loki - The local rule storage type, default for the Loki data source, supports only viewing of rules. To edit rules, configure one of the other rule storage types.

  • Grafana Mimir - use the /prometheus prefix. The Prometheus data source supports both Grafana Mimir and Prometheus, and Grafana expects that both the Query API and Ruler API are under the same URL. You cannot provide a separate URL for the Ruler API.

Watch this video to learn more about how to create a Mimir managed alert rule:

In the following sections, we’ll guide you through the process of creating your data source-managed alert rules.

To create a data source-managed alert rule, use the in-product alert creation flow and follow these steps to help you.

Set alert rule name

1. Click Alerts & IRM -> Alert rules -> + New alert rule.

2. Enter a name to identify your alert rule.

   This name is displayed in the alert rule list. It is also the alertname label for every alert instance that is created from this rule.

Define query and condition

Define a query to get the data you want to measure and a condition that needs to be met before an alert rule fires.

Note:

All alert rules are managed by Grafana by default. To switch to a data source-managed alert rule, click Switch to data source-managed alert rule.

1. Select a data source from the drop-down list.

   You can also click Open advanced data source picker to see more options, including adding a data source (Admins only).

2. Enter a PromQL or LogQL query.

3. Click Preview alerts.

Set alert evaluation behavior

Use alert rule evaluation to determine how frequently an alert rule should be evaluated and how quickly it should change its state.

1. Select a namespace or click + New namespace.

2. Select an evaluation group or click + New evaluation group.

   If you are creating a new evaluation group, specify the interval for the group.

   All rules within the same group are evaluated sequentially over the same time interval.

3. Enter a pending period.

   The pending period is the period in which an alert rule can be in breach of the condition until it fires.

   Once a condition is met, the alert goes into the Pending state. If the condition remains active for the duration specified, the alert transitions to the Firing state, else it reverts to the Normal state.

Configure notifications

Add labels to your alert rules to set which notification policy should handle your firing alert instances.

All alert rules and instances, irrespective of their labels, match the default notification policy. If there are no nested policies, or no nested policies match the labels in the alert rule or alert instance, then the default notification policy is the matching policy.

1. Add labels if you want to change the way your notifications are routed.

   Add custom labels by selecting existing key-value pairs from the drop down, or add new labels by entering the new key or value.

Add annotations

Add annotations. to provide more context on the alert in your alert notifications.

Annotations add metadata to provide more information on the alert in your alert notifications. For example, add a Summary annotation to tell you which value caused the alert to fire or which server it happened on.

1. Optional: Add a summary.

   Short summary of what happened and why.

2. Optional: Add a description.

   Description of what the alert rule does.

3. Optional: Add a Runbook URL.

   Webpage where you keep your runbook for the alert

4. Optional: Add a custom annotation

5. Optional: Add a dashboard and panel link.

   Links alerts to panels in a dashboard.

   Note

   At the moment, alerts are only supported in the time series and alert list visualizations.

   Give it a try using Grafana Play

   With Grafana Play, you can explore and see how it works, learning from practical examples to accelerate your development. This feature can be seen on visualizations with linked alerts in Grafana.

6. Click Save rule.