root
/
grafana
mirror of https://github.com/grafana/grafana.git
1
0
Fork 0
Code Issues Actions 82 Packages Projects Releases Wiki Activity
grafana/docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md

11 KiB
Raw Blame History

aliases canonical description keywords labels title weight
../../provision-alerting-resources/view-provisioned-resources/
./view-provisioned-resources/
https://grafana.com/docs/grafana/latest/alerting/set-up/provision-alerting-resources/export-alerting-resources/ Export alerting resources in Grafana
grafana
alerting
alerting resources
provisioning
products
cloud
enterprise
oss
Export alerting resources 300

Export alerting resources

Export your alerting resources, such as alert rules, contact points, and notification policies for provisioning, automatically importing single folders and single groups. Use the Grafana UI or the HTTP Alerting API to export these resources.

Export from the Grafana UI

The export options listed below enable you to download resources in YAML, JSON, or Terraform format, facilitating their provisioning through [configuration files][alerting_file_provisioning] or [Terraform][alerting_tf_provisioning].

Export alert rules

To export alert rules from the Grafana UI, complete the following steps.

  1. Click Alerts & IRM -> Alert rules.

  2. To export all Grafana-managed rules, click Export 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.

    The exported alert rule data appears in different formats - YAML, JSON, Terraform.

  8. Click Copy Code or Download.

Modify alert rule and export rule group without saving changes

{{% admonition type="note" %}} This feature is for Grafana-managed alert rules only. It is available to Admin, Viewer, and Editor roles. {{% /admonition %}}

Use the Modify export mode to edit and export an alert rule without updating it. The exported data includes all alert rules within the same alert group.

To export a modified alert rule without saving the modifications, complete the following steps from the Grafana UI.

  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. Changes made are not applied to the alert rule.

  4. Click Export.

  5. Choose the format to export in.

    The exported alert rule group appears in different formats - YAML, JSON, Terraform.

  6. Click Copy Code or Download.

Export contact points

To export contact points from the Grafana UI, complete the following steps.

  1. Click Alerts & IRM -> Contact points.

  2. Find the contact point you want to export and click More -> Export.

  3. Choose the format to export in.

    The exported contact point appears in different formats - YAML, JSON, Terraform.

  4. Click Copy Code or Download.

Export templates

Grafana currently doesn't offer an Export UI for notification templates, unlike other Alerting resources presented in this documentation.

However, you can export it by manually copying the content template and title directly from the Grafana UI.

  1. Click Alerts & IRM -> Contact points -> Notification templates tab.
  2. Find the template you want to export.
  3. Copy the content and title.
  4. Adjust it for the [file provisioning format][alerting_file_provisioning_template] or [Terraform resource][alerting_tf_provisioning_template].

Export the notification policy tree

All notification policies are provisioned through a single resource: the root of the notification policy tree.

{{% admonition type="warning" %}}

Since the policy tree is a single resource, provisioning it will overwrite a policy tree created through any other means.

{{< /admonition >}}

To export the notification policy tree from the Grafana UI, complete the following steps.

  1. Click Alerts & IRM -> Notification policies.

  2. In the Default notification policy section, click ... -> Export.

  3. Choose the format to export in.

    The exported contact point appears in different formats - YAML, JSON, Terraform.

  4. Click Copy Code or Download.

Export mute timings

To export mute timings from the Grafana UI, complete the following steps.

  1. Click Alerts & IRM -> Notification policies, and then the Mute timings tab.

  2. Find the mute timing you want to export and click Export.

  3. Choose the format to export in.

    The exported contact point appears in different formats - YAML, JSON, Terraform.

  4. Click Copy Code or Download.

HTTP Alerting API

You can use the [Alerting HTTP API][alerting_http_provisioning] to return existing alerting resources in JSON and import them to another Grafana instance using the same endpoint. For instance:

Resource Method / URI Summary
Alert rules GET /api/v1/provisioning/alert-rules Get all alert rules.
Alert rules POST /api/v1/provisioning/alert-rules Create a new alert rule.

However, note these Alerting endpoints return a JSON format that is not compatible for provisioning through configuration files or Terraform, except the endpoints listed below.

