Esegui la migrazione delle regole di avviso e dei destinatari da Prometheus

Questa pagina descrive come eseguire la migrazione delle regole di avviso di Prometheus a Cloud Monitoring criteri di avviso con una condizione basata su PromQL. Il processo di migrazione è utile se utilizzi PromQL in ambienti esterni a Google Cloud. Eseguendo la migrazione le regole di avviso di Prometheus a Cloud Monitoring, puoi gestire tutte i tuoi criteri di avviso in un unico ambiente.

Per informazioni generali sui criteri di avviso con soluzioni basate su PromQL vedi Criteri di avviso con PromQL.

Puoi anche importare le dashboard di Grafana. Per ulteriori informazioni, vedi Importare le dashboard di Grafana in Cloud Monitoring.

Come funziona la migrazione

In gcloud CLI, puoi eseguire la migrazione delle regole di avviso esistenti ricevitori per creare criteri di avviso e canali di notifica di Cloud Monitoring. gcloud CLI può eseguire i seguenti tipi di migrazione:

  • Se fornisci un file di configurazione Prometheus con una regola di avviso, gcloud CLI crea con una condizione basata su PromQL.

    Puoi fornire più file di configurazione Prometheus contemporaneamente per Creare più criteri di avviso con una condizione basata su PromQL.

  • Se fornisci un fornitore Prometheus Gestione avvisi con almeno un ricevitore, gcloud CLI converte a un canale di notifica equivalente in Monitoring.

  • Se fornisci un file Alertmanager Prometheus e un di configurazione di Prometheus, gcloud CLI crea il criterio di avviso e la notifica canali di notifica, dopodiché associa ogni nuovo canale di notifica ai nuovi criterio di avviso.

    Se fornisci più file di configurazione con regole di avviso, gcloud CLI assegna ogni canale di notifica il file Alertmanager a ogni nuovo criterio di avviso.

Se la regola di avviso Prometheus fa riferimento a una metrica personalizzata, gcloud CLI richiede un descrittore della metrica equivalente per creare il criterio di avviso.

I file di configurazione Prometheus e i file Alertmanager Prometheus devono essere formattati come file di regole Prometheus validi in formato YAML o JSON.

Mappatura campi

gcloud CLI mappa i campi tra un avviso Prometheus e un criterio di avviso di Cloud Monitoring come segue:

Regola di avviso di Prometheus Criterio di avviso di Cloud Monitoring
alert conditionPrometheusQueryLanguage.alertRule
expr conditionPrometheusQueryLanguage.query
for conditionPrometheusQueryLanguage.duration
labels conditionPrometheusQueryLanguage.labels
annotations: "summary" documentation.subject
annotations: "description" documentation.content

Variabili della documentazione di Google Cloud nelle regole di avviso di Prometheus migrate

Prometheus utilizza modelli di campi di avviso per configurare le variabili nelle annotazioni e nelle etichette delle regole di avviso. Quando esegui la migrazione delle regole di avviso di Prometheus dotati di modelli di campo di avviso, Cloud Monitoring li converte alle variabili di documentazione di Cloud Monitoring come segue:

Modello di campo di avviso Prometheus Variabile di documentazione di Cloud Monitoring
{{$value}}

${metric.label.value}

Questa variabile è un'implementazione di ${metric.label.KEY}, in cui value contiene il valore della query PromQL.

{{humanize $value}}

${metric.label.value}

Questa variabile è un'implementazione di ${metric.label.KEY}, in cui value contiene il valore della query PromQL.

{{$labels}} ${metric_or_resource.labels}
{{humanize $labels}} ${metric_or_resource.labels}
{{$labels.key}}

Viene visualizzato come ${metric_or_resource.label.KEY} nella configurazione della documentazione criterio di avviso.

  • Se KEY è un'etichetta valida, questa variabile viene visualizzata nella notifica come valore di ${metric.label.KEY}.
  • Se KEY è una risorsa valida, questa variabile viene visualizzata nella notifica come valore di ${resource.label.KEY}.
  • Se KEY non è né un'etichetta valida né una risorsa valida, questa variabile viene visualizzata nella notifica come stringa vuota.
{{humanize $labels.<key>}}

