Logging und Monitoring für Anwendungen

Auf dieser Seite wird gezeigt, wie Sie einen Nutzercluster für Google Distributed Cloud konfigurieren, damit benutzerdefinierte Logs und Messwerte aus Nutzeranwendungen an Cloud Logging und Cloud Monitoring gesendet werden. Die Messwerte aus Nutzeranwendungen werden mit Google Cloud Managed Service for Prometheus erfasst.

Managed Service for Prometheus für Nutzeranwendungen aktivieren

Die Konfiguration für Managed Service for Prometheus wird in einem Stackdriver-Objekt namens stackdriver gespeichert.

1. Öffnen Sie das Objekt stackdriver zum Bearbeiten:

   kubectl --kubeconfig=USER_CLUSTER_KUBECONFIG --namespace kube-system edit stackdriver stackdriver
   

   Ersetzen Sie USER_CLUSTER_KUBECONFIG durch den Pfad der kubeconfig-Datei des Nutzerclusters.

2. Legen Sie unter spec den Wert enableGMPForApplications auf true fest:

     apiVersion: addons.gke.io/v1alpha1
     kind: Stackdriver
     metadata:
       name: stackdriver
       namespace: kube-system
     spec:
       projectID: ...
       clusterName: ...
       clusterLocation: ...
       proxyConfigSecretName: ...
       enableGMPForApplications: true
       enableVPC: ...
       optimizedMetrics: true
   

3. Schließen Sie die bearbeitete Datei. Dadurch werden von Google verwaltete Prometheus-Komponenten (GMP) im Cluster ausgeführt.

4. Prüfen Sie die Komponenten mit dem folgenden Befehl:

   kubectl --kubeconfig=USER_CLUSTER_KUBECONFIG --namespace gmp-system get pods
   

   Die Ausgabe dieses Befehls sieht wie folgt aus:

    NAME                                 READY   STATUS    RESTARTS        AGE
    collector-abcde                      2/2     Running   1 (5d18h ago)   5d18h
    collector-fghij                      2/2     Running   1 (5d18h ago)   5d18h
    collector-klmno                      2/2     Running   1 (5d18h ago)   5d18h
    gmp-operator-68d49656fc-abcde        1/1     Running   0               5d18h
    rule-evaluator-7c686485fc-fghij      2/2     Running   1 (5d18h ago)   5d18h
   

Managed Service for Prometheus unterstützt die Regelauswertung und Benachrichtigungen. Informationen zum Einrichten der Regelauswertung finden Sie unter Regelauswertung.

Beispielanwendung ausführen

In diesem Abschnitt erstellen Sie eine Anwendung, die Prometheus-Messwerte ausgibt, und verwenden von Google verwaltete Prometheus, um die Messwerte zu erfassen. Weitere Informationen finden Sie unter Google Cloud Managed Service for Prometheus.

Beispielanwendung bereitstellen

1. Erstellen Sie den Namespace gmp-test für Ressourcen, die Sie als Teil der Beispielanwendung erstellen:

   kubectl --kubeconfig=USER_CLUSTER_KUBECONFIG create ns gmp-test
   

2. Der verwaltete Dienst stellt ein Manifest für eine Beispielanwendung bereit, die Prometheus-Messwerte am metrics-Port ausgibt. Die Anwendung verwendet drei Replikate.

   Führen Sie den folgenden Befehl aus, um die Beispielanwendung bereitzustellen:

   kubectl --kubeconfig USER_CLUSTER_KUBECONFIG -n gmp-test apply -f https://raw.githubusercontent.com/GoogleCloudPlatform/prometheus-engine/v0.4.1/examples/example-app.yaml
   

PodMonitoring-Ressource konfigurieren

Zur Aufnahme der von der Beispielanwendung ausgegebenen Messwertdaten verwenden Sie Ziel-Scraping. Der verwaltete Dienst verwendet zum Konfigurieren von Ziel-Extraktion und Messwert-Aufnahme benutzerdefinierte PodMonitoring. Sie können Ihre vorhandenen Prometheus-Operator-Ressourcen in PodMonitoring-CRs konvertieren.

Eine PodMonitoring-CR scrapt Ziele nur in dem Namespace, in dem die CR bereitgestellt wird. Wenn Sie Ziele in mehreren Namespaces scrapen möchten, stellen Sie in jedem Namespace dieselbe PodMonitoring-CR bereit. Mit dem folgenden Befehl können Sie prüfen, ob die PodMonitoring-Ressource im gewünschten Namespace installiert ist:

 kubectl --kubeconfig USER_CLUSTER_KUBECONFIG get podmonitoring -A

Eine Referenzdokumentation zu allen CRs für Managed Service for Prometheus finden Sie in der Referenz zu prometheus-engine/doc/api.

Das folgende Manifest definiert die PodMonitoring-Ressource prom-example im Namespace gmp-test. Die Ressource findet alle Pods im Namespace mit dem Label app mit dem Wert prom-example. Die übereinstimmenden Pods werden an einem Port mit dem Namen metrics alle 30 Sekunden über den /metrics-HTTP-Pfad extrahiert.

