This is documentation for the next version of Grafana documentation. For the latest stable release, go to the latest version.

Documentation Grafana documentation Alerting Configure alert rules Improve alert rule quality with Alert Advisor

Improve alert rule quality with Alert Advisor

Alerts are easier to act on when they carry the right context. A runbook URL helps you investigate an issue, and a team label helps you route your notifications.

Alert Advisor checks your Grafana-managed alert rules against a quality policy of required labels and annotations, so you can find and fix rules that are missing that context. With Alert Advisor, you can:

• Define which labels and annotations your Grafana-managed alert rules must have.
• Find rules that are missing required labels or annotations and update them.
• Optionally block supported provisioning writes that don’t meet selected requirements.

Before you begin

Before you begin, check that you have the following permissions in your Grafana organization:

• Rule access: Have permission to view the Grafana-managed alert rules you want to assess.
• Policy permissions: To configure the quality policy, have the Admin role in your organization or a role with alert.rules.quality:write and alert.rules:read.
• Rule updates: To fix findings, have permission to update the affected rules. For provisioned rules, you also need access to their source configuration and permission to reapply it.

For more information about alerting permissions and folder access, refer to Configure RBAC.

Understand policy scope

A single quality policy applies to Grafana-managed alert rules across folders in your organization. Data source-managed alert rules and recording rules are excluded.

Alert Advisor reports a finding when a required label or annotation is missing, empty, or contains only whitespace. The checks do not validate the content itself, they only check for the presence of a particular field. For example, requiring a runbook URL doesn’t check whether the link works.

Detection and enforcement

You choose a mode for each requirement:

Both modes contribute to the quality score. Enabling enforcement doesn’t stop existing rules from evaluating or sending notifications.

Supported enforcement paths

Enforcement applies to provisioned rules created or updated through Terraform and the Alerting provisioning HTTP API, with the following exceptions:

• Provisioning API requests that set the X-Disable-Provenance header, including Terraform grafana_rule_group resources with disable_provenance = true, aren’t enforced.
• kubectl writes are enforced only when the manifest sets grafana.app/managedBy to kubectl or terraform together with a non-empty grafana.app/managerId, or sets grafana.com/provenance to api.

Writes from the Grafana rule editor aren’t enforced, but the resulting rules can still have quality findings.

Configure a quality policy

Start with detect-only requirements to identify missing information before enabling enforcement. The following example requires a runbook URL and a team label.

The Quality policy settings button is visible only if you have the policy permissions listed in Before you begin.

To configure a quality policy, follow these steps:

1. Go to Alerting > Alert rules and select Alert quality.

2. Click Quality policy settings (the cog icon) to open the Quality policy drawer.

3. Under Required annotations, turn on Runbook URL.

   You can also require Summary and Description.

4. Under Required labels, enter team in Label keys and select the matching option.

   You can select keys already used by your rules or add a new key.

5. Keep Enforce off for the requirements you add.

   New requirements start in detect-only mode.

6. Click Save.

   Grafana displays Policy saved to confirm the change.

The saved policy identifies rules with missing or empty runbook_url annotations or team labels.

A policy with no required annotations or labels checks nothing.

Review alert quality

In Alert Advisor, the Alert quality tab lists rules that don’t meet your policy and shows an overall quality score.

To review the findings, follow these steps:

1. Go to Alerting > Alert rules and select Alert quality.
2. Review the Alert quality score and the number of rules that need attention.
3. Inspect the missing annotations and labels in the Findings list.

Each missing field appears as a badge. To check whether a requirement is enforced or detect-only, hover over its badge.

Understand the score

The score represents the proportion of assessed rules that meet every configured requirement, on a scale of 0 to 10. For example, if 8 of 10 rules meet the policy, the score is 8.0. Grafana rounds the score to one decimal place.

The score measures compliance with your policy, not alert accuracy, severity, or noise. Both detect-only and enforced requirements count toward the score.

Your permissions determine which rules you can view and assess. Search filters change the findings’ list, not the score or the total rule count. Grafana also displays 10.0 when there are no rules to assess, so check the rule count alongside the score.

Resolve quality findings

Add meaningful values for the missing fields in each rule. For the example policy, set runbook_url to the rule’s runbook URL and team to the owning team’s name.

Changing label values can affect notification routing. Choose values that match your team’s notification policies.

Update provisioned rules

For provisioned rules, make changes in the source configuration so they remain part of your provisioning workflow.

To resolve a finding on a provisioned rule, follow these steps:

1. Locate the rule in its source configuration, using the rule name, folder, and group shown in Alert quality.
2. Add values for the missing annotations and labels.
3. Reapply the configuration through your usual provisioning workflow.
4. Reload the Alert quality page and check the rule’s findings.

A rule disappears from the findings list when it meets every configured requirement. If other required fields are still missing, the rule remains in the list with those findings.

Update rules in Grafana

For rules that you can edit in Grafana, use the Edit action on the quality page.

To resolve a finding in the rule editor, follow these steps:

1. Click Edit for the affected rule.
2. Fill in the missing annotations and labels in the rule editor.
3. Click Save.
4. Return to Alert quality and reload the page to check the findings.

Optional: Enforce quality requirements

After reviewing and resolving findings, enable enforcement for the requirements you want to apply to supported provisioning writes. You can enforce selected requirements while keeping others detect-only.

To enable enforcement, follow these steps:

1. On the Alert quality page, click Quality policy settings (the cog icon) to open the Quality policy drawer.

2. Turn on Enforce beside each requirement you want to enforce.

   For example, enforce team while keeping Runbook URL detect-only. To enforce all currently configured requirements, turn on Enforce all requirements instead.

3. Click Save.

   Grafana displays Policy saved to confirm the change.

Disable enforcement or remove a requirement

To return a requirement to detect-only, turn off its Enforce control (or Enforce all requirements, if every requirement is enforced) and click Save. The requirement remains in the policy and continues to affect the quality score.

To stop checking a field altogether, remove its requirement instead: turn off its switch under Required annotations, or remove its key from Label keys. Then click Save.

Troubleshoot quality findings and rejected writes

Use the following guidance when you can’t access the feature, resolve a finding, or apply a rule change.

Next steps

Use these guides to improve rule context, manage rules as code, and configure access:

• Rule context: Labels and annotations.
• Provisioning: Use Terraform to provision alerting resources.
• API management: Use the HTTP API to manage alerting resources.
• Permissions: Configure RBAC.