Repository files navigation

Terraform module to convertPrometheus Alerting rules toGrafana-managed alert rules

There are plenty of apps (mostly out of CNCF's ecosystem) where the vendor or the community provides monitoring dashboardsand alerts. Dashboards are normally provided as a JSON file which can be loaded into Grafana. Alerts are mostly providedasPrometheus Alerting rules.

There are users who already operate a Grafana instance or use a managed Grafana instance from a cloud provider (GrafanaCloud, Amazon Managed Grafana, Azure Managed Grafana, etc.). Why not using this Grafana instance for thealerting?

The problem is that Grafana's unified alerting uses another format for the alert definition but the concept with labels,annotations (provide description and runbook URLs) is almost identical.This module allows you to reuse thePrometheus Alerting rules and configure them inside Grafana.

module"cert_manager_rules" {source="github.com/mkilchhofer/terraform-grafana-prometheus-alerts"prometheus_alerts_file_path=file("/path/to/alerts/cert-manager.yaml")folder_uid=grafana_folder.test.uiddatasource_uid=grafana_data_source.prometheus.uid}

• Grafana 8.0+ (Unified alerting)

• Defining multiple alerts with the same name is not supported in Grafana

The alerts defined asPrometheus Alerting rules can be overridden without changing the input file.If your Prometheus Alerting rules YAML contains an alertalert: TooManyWriteErrors, you can override it like this:

module"cert_manager_rules" {source="github.com/mkilchhofer/terraform-grafana-prometheus-alerts"prometheus_alerts_file_path=file("/path/to/alerts/cert-manager.yaml")folder_uid=grafana_folder.test.uiddatasource_uid=grafana_data_source.prometheus.uid# Overrides per alertoverrides={"TooManyWriteErrors"= {      alert_threshold=1      is_paused=true      labels= {        mycustomlabel="foobar"# Add an extra label        severity="notify"# Override severity      }    }  }}

Every alert supports the following overrides:

map(object({
    alert_threshold = optional(number)
    exec_err_state  = optional(string)
    expr            = optional(string)
    is_paused       = optional(bool)
    no_data_state   = optional(string)
    labels          = optional(map(string))
    annotations     = optional(map(string))
    for             = optional(string)
  }))

No outputs.