apiVersion: monitoring.googleapis.com/v1
kind: PodMonitoring
metadata:
  name: prom-example
spec:
  selector:
    matchLabels:
      app: prom-example
  endpoints:
  - port: metrics
    interval: 30s

Führen Sie folgenden Befehl aus, um diese Ressource anzuwenden:

kubectl --kubeconfig USER_CLUSTER_KUBECONFIG -n gmp-test apply -f https://raw.githubusercontent.com/GoogleCloudPlatform/prometheus-engine/v0.4.1/examples/pod-monitoring.yaml

Managed Service for Prometheus extrahiert jetzt übereinstimmende Pods.

Messwertdaten abfragen

Am einfachsten können Sie prüfen, ob Ihre Prometheus-Daten exportiert werden, indem Sie PromQL-Abfragen im Metrics Explorer in der Google Cloud Console verwenden.

So führen Sie eine PromQL-Abfrage aus:

1. Rufen Sie in der Google Cloud Console die Seite Monitoring auf oder klicken Sie auf die folgende Schaltfläche:

   Zu Monitoring

2. Wählen Sie im Navigationsbereich Metrics Explorer aus.

3. Verwenden Sie die Prometheus-Abfragesprache (PromQL), um die Daten anzugeben, die im Diagramm angezeigt werden sollen:

   1. Wählen Sie in der Symbolleiste des Bereichs Messwert auswählen die Option Code-Editor aus.

   2. Wählen Sie im Menü PromQL die Ein/Aus-Schaltfläche PromQL aus. Die Sprachschaltfläche befindet sich unten im Bereich Code-Editor.

   3. Geben Sie eine Abfrage in den Abfrageeditor ein. Wenn Sie beispielsweise die durchschnittliche Anzahl der Sekunden, die die CPUs in den einzelnen Modi in der letzten Stunde verbracht haben, grafisch darstellen möchten, verwenden Sie die folgende Abfrage:

      avg(rate(kubernetes_io:anthos_container_cpu_usage_seconds_total
      {monitored_resource="k8s_node"}[1h]))
      

   Weitere Informationen zur Verwendung von PromQL finden Sie unter PromQL in Cloud Monitoring.

Der folgende Screenshot zeigt ein Diagramm mit dem Messwert anthos_container_cpu_usage_seconds_total:

Wenn Sie viele Daten erfassen, können Sie exportierte Messwerte filtern, um die Kosten niedrig zu halten.

Cloud Logging für Nutzeranwendungen aktivieren

Die Konfiguration für Logging wird in einem Stackdriver-Objekt namens Stackdriver gespeichert.

1. Öffnen Sie das Objekt stackdriver zum Bearbeiten:

   kubectl --kubeconfig=USER_CLUSTER_KUBECONFIG --namespace kube-system edit stackdriver stackdriver
   

   Ersetzen Sie USER_CLUSTER_KUBECONFIG durch den Pfad der kubeconfig-Datei des Nutzerclusters.

2. Legen Sie unter spec den Wert enableCloudLoggingForApplications auf true fest:

     apiVersion: addons.gke.io/v1alpha1
     kind: Stackdriver
     metadata:
       name: stackdriver
       namespace: kube-system
     spec:
       projectID: ...
       clusterName: ...
       clusterLocation: ...
       proxyConfigSecretName: ...
       enableCloudLoggingForApplications: true
       enableVPC: ...
       optimizedMetrics: true
   

3. Schließen Sie die bearbeitete Datei.

Beispielanwendung ausführen

In diesem Abschnitt erstellen Sie eine Anwendung, die benutzerdefinierte Logs schreibt.

1. Speichern Sie das folgende Deployment-Manifest in eine Datei mit dem Namen my-app.yaml.

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: "monitoring-example"
     namespace: "default"
     labels:
       app: "monitoring-example"
   spec:
     replicas: 1
     selector:
       matchLabels:
         app: "monitoring-example"
     template:
       metadata:
         labels:
           app: "monitoring-example"
       spec:
         containers:
         - image: gcr.io/google-samples/prometheus-dummy-exporter:latest
           name: prometheus-example-exporter
           imagePullPolicy: Always
           command:
           - /bin/sh
           - -c
           - ./prometheus-dummy-exporter --metric-name=example_monitoring_up --metric-value=1 --port=9090
           resources:
             requests:
               cpu: 100m
   

2. Erstellen Sie das Deployment:

   kubectl --kubeconfig USER_CLUSTER_KUBECONFIG apply -f my-app.yaml
   

Anwendungslogs ansehen

Anwendungslogs filtern

Das Filtern von Anwendungslogs kann die Abrechnung von Anwendungs-Logging und den Netzwerktraffic vom Cluster zu Cloud Logging reduzieren. Ab Google Distributed Cloud-Release 1.15.0 können Sie Anwendungslogs nach den folgenden Kriterien filtern, wenn enableCloudLoggingForApplications auf true gesetzt ist:

