Aerospike

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

• Exporter für Aerospike einrichten, 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 im Quell-Repository Installationsinformationen für den Aerospike-Exporter.

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 Aerospike finden Sie unter Aerospike.

Vorbereitung

Zum Erfassen von Messwerten aus Aerospike mithilfe von Managed Service for Prometheus und einer verwalteten Erfassung muss Ihre Bereitstellung 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 Aerospike-Integration zu nutzen, müssen Sie aerospike-prometheus-exporter Version 1.8.0 oder höher verwenden.

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

Aerospike-Exporter installieren

Wir empfehlen, den Aerospike-Exporter aerospike-prometheus-exporter als Sidecar-Datei in Ihrer Aerospike-Arbeitslast zu installieren. Informationen zur Verwendung von Sidecars finden Sie unter Erweiterte Anwendung in Kubernetes mit Pods mit mehreren Containern.

Wenn Sie aerospike-prometheus-exporter als Sidecar-Datei in Aerospike installieren möchten, ändern Sie die Aerospike-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: StatefulSet
metadata:
  name: aerospike
  labels:
    app.kubernetes.io/name: aerospike
spec:
  serviceName: aerospike
  replicas: 1
  selector:
    matchLabels:
+     app.kubernetes.io/name: aerospike
  template:
    metadata:
      labels:
+       app.kubernetes.io/name: aerospike
    spec:
      containers:
      - name: aerospike
        image: aerospike/aerospike-server:6.0.0.2
        ports:
        - containerPort: 3000
+     - name: aerospike-prometheus-exporter
+       image: aerospike/aerospike-prometheus-exporter:1.8.0
+       ports:
+       - containerPort: 9145
+         name: prometheus
+       env:
+         - name: AS_HOST
+           value: localhost
+         - name: AS_PORT
+           value: "3000"

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

In dieser Anleitung wird davon ausgegangen, dass Sie bereits eine funktionierende Aerospike-Installation haben und diese ändern möchten, um einen Exporter aufzunehmen. Informationen zum Einrichten von Aerospike finden Sie in der Dokumentation zu Aerospike-Operatoren.

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.

PodMonitoring-Ressource definieren

Für die Zielerkennung benötigt der Managed Service for Prometheus Operator eine PodMonitoring-Ressource, die dem Aerospike-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: aerospike
  labels:
    app.kubernetes.io/name: aerospike
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: prometheus
    interval: 30s
  selector:
    matchLabels:
      app.kubernetes.io/name: aerospike

Achten Sie darauf, dass die Labelselektoren und der Port mit den Selektoren und dem Port übereinstimmen, die unter Aerospike-Exporter installieren verwendet werden.

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 Aerospike-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: aerospike-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: aerospike-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: aerospike
    interval: 30s
    rules:
    - alert: AerospikeHighMemoryUtilization
      annotations:
        description: |-
          Aerospike high memory utilization
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Aerospike high memory utilization (instance {{ $labels.instance }})
      expr: aerospike_node_stats_system_free_mem_pct < 5
      for: 5m
      labels:
        severity: critical
    - alert: AerospikeHighNamespaceDiskUtilization
      annotations:
        description: |-
          Aerospike high namespace disk utilization
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Aerospike high namespace disk utilization (instance {{ $labels.instance }})
      expr: aerospike_namespace_device_available_pct < 5
      for: 5m
      labels:
        severity: warning
    - alert: AerospikeHighNamespaceMemoryUtilization
      annotations:
        description: |-
          Aerospike high namespace memory utilization
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Aerospike high namespace memory utilization (instance {{ $labels.instance }})
      expr: aerospike_namespace_memory_free_pct < 5
      for: 5m
      labels:
        severity: warning

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 Aerospike-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 PromQL 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="aerospike", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

Dashboards ansehen

Die Cloud Monitoring-Integration beinhaltet das Dashboard Aerospike 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. Aerospike 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 Aerospike-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.