Menu

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Grafana Cloud Enterprise Open source

Manage provisioned alerting resources

Verify that your alerting resources were created in Grafana, as well as edit or export your provisioned alerting resources.

View provisioned alerting resources

To view your provisioned resources in Grafana, complete the following steps.

  1. Open your Grafana instance.
  2. Navigate to Alerting.
  3. Click an alerting resource folder, for example, Alert rules.

Provisioned resources are labeled Provisioned, so that it is clear that they were not created manually.

Export provisioned alerting resources

Export your alerting resources, such as alert rules, contact points, and notification policies in JSON, YAML, or Terraform format. You can export all Grafana-managed alert rules, single folders, and single groups.

To export provisioned alerting resources from the Grafana UI, complete the following steps.

  1. Click Alerts & IRM -> Alert rules.

  2. To export all Grafana-managed rules, click More v -> Export all Grafana-managed rules.

  3. To export a folder, change the View as to List.

  4. Select the folder you want to export and click the Export rules folder icon.

  5. To export a group, change the View as to Grouped.

  6. Find the group you want to export and click the Export rule group icon.

  7. Choose the format to export in.

    Note that formats JSON and YAML are suitable only for file provisioning. To get rule definition in provisioning API format, use the provisioning GET API.

  8. Click Copy Code or Download.

  9. Choose Copy Code to go to an existing file and paste in the code.

  10. Choose Download to download a file with the exported data.

Edit provisioned alert rules

Use the Modify export mode for alert rules to edit provisioned alert rules and export a modified version.

Note

This feature is for Grafana-managed alert rules only. It is available to Admin, Viewer, and Editor roles.

To edit provisioned alerting alert rules from the Grafana UI, complete the following steps.

  1. Click Alerts & IRM -> Alert rules.

  2. Locate the alert rule you want to edit and click More -> Modify Export to open the Alert Rule form.

  3. From the Alert Rule form, edit the fields you want to change.

  4. Click Export to export all alert rules within the group.

    You can only export groups of rules; not single rules. The exported rule data appears in different formats - HTML, JSON, Terraform.

  5. Choose the format to export in.

  6. Click Copy Code or Download.

    a. Choose Copy Code to go to an existing file and paste in the code.

    b. Choose Download to download a file with the exported data.

Edit API-provisioned alerting resources

To enable editing of API-provisioned resources in the Grafana UI, add the X-Disable-Provenance header to the following requests in the API:

  • POST /api/v1/provisioning/alert-rules
  • PUT /api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group} (calling this endpoint will change provenance for all alert rules within the alert group)
  • POST /api/v1/provisioning/contact-points
  • POST /api/v1/provisioning/mute-timings
  • PUT /api/v1/provisioning/policies
  • PUT /api/v1/provisioning/templates/{name}

To reset the notification policy tree to the default and unlock it for editing in the Grafana UI, use the DELETE /api/v1/provisioning/policies endpoint.

To pass the X-Disable-Provenance header from Terraform, add it to the http_headers field on the provider object:

provider "grafana" {
  url  = "http://grafana.example.com/"
  auth = var.grafana_auth
  http_headers = {
    "X-Disable-Provenance" = "true"
  }
}

Note:

You cannot edit provisioned resources from files in Grafana. You can only change the resource properties by changing the provisioning file and restarting Grafana or carrying out a hot reload. This prevents changes being made to the resource that would be overwritten if a file is provisioned again or a hot reload is carried out.