• Pod-Labels (podLabelSelectors)
• Namespaces (namespaces)
• Reguläre Ausdrücke für Loginhalte (contentRegexes)

Google Distributed Cloud sendet nur die Filterergebnisse an Cloud Logging.

Filter für Anwendungslogs definieren

Die Konfiguration für Logging wird in einem Stackdriver-Objekt namens stackdriver angegeben.

1. Öffnen Sie das Objekt stackdriver zum Bearbeiten:

   kubectl --kubeconfig USER_CLUSTER_KUBECONFIG --namespace kube-system \
       edit stackdriver stackdriver
   

   Ersetzen Sie USER_CLUSTER_KUBECONFIG durch den Pfad der kubeconfig-Datei des Nutzerclusters.

2. Fügen Sie der spec einen appLogFilter-Abschnitt hinzu:

     apiVersion: addons.gke.io/v1alpha1
     kind: Stackdriver
     metadata:
       name: stackdriver
       namespace: kube-system
     spec:
       enableCloudLoggingForApplications: true
       projectID: ...
       clusterName: ...
       clusterLocation: ...
       appLogFilter:
         keepLogRules:
         - namespaces:
           - prod
           ruleName: include-prod-logs
         dropLogRules:
         - podLabelSelectors:
           - disableGCPLogging=yes
           ruleName: drop-logs
   

3. Speichern und schließen Sie die bearbeitete Datei.

4. Optional: Wenn Sie podLabelSelectors verwenden, starten Sie das stackdriver-log-forwarder-DaemonSet neu, damit Ihre Änderungen so schnell wie möglich wirksam werden:

   kubectl --kubeconfig USER_CLUSTER_KUBECONFIG --namespace kube-system \
       rollout restart daemonset stackdriver-log-forwarder
   

   Normalerweise sind podLabelSelectors nach 10 Minuten wirksam. Wenn Sie das DaemonSet stackdriver-log-forwarder neu starten, werden die Änderungen schneller wirksam.

Beispiel: ERROR- oder WARN-Logs nur in prod-Namespace einschließen

Das folgende Beispiel zeigt, wie ein Anwendungslogfilter funktioniert. Sie definieren einen Filter, der einen Namespace (prod), einen regulären Ausdruck (.*(ERROR|WARN).*) und ein Pod-Label (disableGCPLogging=yes) verwendet. Um zu prüfen, ob der Filter funktioniert, führen Sie dann einen Pod im Namespace prod aus, um diese Filterbedingungen zu testen.

So definieren und testen Sie einen Anwendungslogfilter:

1. Geben Sie im Stackdriver-Objekt einen Anwendungslogfilter an:

   Im folgenden appLogFilter-Beispiel werden nur ERROR- oder WARN-Logs im prod-Namespace beibehalten. Alle Logs für Pods mit dem Label disableGCPLogging=yes wurden verworfen:

   apiVersion: addons.gke.io/v1alpha1
   kind: Stackdriver
   metadata:
     name: stackdriver
     namespace: kube-system
   spec:
     ...
     appLogFilter:
       keepLogRules:
       - namespaces:
         - prod
         contentRegexes:
         - ".*(ERROR|WARN).*"
         ruleName: include-prod-logs
       dropLogRules:
       - podLabelSelectors:
         - disableGCPLogging=yes # kubectl label pods pod disableGCPLogging=yes
         ruleName: drop-logs
   ...
   

2. Pod im Namespace prod bereitstellen und ein Script ausführen, das ERROR und INFO-Logeinträge generiert:

   kubectl --kubeconfig USER_CLUSTER_KUBECONFIG run pod1 \
       --image gcr.io/cloud-marketplace-containers/google/debian10:latest \
       --namespace prod --restart Never --command -- \
       /bin/sh -c "while true; do echo 'ERROR is 404\\nINFO is not 404' && sleep 1; done"
   

   Die gefilterten Logs sollten nur die ERROR-Einträge enthalten, nicht die INFO-Einträge.

3. Fügen Sie dem Pod das Label disableGCPLogging=yes hinzu:

   kubectl --kubeconfig USER_CLUSTER_KUBECONFIG label pods pod1 \
       --namespace prod disableGCPLogging=yes
   

   Das gefilterte Log sollte keine Einträge mehr für den Pod pod1 enthalten.

API-Definition für Anwendungslogfilter

Die Definition für den Anwendungs-Log-Filter wird in der benutzerdefinierten Ressourcendefinition des Stackdrivers angegeben.

Führen Sie den folgenden Befehl aus, um die benutzerdefinierte Stackdriver-Ressourcendefinition abzurufen:

kubectl --kubeconfig USER_CLUSTER_KUBECONFIG get crd stackdrivers.addons.gke.io \
    --namespace kube-system -o yaml