Ingress-NGINX-Controller

Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

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 Ingress-NGINX-Controller erfassen können. Dieses Dokument enthält Anleitungen für folgende Aufgaben:

  • Den Ingress-NGINX-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 stattdessen die selbst bereitgestellte Sammlung verwenden, finden Sie Informationen zur Installation in der Dokumentation zu Ingress-NGINX.

Informationen zu Ingress NGINX finden Sie unter Ingress-NGINX.

Vorbereitung

Um Messwerte aus dem Ingress-NGINX-Controller mithilfe von Managed Service für Prometheus und einer verwalteten Sammlung zu erfassen, 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.

Ingress NGINX stellt automatisch Messwerte im Prometheus-Format bereit. Sie müssen es nicht separat installieren. Mit dem folgenden Befehl können Sie prüfen, ob der Ingress-NGINX-Controller Messwerte verfügbar macht:
  kubectl exec -n NAMESPACE_NAME deploy/ingress-nginx-controller -- curl http://localhost:10254/metrics
  

PodMonitoring-Ressource definieren

Für die Zielerkennung benötigt der Managed Service for Prometheus Operator eine PodMonitoring-Ressource, die dem Ingress-NGINX-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: ingress-nginx
  labels:
    app.kubernetes.io/name: ingress-nginx
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: 10254
    scheme: http
    interval: 30s
    path: /metrics
  selector:
    matchLabels:
      app.kubernetes.io/name: ingress-nginx
Achten Sie darauf, dass die Werte der Felder port und matchLabels mit den Werten der Ingress-NGINX-Pods übereinstimmen, die Sie beobachten möchten. Der Ingress-NGINX-Controller stellt standardmäßig Messwerte auf Port 10254 bereit und hat das Label app.kubernetes.io/name: ingress-nginx.

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 Ingress-NGINX-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: ingress-nginx-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: ingress-nginx-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: ingress-nginx
    interval: 30s
    rules:
    - alert: NGINXIngressDroppedConnections
      annotations:
        description: |-
          NGINX Ingress dropped connections
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: NGINX Ingress dropped connections (instance {{ $labels.instance }})
      expr: (nginx_ingress_controller_nginx_process_connections_total{state="accepted"} - nginx_ingress_controller_nginx_process_connections_total{state="handled"}) > 0
      for: 5m
      labels:
        severity: critical
    - alert: NGINXIngressHighRequestRate
      annotations:
        description: |-
          NGINX Ingress high request rate
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: NGINX Ingress high request rate (instance {{ $labels.instance }})
      expr: rate(nginx_ingress_controller_requests[5m]) > 100
      for: 5m
      labels:
        severity: warning
    - alert: NGINXIngressLowRequestRate
      annotations:
        description: |-
          NGINX Ingress low request rate
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: NGINX Ingress low request rate (instance {{ $labels.instance }})
      expr: rate(nginx_ingress_controller_requests[5m]) < 10
      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 Sie den Ingress-NGINX-Exporter richtig konfiguriert haben. Es kann ein oder zwei Minuten dauern, bis Cloud Monitoring Ihre Messwerte aufgenommen hat.

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

  1. Wählen Sie in der Google Cloud Console Monitoring aus oder klicken Sie auf die folgende Schaltfläche:
    Zu Monitoring.
  2. Wählen Sie im Navigationsbereich Metrics Explorer aus.
  3. Wählen Sie den Tab PromQL aus und führen Sie die folgende Abfrage aus:
    up{job="ingress-nginx", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

Dashboards ansehen

Die Cloud Monitoring-Integration beinhaltet das Dashboard Ingress 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. Wählen Sie in der Google Cloud Console Monitoring aus oder klicken Sie auf die folgende Schaltfläche:
    Zu Monitoring.
  2. Wählen Sie im Navigationsbereich die Option  Dashboards aus.
  3. Wählen Sie den Tab Dashboard-Liste aus.
  4. Wählen Sie die Kategorie Integrationen aus.
  5. Klicken Sie auf den Namen des Dashboards, z. B. Ingress NGINX Prometheus – Übersicht.

So rufen Sie eine statische Vorschau des Dashboards auf:

  1. Wählen Sie in der Google Cloud Console Monitoring aus oder klicken Sie auf die folgende Schaltfläche:
    Zu Monitoring.
  2. Wählen Sie im Navigationsbereich die Option  Integrationen aus.
  3. Klicken Sie auf den Filter für die Deployment-Plattform Kubernetes Engine.
  4. Suchen Sie die Ingress NGINX-Integration und klicken Sie auf Details ansehen.
  5. 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.