Viene visualizzato come ${metric_or_resource.label.KEY} nella configurazione della documentazione criterio di avviso.

  • Se KEY è un'etichetta valida, questa variabile viene visualizzata nella notifica come valore di ${metric.label.KEY}.
  • Se KEY è una risorsa valida, questa variabile viene visualizzata nella notifica come valore di ${resource.label.KEY}.
  • Se KEY non è né un'etichetta valida né una risorsa valida, questa variabile viene visualizzata nella notifica come stringa vuota.

Esegui la migrazione delle regole di avviso e dei destinatari da Prometheus

Per eseguire la migrazione delle regole di avviso Prometheus ai criteri di avviso di Cloud Monitoring con condizioni basate su PromQL, utilizza Comando gcloud alpha monitoring policies migrate. Questo comando consente anche eseguire la migrazione dei ricevitori Prometheus a Cloud Monitoring canali di notifica.

  • Per eseguire la migrazione di una regola di avviso, devi disporre di un file Prometheus YAML o JSON file di regola che contiene regola di avviso.
  • Per eseguire la migrazione di un ricevitore, devi avere un file Prometheus YAML o JSON Alertmanager al suo interno destinatario.

Google Cloud non supporta la migrazione di Prometheus regole di registrazione. Per usare le regole di registrazione, ti consigliamo di usare un valutatore delle regole con deployment autonomo.

Crea un criterio di avviso da un file di configurazione Prometheus

Per creare un criterio di avviso da un file di configurazione Prometheus, esegui il comando seguente. Puoi creare più criteri di avviso fornendo più percorsi di file:

gcloud alpha monitoring policies migrate \
--policies-from-prometheus-alert-rules-yaml=PATH_TO_FILE_1,PATH_TO_FILE_2

Creare canali di notifica da un file di configurazione di Prometheus Alertmanager

Per creare canali di notifica da una configurazione di Prometheus Alertmanager esegui questo comando:

gcloud alpha monitoring policies migrate \
--channels-from-prometheus-alertmanager-yaml=PATH_TO_FILE

Creare contemporaneamente criteri di avviso e canali di notifica

Per creare criteri di avviso dai file di configurazione Prometheus e crea canali di notifica da una configurazione Prometheus Alertmanager esegui questo comando:

gcloud alpha monitoring policies migrate \
--policies-from-prometheus-alert-rules-yaml=PATH_TO_FILE_1,PATH_TO_FILE_2 \
--channels-from-prometheus-alertmanager-yaml=PATH_TO_FILE

Esempio

Hai un file di configurazione Prometheus con una regola di avviso che invia un avviso quando l'utilizzo della CPU rimane superiore al 75% per un minuto. La La regola di avviso è configurata come segue:

groups:
- name: Utilization_Alerts
  interval: 30s
  rules:
  - alert: CPU_Utilization_Over_75
    expr: compute_googleapis_com:instance_cpu_utilization > 75
    for: 60s
    labels:
      severity: page
    annotations:
      subject: "Subject: ${metric.label.value}"
      description: "CPU utilization is over 75%"

Hai anche un file AlertManager Prometheus che contiene email, PagerDuty e ricevitori webhook.

receivers:
- name: 'team-emails'
  email_configs:
  - to: EMAIL_ADDRESS
- name: 'team-pager'
  pagerduty_configs:
  - service_key: SERVICE_KEY
- name: 'team-webhook'
  webhook_configs:
  - url: WEBHOOK_ADDRESS

Per creare il criterio di avviso e il canale di notifica, esegui questo comando :

gcloud alpha monitoring policies migrate \
--policies-from-prometheus-alert-rules-yaml=PATH_TO_CONFIG_FILE \
--channels-from-prometheus-alertmanager-yaml=PATH_TO_ALERTMANAGER_FILE

