Diese Seite wurde von der Cloud Translation API übersetzt.

Benachrichtigungsregeln und ‑empfänger aus Prometheus migrieren

Auf dieser Seite wird beschrieben, wie Sie Prometheus-Benachrichtigungsregeln zu Cloud Monitoring-Benachrichtigungsrichtlinien mit einer PromQL-basierten Bedingung migrieren. Der Migrationsprozess ist nützlich, wenn Sie PromQL in Umgebungen außerhalb von Google Cloud verwenden. Wenn Sie Ihre Prometheus-Benachrichtigungsregeln zu Cloud Monitoring migrieren, können Sie alle Benachrichtigungsrichtlinien in einer Umgebung verwalten.

Allgemeine Informationen zu Benachrichtigungsrichtlinien mit PromQL-basierten finden Sie unter Benachrichtigungsrichtlinien mit PromQL.

Sie können auch Grafana-Dashboards importieren. Weitere Informationen finden Sie unter Grafana-Dashboards in Cloud Monitoring importieren

Funktionsweise der Migration

Mit der gcloud CLI können Sie Ihre vorhandenen Benachrichtigungsregeln und ‑empfänger migrieren, um Cloud Monitoring-Benachrichtigungsrichtlinien und ‑kanäle zu erstellen. Mit der gcloud CLI können Sie die folgenden Migrationstypen ausführen:

Wenn Sie eine Prometheus-Konfigurationsdatei bereitstellen mit einer Benachrichtigungsregel erstellen, erstellt die gcloud CLI eine Benachrichtigung Richtlinie mit einer PromQL-basierten Bedingung.

Sie können mehrere Prometheus-Konfigurationsdateien gleichzeitig bereitstellen, Mehrere Benachrichtigungsrichtlinien mit einer PromQL-basierten Bedingung erstellen
Wenn Sie eine Prometheus-Alertmanager-Datei mit mindestens einem Empfänger angeben, wandelt die gcloud CLI jeden Empfänger in einen entsprechenden Benachrichtigungskanal in Monitoring um.

Hinweis :Sie können einen AlertManager-Empfänger nur dann migrieren, wenn Cloud Monitoring unterstützt denselben Benachrichtigungskanaltyp. Beispiel: Cloud Monitoring unterstützt keine Jira-Empfänger, sodass sie nicht migriert werden können aus einem Prometheus AlertManager-Datei. Wenn Sie versuchen, einen inkompatiblen Empfänger zu migrieren, wird er von der gcloud CLI ignoriert. Wenn Sie eine von Cloud Monitoring nicht unterstützter Empfänger, erstellen Sie eine Benachrichtigung Kanal, der Webhook für öffentliche Endpunkte verwendet, oder Pub/Sub für private Endpunkte.
Wenn Sie eine Prometheus Alertmanager-Datei und eine Prometheus-Konfigurationsdatei, erstellt die gcloud CLI die Benachrichtigungsrichtlinie und und verknüpft dann jeden neuen Benachrichtigungskanal mit dem neuen Benachrichtigungsrichtlinie

Wenn Sie mehrere Konfigurationsdateien mit Benachrichtigungsregeln angeben, weist die gcloud CLI jedem Benachrichtigungskanal aus der Alertmanager-Datei jeder neuen Benachrichtigungsrichtlinie zu.

Wenn Ihre Prometheus-Benachrichtigungsregel auf einen benutzerdefinierten Messwert verweist, hat der Gcloud CLI ist zum Erstellen ein entsprechender Messwertdeskriptor erforderlich die Benachrichtigungsrichtlinie.

Prometheus-Konfigurationsdateien und Prometheus Alertmanager-Dateien müssen als gültige Prometheus-Regeldateien formatiert in YAML oder JSON.

Feldzuordnung

Die gcloud CLI ordnet Felder zwischen Prometheus-Benachrichtigungen zu und einer Cloud Monitoring-Benachrichtigungsrichtlinie wie folgt:

Prometheus-Benachrichtigungsregel	Cloud Monitoring-Benachrichtigungsrichtlinie
`alert`	`conditionPrometheusQueryLanguage.alertRule`
`expr`	`conditionPrometheusQueryLanguage.query`
`for`	`conditionPrometheusQueryLanguage.duration`
`labels`	`conditionPrometheusQueryLanguage.labels`
`annotations: "summary"`	`documentation.subject`
`annotations: "description"`	`documentation.content`

Google Cloud-Dokumentationsvariablen in migrierten Prometheus-Benachrichtigungsregeln