Export API endpoints

The Alerting HTTP API provides specific endpoints for exporting alerting resources in YAML or JSON formats, facilitating [provisioning via configuration files][alerting_file_provisioning]. Currently, Terraform format is not supported.

Resource Method / URI Summary
Alert rules GET /api/v1/provisioning/alert-rules/export [Export all alert rules in provisioning file format.][export_rules]
Alert rules GET /api/v1/provisioning/folder/:folderUid/rule-groups/:group/export [Export an alert rule group in provisioning file format.][export_rule_group]
Alert rules GET /api/v1/provisioning/alert-rules/:uid/export [Export an alert rule in provisioning file format.][export_rule]
Contact points GET /api/v1/provisioning/contact-points/export [Export all contact points in provisioning file format.][export_contacts]
Notification policy tree GET /api/v1/provisioning/policies/export [Export the notification policy tree in provisioning file format.][export_notifications]

These endpoints accept a download parameter to download a file containing the exported resources.

{{% docs/reference %}} [alerting_tf_provisioning]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/set-up/provision-alerting-resources/terraform-provisioning" [alerting_tf_provisioning]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/set-up/provision-alerting-resources/terraform-provisioning"

[alerting_tf_provisioning_template]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/set-up/provision-alerting-resources/terraform-provisioning#import-contact-points-and-templates" [alerting_tf_provisioning_template]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/set-up/provision-alerting-resources/terraform-provisioning#import-contact-points-and-templates"

[alerting_http_provisioning]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/set-up/provision-alerting-resources/http-api-provisioning" [alerting_http_provisioning]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/set-up/provision-alerting-resources/http-api-provisioning"

[alerting_file_provisioning]: "/docs/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/set-up/provision-alerting-resources/file-provisioning"

[alerting_file_provisioning_template]: "/docs/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/set-up/provision-alerting-resources/file-provisioning#import-templates"

[export_rule]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/set-up/provision-alerting-resources/http-api-provisioning/#span-idroute-get-alert-rule-exportspan-export-an-alert-rule-in-provisioning-file-format-routegetalertruleexport" [export_rule]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/set-up/provision-alerting-resources/http-api-provisioning/#span-idroute-get-alert-rule-exportspan-export-an-alert-rule-in-provisioning-file-format-routegetalertruleexport"

[export_rule_group]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/set-up/provision-alerting-resources/http-api-provisioning/#span-idroute-get-alert-rule-group-exportspan-export-an-alert-rule-group-in-provisioning-file-format-routegetalertrulegroupexport" [export_rule_group]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/set-up/provision-alerting-resources/http-api-provisioning/#span-idroute-get-alert-rule-group-exportspan-export-an-alert-rule-group-in-provisioning-file-format-routegetalertrulegroupexport"

[export_rules]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/set-up/provision-alerting-resources/http-api-provisioning/#span-idroute-get-alert-rules-exportspan-export-all-alert-rules-in-provisioning-file-format-routegetalertrulesexport" [export_rules]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/set-up/provision-alerting-resources/http-api-provisioning/#span-idroute-get-alert-rules-exportspan-export-all-alert-rules-in-provisioning-file-format-routegetalertrulesexport"

[export_contacts]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/set-up/provision-alerting-resources/http-api-provisioning/#span-idroute-get-contactpoints-exportspan-export-all-contact-points-in-provisioning-file-format-routegetcontactpointsexport" [export_contacts]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/set-up/provision-alerting-resources/http-api-provisioning/#span-idroute-get-contactpoints-exportspan-export-all-contact-points-in-provisioning-file-format-routegetcontactpointsexport"

[export_notifications]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/set-up/provision-alerting-resources/http-api-provisioning/#span-idroute-get-policy-tree-exportspan-export-the-notification-policy-tree-in-provisioning-file-format-routegetpolicytreeexport" [export_notifications]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/set-up/provision-alerting-resources/http-api-provisioning/#span-idroute-get-policy-tree-exportspan-export-the-notification-policy-tree-in-provisioning-file-format-routegetpolicytreeexport" {{% /docs/reference %}}