gcloud CLI crea quindi un criterio di avviso come nell'esempio seguente:

  {
  "name": "projects/PROJECT_ID/alertPolicies/POLICY_ID",
  "displayName": "Utilization_Alerts/CPU_Utilization_Over_75",
  "documentation": {
    "content": "CPU utilization is over 75%",
    "mimeType": "text/markdown",
    "subject": "Subject: ${metric.label.value}"
  },
  "userLabels": {},
  "conditions": [
    {
      "name": "projects/PROJECT_ID/alertPolicies/POLICY_ID/conditions/CONDITION_ID",
      "displayName": "CPU_Utilization_Over_75"
      "conditionPrometheusQueryLanguage": {
        "alertRule": "CPU_Utilization_Over_75",
        "duration": "60s",
        "evaluationInterval": "30s",
        "labels": {
          "severity": "page"
        },
        "query": "compute_googleapis_com:instance_cpu_utilization > 75",
        "ruleGroup": "Utilization_Alerts"
      }
    }
  ],
  "alertStrategy": {},
  "combiner": "OR",
  "enabled": true,
  "notificationChannels": [
    "projects/google.com:PROJECT_ID/notificationChannels/CHANNEL_ID_1",
    "projects/google.com:PROJECT_ID/notificationChannels/CHANNEL_ID_2",
    "projects/google.com:PROJECT_ID/notificationChannels/CHANNEL_ID_3"
  ]
}

Esegui la migrazione delle regole di avviso da Managed Service per Prometheus

Google Cloud configura valutazione delle regole gestite per Managed Service for Prometheus utilizzando le regole, ClusterRules e Risorse personalizzate di GlobalRules.

Per eseguire la migrazione di queste risorse a un criterio di avviso di Google Cloud con un Condizione basata su PromQL:

  1. Copia la sezione groups della risorsa personalizzata in un nuovo file di regole Prometheus.

  2. Esegui la migrazione del file delle regole utilizzando gcloud CLI.

Ad esempio, hai la seguente risorsa personalizzata di regole:

apiVersion: monitoring.googleapis.com/v1
kind: Rules
metadata:
  namespace: NAMESPACE_NAME
  name: example-rules
spec:
  groups:
  - name: example
    interval: 30s
    rules:
    - alert: FewerThanTenInstancesUp
      expr: sum(up) < 10

Il file delle regole di Prometheus creato copiando groups dalle regole precedenti la risorsa personalizzata avrà il seguente aspetto:

  groups:
  - name: example
    interval: 30s
    rules:
    - alert: FewerThanTenInstancesUp
      expr: sum(up) < 10

Esegui la migrazione di più risorse personalizzate delle regole

Per eseguire la migrazione di più regole, regole personalizzate o regole globali, consigliamo di creare e migrare un file di regole separato per ogni risorsa. Per ulteriori informazioni, consulta Documentazione di Prometheus.

Gestire espressioni di filtro e aggregazione

Le regole e ClusterRules filtrano automaticamente l'avviso di Prometheus basate su determinate etichette. Per preservare questo comportamento nella query di un di criterio di avviso, devi includere esplicitamente queste etichette in un filtro o l'espressione di aggregazione delle regole di Prometheus prima di eseguire la migrazione del file.

Ad esempio: lo strumento di valutazione delle regole gestite per Managed Service for Prometheus esegue l'espressione sum(up) < 10 nel seguente modo:

sum(up{project_id="test-project", cluster="test-cluster", namespace="NAMESPACE_NAME"}) < 10

Tuttavia, se un criterio di avviso include la query PromQL, sum(up) < 10, Cloud Monitoring esegue la query sum(up) < 10. Questa query viene applicata a ogni progetto, cluster o progetto Google Cloud e spazio dei nomi nell'ambito delle metriche. Per evitare questo comportamento, ti consigliamo l'aggregazione per etichette nella query per garantire che Cloud Monitoring esegua la query come previsto. Ad esempio, quando crei il file delle regole dal Risorsa personalizzata delle regole, puoi modificare sum(up) < 10 come segue :

sum (up) by (project_id, cluster, namespace) < 10

L'espressione precedente genera una serie temporale separata per ogni progetto, cluster e spazio dei nomi Google Cloud, quindi confronta ogni serie temporale con la soglia di avviso di <10.

La tabella seguente mostra l'ordine di valutazione dei filtri di espressione di avviso per le regole e ClusterRules:

Tipo di risorsa regola Filtra etichette
Regola
  1. project_id
  2. cluster
  3. namespace
ClusterRule
  1. project_id
  2. cluster

Per ulteriori informazioni sul comportamento di filtro nelle espressioni Prometheus, consulta Selettori di vettori istantanei.