Prometheus verwendet Vorlagen für Benachrichtigungen zum Konfigurieren von Variablen in Anmerkungen und Labels für Benachrichtigungsregeln. Wenn Sie Prometheus-Benachrichtigungsregeln mit Vorlagen für Benachrichtigungsfelder migrieren, werden die Vorlagen in Cloud Monitoring wie unten beschrieben in Dokumentationsvariablen konvertiert:

Vorlage für Prometheus-Benachrichtigungsfelder	Variable in der Cloud Monitoring-Dokumentation
`{{$value}}`	`${metric.label.value}` Diese Variable ist eine Implementierung von `${metric.label.KEY}`, wobei `value` enthält den Wert der PromQL-Abfrage.
`{{humanize $value}}`	`${metric.label.value}` Diese Variable ist eine Implementierung von `${metric.label.KEY}`, wobei `value` enthält den Wert der PromQL-Abfrage.
`{{$labels}}`	`${metric_or_resource.labels}`
`{{humanize $labels}}`	`${metric_or_resource.labels}`
`{{$labels.key}}`	Wird in der Dokumentation zur Konfiguration der Benachrichtigungsrichtlinie als `${metric_or_resource.label.KEY}` angezeigt. Wenn `KEY` ein gültiges Label ist, wird diese Variable in der Benachrichtigung als Wert von `${metric.label.KEY}` gerendert. Wenn `KEY` eine gültige Ressource ist, wird diese Variable in der Benachrichtigung als Wert von `${resource.label.KEY}` gerendert. Wenn `KEY` weder ein gültiges Label noch eine gültige Ressource ist, wird diese Variable in der Benachrichtigung als leerer String gerendert.
`{{humanize $labels.<key>}}`	Wird in der Dokumentation zur Konfiguration der Benachrichtigungsrichtlinie als `${metric_or_resource.label.KEY}` angezeigt. Wenn `KEY` ein gültiges Label ist, wird diese Variable in der Benachrichtigung als Wert von `${metric.label.KEY}` gerendert. Wenn `KEY` eine gültige Ressource ist, wird diese Variable in der Benachrichtigung als Wert von `${resource.label.KEY}` gerendert. Wenn `KEY` weder ein gültiges Label noch eine gültige Ressource ist, wird diese Variable in der Benachrichtigung als leerer String gerendert.

Benachrichtigungsregeln und Empfänger von Prometheus migrieren

Verwenden Sie den Befehl gcloud alpha monitoring policies migrate, um Ihre Prometheus-Benachrichtigungsregeln zu Cloud Monitoring-Benachrichtigungsrichtlinien mit PromQL-basierten Bedingungen zu migrieren. Mit diesem Befehl können Sie auch Prometheus-Empfänger zu Cloud Monitoring migrieren Benachrichtigungskanäle.

Zum Migrieren einer Benachrichtigungsregel benötigen Sie eine YAML- oder JSON-Prometheus Regeldatei mit den Benachrichtigungsregel.
Wenn Sie einen Empfänger migrieren möchten, benötigen Sie eine YAML- oder JSON-Prometheus-Alertmanager-Datei, die den Empfänger enthält.

Hinweis: Sie können einen AlertManager-Empfänger nur migrieren, wenn Cloud Monitoring denselben Benachrichtigungskanal unterstützt. Beispiel: Cloud Monitoring unterstützt keine Jira-Empfänger, sodass sie nicht migriert werden können aus einem Prometheus AlertManager-Datei. Wenn Sie versuchen, einen inkompatiblen Empfänger zu migrieren, ignoriert die gcloud CLI den Empfänger. Wenn Sie eine von Cloud Monitoring nicht unterstützter Empfänger, erstellen Sie eine Benachrichtigung Kanal, der Webhook für öffentliche Endpunkte verwendet, oder Pub/Sub für private Endpunkte.

In Google Cloud wird die Migration von Prometheus-Aufzeichnungsregeln nicht unterstützt. Für Aufnahmeregeln empfehlen wir eine selbst bereitgestellten Regelauswerter.

Benachrichtigungsrichtlinie aus einer Prometheus-Konfigurationsdatei erstellen

Führen Sie folgenden Befehl aus, um eine Benachrichtigungsrichtlinie aus einer Prometheus-Konfigurationsdatei zu erstellen: mit dem folgenden Befehl. Sie können mehrere Benachrichtigungsrichtlinien erstellen, indem Sie mehrere Dateipfade angeben:

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

