Argo Workflows

In diesem Dokument wird beschrieben, wie Sie eine Google Kubernetes Engine-Bereitstellung so konfigurieren, dass Sie Google Cloud Managed Service for Prometheus verwenden können, um Messwerte über Workflows Controller zu erfassen. Dieses Dokument enthält Anleitungen für folgende Aufgaben:

Workflows Controller zum Melden von Messwerten einrichten
Eine PodMonitoring-Ressource für Managed Service for Prometheus konfigurieren, um die exportierten Messwerte zu erfassen.
Auf ein Dashboard in Cloud Monitoring zugreifen, um die Messwerte zu prüfen.
Benachrichtigungsregeln konfigurieren, um die Messwerte zu beobachten.

Diese Anleitung gilt nur, wenn Sie die verwaltete Sammlung mit Managed Service for Prometheus verwenden. Wenn Sie eine selbst bereitgestellte Sammlung verwenden, finden Sie Informationen zur Installation in der Workflows-Dokumentation.

Diese Anleitung dient als Beispiel und sollte in den meisten Kubernetes-Umgebungen funktionieren. Wenn Sie aufgrund von restriktiven Sicherheits- oder Organisationsrichtlinien Probleme beim Installieren einer Anwendung oder eines Exporters haben, empfehlen wir Ihnen, die Open Source-Dokumentation für Support zu nutzen.

Informationen zu Workflows finden Sie unter Argo Workflows.

Vorbereitung

Zum Erfassen von Messwerten aus Workflows Controller mithilfe von Managed Service for Prometheus und einer verwalteten Erfassung muss Ihr Deployment die folgenden Anforderungen erfüllen:

Ihr Cluster muss Google Kubernetes Engine Version 1.21.4-gke.300 oder höher ausführen.
Sie müssen Managed Service for Prometheus mit aktivierter verwalteter Sammlung ausführen. Weitere Informationen finden Sie unter Erste Schritte mit verwalteter Sammlung.
Um die in Cloud Monitoring verfügbaren Dashboards für die Workflows-Integration zu nutzen, müssen Sie argo-workflows Version 3.4.3 oder höher verwenden.
Weitere Informationen zu verfügbaren Dashboards finden Sie unter Dashboards ansehen.

Workflows stellt automatisch Messwerte im Prometheus-Format bereit. Sie müssen es nicht separat installieren. So prüfen Sie, ob der Workflows Controller Messwerte an den erwarteten Endpunkten ausgibt:

Richten Sie mit dem folgenden Befehl die Portweiterleitung ein:
```
kubectl -n NAMESPACE_NAME port-forward POD_NAME 9090
```
Greifen Sie über den Browser oder das Dienstprogramm curl in einer anderen Terminalsitzung auf den Endpunkt localhost:9090/metrics zu.

PodMonitoring-Ressource definieren

Für die Zielerkennung benötigt der Managed Service for Prometheus-Operator eine PodMonitoring-Ressource, die dem Workflows-Exporter im selben Namespace entspricht.

Sie können die folgende PodMonitoring-Konfiguration verwenden:

# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: monitoring.googleapis.com/v1
kind: PodMonitoring
metadata:
  name: argo-workflows-controller
  labels:
    app.kubernetes.io/name: argo-workflows-controller
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: 9090
    scheme: http
    interval: 30s
    path: /metrics
  selector:
    matchLabels:
      app: workflow-controller

Die Werte der Felder port und matchLabels müssen mit den Werten der Workflows-Pods übereinstimmen, die Sie beobachten möchten. Standardmäßig stellt Workflows Messwerte auf Port 9090 bereit und enthält das Label app: workflow-controller.

Führen Sie den folgenden Befehl aus, um Konfigurationsänderungen aus einer lokalen Datei anzuwenden:

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Sie können Ihre Konfigurationen auch mit Terraform verwalten.

Regeln und Benachrichtigungen definieren

Sie können die folgende Rules-Konfiguration verwenden, um Benachrichtigungen für Workflows-Messwerte zu definieren:

# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: monitoring.googleapis.com/v1
kind: Rules
metadata:
  name: argo-workflows-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: argo-workflows-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: argo-workflows
    interval: 30s
    rules:
    - alert: ArgoWorkflowsWorkflowErrors
      annotations:
        description: |-
          Argo Workflows workflow errors
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Argo Workflows workflow errors (instance {{ $labels.instance }})
      expr: argo_workflows_error_count > 0
      for: 5m
      labels:
        severity: critical

Führen Sie den folgenden Befehl aus, um Konfigurationsänderungen aus einer lokalen Datei anzuwenden:

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Sie können Ihre Konfigurationen auch mit Terraform verwalten.

Weitere Informationen zum Anwenden von Regeln auf Ihren Cluster finden Sie unter Verwaltete Regelauswertung und Benachrichtigungen.

Sie können die Schwellenwerte für Benachrichtigungen an Ihre Anwendung anpassen.

Konfiguration prüfen

Mit dem Metrics Explorer können Sie prüfen, ob der Workflows-Exporter richtig konfiguriert ist. Es kann ein oder zwei Minuten dauern, bis Cloud Monitoring Ihre Messwerte aufgenommen hat.

So prüfen Sie, ob die Messwerte aufgenommen wurden:

Wählen Sie im Navigationsbereich der Google Cloud Console Monitoring und anschließend Metrics Explorer aus:
Zum Metrics Explorer
Klicken Sie in der Symbolleiste des Bereichs "Query Builder" auf die Schaltfläche MQL oder PromQL.
Prüfen Sie, ob PromQL in der Ein-/Aus-Schaltfläche Sprache ausgewählt ist. Die Sprachschaltfläche befindet sich in derselben Symbolleiste, mit der Sie Ihre Abfrage formatieren können.

Geben Sie die folgende Abfrage ein und führen Sie sie aus:

up{job="argo-workflows-controller", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

Dashboards ansehen

Die Cloud Monitoring-Integration beinhaltet das Dashboard Workflows Prometheus – Übersicht. Dashboards werden automatisch mitkonfiguriert, wenn Sie die Integration konfigurieren. Sie können auch eine statische Vorschau von Dashboards aufrufen, ohne die Integration zu installieren.

So rufen Sie ein installiertes Dashboard auf:

Wählen Sie im Navigationsbereich der Google Cloud Console Monitoring und anschließend Dashboards aus:
Dashboards aufrufen
Wählen Sie den Tab Dashboard-Liste aus.
Wählen Sie die Kategorie Integrationen aus.
Klicken Sie auf den Namen des Dashboards, z. B. Workflows Prometheus – Übersicht.

So rufen Sie eine statische Vorschau des Dashboards auf:

Wählen Sie im Navigationsbereich der Google Cloud Console Monitoring und anschließend Integrationen aus:
Zu „Integrationen“
Klicken Sie auf den Filter für die Deployment-Plattform Kubernetes Engine.
Suchen Sie die Integration von Argo Workflows und klicken Sie auf Details ansehen.
Wählen Sie den Tab Dashboards aus.

Fehlerbehebung

Informationen zur Fehlerbehebung bei Problemen mit der Messwertaufnahme finden Sie unter Probleme mit der Erfassung über Exporter unter Fehlerbehebung bei Problemen mit der Aufnahme.