Apache ZooKeeper

In diesem Dokument wird gezeigt, wie Sie Ihr Google Kubernetes Engine-Deployment so konfigurieren, dass Sie mit Google Cloud Managed Service for Prometheus Messwerte vom Zookeeper-Exporter erfassen können. Dieses Dokument enthält Anleitungen für folgende Aufgaben:

• Richten Sie den Zookeeper-Exporter ein, um Messwerte zu erfassen.
• 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 Zookeeper-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 Zookeeper erhalten Sie unter Zookeeper.

Vorbereitung

Zum Erfassen von Messwerten vom Zookeeper-Exporter mit Managed Service for Prometheus und der verwalteten Sammlung 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 ZooKeeper-Integration zu nutzen, müssen Sie zookeeper Version 3.8.0 oder höher verwenden.

  Weitere Informationen zu verfügbaren Dashboards finden Sie unter Dashboards ansehen.

Zookeeper-Konfiguration ändern

Ändern Sie die Zookeeper-Konfiguration wie im folgenden Beispiel:

# Copyright 2022 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: apps/v1
kind: Deployment
metadata:
  name: zookeeper
spec:
  selector:
    matchLabels:
+     app.kubernetes.io/name: zookeeper
  template:
    metadata:
      labels:
+       app.kubernetes.io/name: zookeeper
    spec:
      containers:
      - name: zookeeper
        image: zookeeper:3.8.0
+       env:
+       - name: ZOO_CFG_EXTRA
+         value: "metricsProvider.className=org.apache.zookeeper.metrics.prometheus.PrometheusMetricsProvider metricsProvider.httpPort=7000 metricsProvider.exportJvmInfo=true"
+       ports:
+       - containerPort: 7000
+         name: prometheus

Sie müssen Ihrer Konfiguration alle Zeilen hinzufügen, denen das Symbol + vorangestellt ist.

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.

Zookeeper stellt Messwerte im Prometheus-Format automatisch bereit, wenn er für die Verwendung der Umgebungsvariable ZOO_CFG_EXTRA konfiguriert ist. In diesem Beispiel wird Zookeeper so konfiguriert, dass Messwerte im Prometheus-Format an Port 7000 verfügbar gemacht werden.

PodMonitoring-Ressource definieren

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

Sie können die folgende PodMonitoring-Konfiguration verwenden:

# Copyright 2022 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: zookeeper
  labels:
    app.kubernetes.io/name: zookeeper
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: prometheus
    scheme: http
    interval: 30s
    path: /metrics
  selector:
    matchLabels:
      app.kubernetes.io/name: zookeeper

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 Zookeeper-Messwerte zu definieren:

# Copyright 2022 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: zookeeper-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: zookeeper-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: zookeeper
    interval: 30s
    rules:
    - alert: ZooKeeperHighAverageLatency
      annotations:
        description: |-
          ZooKeeper high average latency
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: ZooKeeper high average latency (instance {{ $labels.instance }})
      expr: avg_latency > 100
      for: 5m
      labels:
        severity: warning
    - alert: ZooKeeperHighFsyncDuration
      annotations:
        description: |-
          ZooKeeper high fsync duration
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: ZooKeeper high fsync duration (instance {{ $labels.instance }})
      expr: fsynctime_sum > 100
      for: 5m
      labels:
        severity: warning
    - alert: ZooKeeperLowFreeFileDescriptors
      annotations:
        description: |-
          ZooKeeper high fsync duration
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: ZooKeeper high fsync duration (instance {{ $labels.instance }})
      expr: open_file_descriptor_count >= max_file_descriptor_count - 15
      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 Zookeeper-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:

1. Rufen Sie in der Google Cloud Console die Seite Metrics Explorer auf.

   Zum Metrics Explorer

   Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.

2. Klicken Sie in der Symbolleiste des Bereichs "Query Builder" auf die Schaltfläche  MQL oder  PromQL.
3. 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.
4. Geben Sie die folgende Abfrage ein und führen Sie sie aus:
   

   up{job="zookeeper", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

Dashboards ansehen

Die Cloud Monitoring-Integration beinhaltet das Dashboard ZooKeeper 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:

1. Rufen Sie in der Google Cloud Console die Seite Dashboards auf.

   Dashboards aufrufen

   Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.

2. Wählen Sie den Tab Dashboard-Liste aus.
3. Wählen Sie die Kategorie Integrationen aus.
4. Klicken Sie auf den Namen des Dashboards, z. B. ZooKeeper Prometheus – Übersicht.

So rufen Sie eine statische Vorschau des Dashboards auf:

1. Öffnen Sie in der Google Cloud Console die Seite Einbindungen:

   Zu „Integrationen“

   Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.

2. Klicken Sie auf den Filter für die Deployment-Plattform Kubernetes Engine.
3. Suchen Sie die Apache ZooKeeper-Integration und klicken Sie auf Details ansehen.
4. 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.