Benachrichtigungskanäle aus einer Prometheus Alertmanager-Konfigurationsdatei erstellen

So erstellen Sie Benachrichtigungskanäle aus einer Prometheus Alertmanager-Konfiguration den folgenden Befehl aus:

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

Benachrichtigungsrichtlinien und -kanäle gleichzeitig erstellen

Wenn Sie Benachrichtigungsrichtlinien aus Prometheus-Konfigurationsdateien und gleichzeitig Benachrichtigungskanäle aus einer Prometheus Alertmanager-Konfigurationsdatei erstellen möchten, führen Sie den folgenden Befehl aus:

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

Beispiel

Sie haben eine Prometheus-Konfigurationsdatei mit einer Benachrichtigungsregel, wenn die CPU-Auslastung eine Minute lang über 75% liegt. Die Benachrichtigungsregel so konfiguriert:

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%"

Außerdem haben Sie eine Prometheus AlertManager-Datei mit E-Mail-, PagerDuty- und Webhook-Empfängern.

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

Führen Sie folgenden Befehl aus, um die Benachrichtigungsrichtlinie und den Benachrichtigungskanal zu erstellen:

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

Die gcloud CLI erstellt dann eine Benachrichtigungsrichtlinie wie im folgenden Beispiel:

  {
  "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"
  ]
}

Benachrichtigungsregeln aus Managed Service for Prometheus migrieren

Google Cloud konfiguriert die verwaltete Regelauswertung für Managed Service for Prometheus mithilfe der benutzerdefinierten Ressourcen Regeln, Clusterregeln und Globale Regeln.

So migrieren Sie diese Ressourcen zu einer Google Cloud-Benachrichtigungsrichtlinie mit einer PromQL-basierten Bedingung:

Kopieren Sie den Abschnitt groups der benutzerdefinierten Ressource in einen neue Prometheus-Regeldatei.
Migrieren Sie die Regeldatei mithilfe der gcloud CLI.

Angenommen, Sie haben die folgende benutzerdefinierte Ressource für Regeln:

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

Die Prometheus-Regeldatei, die durch Kopieren von groups aus den vorherigen Regeln erstellt wurde würde so aussehen:

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

Mehrere benutzerdefinierte Ressourcen für Regeln migrieren

Wenn Sie mehrere Regeln, benutzerdefinierte Regeln oder globale Regeln migrieren möchten, empfehlen wir, für jede Ressource eine separate Regeldatei zu erstellen und zu migrieren. Weitere Informationen finden Sie in der Prometheus-Dokumentation

Filter- und Aggregationsausdrücke verwalten

Regeln und Clusterregeln filtern ihre Prometheus-Benachrichtigungsausdrücke automatisch anhand bestimmter Labels. Wenn Sie dieses Verhalten bei der Abfrage einer migrierten Benachrichtigungsrichtlinie beibehalten möchten, müssen Sie diese Labels vor der Migration der Datei explizit in einen Filter- oder Aggregationsausdruck in Ihrer Prometheus-Regelndatei aufnehmen.

Beispiel: Evaluator verwalteter Regeln für Managed Service for Prometheus führt den Ausdruck sum(up) < 10 so aus:

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

Enthält eine Benachrichtigungsrichtlinie jedoch die PromQL-Abfrage sum(up) < 10: Cloud Monitoring führt die Abfrage nur so aus, sum(up) < 10 Diese Abfrage wird auf alle Google Cloud-Projekte, Cluster und Namespace in Ihrem Messwertbereich. Um dies zu verhindern, Sie können in der Abfrage nach Labels aggregieren, um sicherzustellen, dass Cloud Monitoring wie beabsichtigt. Wenn Sie beispielsweise Ihre Regeldatei aus der Benutzerdefinierte Ressource von Regeln, können Sie sum(up) < 10 folgendermaßen ändern: Ausdruck:

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

Der vorherige Ausdruck generiert eine separate Zeitreihe für jede Google Cloud-Projekt, -Cluster und -Namespace und vergleicht dann jede Zeitachse mit der Benachrichtigungsgrenzwert von <10.

In der folgenden Tabelle ist die Reihenfolge der Auswertung von Benachrichtigungsausdruckfiltern für Regeln und Clusterregeln aufgeführt:

Ressourcentyp der Regel	Filterlabels
Regel	`project_id` `cluster` `namespace`
ClusterRule	`project_id` `cluster`

Weitere Informationen zum Filterverhalten in Prometheus-Ausdrücken Weitere Informationen finden Sie unter Sofortige Vektorauswahl.