Citrix ADC Observability Exporter mit Prometheus und Grafana

Sie können Prometheus als Endpunkt konfigurieren, um Daten aus dem Citrix ADC Observability Exporter abzurufen. Sie können Grafana auch so konfigurieren, dass dieselben Daten grafisch visualisiert werden.

Citrix ADC Observability Exporter verfügt über einen Push-Gateway-Server, der Port 5563 abhört, um Metriken basierend auf Pull-Anforderungen von Prometheus zu liefern. Citrix ADC Observability Exporter exportiert Zeitreihendaten nach Prometheus.

Architektur von Prometheus und Grafana

Citrix ADC Observability Exporter bereitstellen

Sie können Citrix ADC Observability Exporter mithilfe der YAML-Datei bereitstellen. Stellen Sie basierend auf Ihrer Citrix ADC-Bereitstellung Citrix ADC Observability Exporter entweder außerhalb oder innerhalb von Kubernetes-Clustern bereit. Sie können Citrix ADC Observability Exporter als Pod innerhalb des Kubernetes-Clusters oder auf Citrix ADC MPX oder VPX Appliance außerhalb des Clusters bereitstellen.

Voraussetzungen

  • Stellen Sie sicher, dass Sie einen Kubernetes-Cluster mit aktiviertem Kube-DNS- oder CoreDNS-Addon haben.

Die Bereitstellung von Citrix ADC Observability Exporter mit dem Prometheus-Endpunkt umfasst die folgenden Aufgaben:

  • Bereitstellen einer Beispielanwendung
  • Bereitstellen von Citrix ADC CPX mit aktivierter Unterstützung für Citrix ADC Observability Exporter
  • Prometheus und Grafana mithilfe von YAML-Dateien bereitstellen
  • Bereitstellen von Citrix ADC Observability Exporter mithilfe der YAML-Datei
  • Konfigurieren Sie Citrix ADC für den Export von Metriken (optional)
  • Konfigurieren Sie Prometheus (optional) zum Abrufen von Telemetriedaten
  • Konfigurieren Grafana
  • Grafana-Visualisierung erstellen

Bereitstellen einer Beispielanwendung

Im Folgenden finden Sie ein Beispielverfahren zum Bereitstellen einer Beispiel-Webserver-Anwendung.

Hinweis:

Wenn Sie über eine vorab bereitgestellte Webanwendung verfügen, überspringen Sie die Schritte von Schritt 1 bis Schritt 3.

  1. Erstellen Sie eine geheime ingress.crt und den Schlüssel ingress.key mit Ihrem eigenen Zertifikat und Schlüssel.

    In diesem Beispiel wird ein Secret, das im Standard-Namensraum als ing bezeichnet wird, erstellt.

      kubectl create secret tls ing --cert=ingress.crt --key=ingress.key
    
  2. Greifen Sie über webserver-es.yaml auf die YAML-Datei zu, um die Anwendung bereitzustellen.

      kubectl create -f webserver-es.yaml
    
  3. Definieren Sie die spezifischen Parameter, die Sie importieren müssen, indem Sie sie in den Eingangsanmerkungen der YAML-Datei der Anwendung mithilfe der intelligenten Anmerkungen im Ingress angeben.

      ingress.citrix.com/analyticsprofile: '{"webinsight": {"httpurl":"ENABLED", "httpuseragent":"ENABLED", "httpHost":"ENABLED","httpMethod":"ENABLED","httpContentType":"ENABLED"}}'
    

    Hinweis:

    Die Parameter sind in der Datei webserver-es.yaml vordefiniert.

    Weitere Informationen zu Anmerkungen finden Sie in der Dokumentation zu Ingress-Anmerkungen.

Bereitstellen von Citrix ADC CPX mit aktivierter Unterstützung für Citrix ADC Observability Exporter

Sie können Citrix ADC CPX als Beiwagen bereitstellen, wenn die Citrix ADC Observability Exporter-Unterstützung zusammen mit dem Citrix Ingress Controller aktiviert ist. Sie können die Citrix ADC CPX YAML-Datei cpx-ingress-es.yaml so ändern, dass sie die Konfigurationsinformationen enthält, die für die Unterstützung des Citrix ADC Observability Exporter erforderlich sind.

Im Folgenden finden Sie ein Beispiel für ein Anwendungsbereitstellungsverfahren.

  1. Laden Sie die cpx-ingress-prometheus.yaml - und cic-configmap.yaml-Datei herunter.
  2. Erstellen Sie eine ConfigMap mit den erforderlichen Schlüssel-Wert-Paaren und stellen Sie die ConfigMap bereit. Sie können die Datei cic-configmap.yaml, die für den jeweiligen Endpunkt verfügbar ist, im Verzeichnisverwenden.
  3. Ändern Sie Citrix ADC CPX-bezogene Parameter nach Bedarf.
  4. Bearbeiten Sie die Datei cic-configmap.yaml und geben Sie in der Endpunktkonfiguration NS_ANALYTICS_CONFIG die folgenden Variablen für Citrix ADC Observability Exporter an.

      server: 'coe-prometheus.default.svc.cluster.local' # COE service FQDN
    

    Hinweis:

    Wenn Sie einen anderen Namespace als default verwendet haben, ändern Sie coe-prometheus.default.svc.cluster.local to zu coe-prometheus.<desired-namespace>.svc.cluster.local.

  5. Stellen Sie Citrix ADC CPX mit der Unterstützung des Citrix ADC Observability Exporters mithilfe der folgenden Befehle bereit:

      kubectl create -f cpx-ingress-prometheus.yaml
      kubectl create -f cic-configmap.yaml
    

Prometheus und Grafana mithilfe von YAML-Dateien bereitstellen

Führen Sie die folgenden Schritte aus, um Prometheus und Grafana mithilfe von YAML-Dateien bereitzustellen:

  1. Laden Sie die Prometheus-Grafana YAML-Datei von prometheus-grafana.yamlherunter.
  2. Bearbeiten Sie die Namespace-Definition, wenn Sie einen anderen Namespace als den Standardverwenden möchten.
  3. Führen Sie die folgenden Befehle aus, um Prometheus und Grafana bereitzustellen:

      kubectl create -f prometheus-grafana.yaml
    

Hinweis:

Prometheus und Grafana werden im Standard-Namespace desselben Kubernetes-Clusters bereitgestellt.

Bereitstellen von Citrix ADC Observability Exporter mithilfe der YAML-Datei

Sie können Citrix ADC Observability Exporter mithilfe der YAML-Datei bereitstellen. Laden Sie die YAML-Datei von coe-prometheus.yamlherunter.

Führen Sie den folgenden Befehl aus, um Citrix ADC Observability Exporter mithilfe der Kubernetes-YAML bereitzustellen:

  kubectl create -f coe-prometheus.yaml

Hinweis:

Ändern Sie die YAML-Datei für Citrix ADC Observability Exporter, wenn Sie über einen benutzerdefinierten Namespace verfügen.

Konfigurieren Sie Citrix ADC für den Export von Metriken (optional)

Hinweis:

Wenn Sie Citrix Ingress Controller nicht zum Konfigurieren von Citrix ADC verwenden, können Sie die folgende manuelle Konfiguration auf Ihrem Citrix ADC durchführen.

Sie können Citrix ADCs manuell so konfigurieren, dass Metriken in das Citrix ADC Observability-Exportprogramm exportiert werden. Geben Sie die IP/FQDN-Adresse des Citrix ADC Observability Exporter als HTTP-Dienst an und kombinieren Sie sie mit dem ns_analytics_time_series_profile Standardanalyseprofil. Aktivieren Sie den Metrik-Export und setzen Sie den Ausgabemodus auf Prometheus.

Das Folgende ist eine Beispielkonfiguration:

add server COE_instance 192.168.1.102
add service coe_metric_collector_svc_192.168.1.102 COE_instance HTTP 5563
set analytics profile ns_analytics_time_series_profile -collector coe_metric_collector_svc_192.168.1.102 -Metrics ENABLED -OutputMode Prometheus

Konfigurieren Sie Prometheus (optional) zum Abrufen von Telemetriedaten

Prometheus-Dienste sind als Docker-Images in der Quay-Container-Registrierung und im Docker Hub verfügbar.

Um Prometheus zu starten und auf Port 9090 verfügbar zu machen, führen Sie den folgenden Befehl aus:

docker run -p 9090:9090 prom/prometheus

Um Citrix ADC Observability Exporter manuell als Scrape-Ziel hinzuzufügen, bearbeiten Sie die prometheus.yaml Datei. Geben Sie die IP/FQDN-Adresse des Citrix ADC Observability Exporter und den Port 5563 als Scrape-Ziel in der YAML-Datei an.

scrape_configs:
  - job_name: coe
    static_configs:
      - targets: ['192.168.1.102:5563']

Konfigurieren Grafana

In der aktuellen Bereitstellung wurde bereits ein Prometheus-Server als Datenquelle hinzugefügt. Wenn Sie einen vorhandenen Prometheus-Server für die Bereitstellung verwenden, stellen Sie sicher, dass Sie dieselbe Datenquelle zu Ihrem Grafana hinzufügen. Weitere Informationen finden Sie unter Grafana-Unterstützung für Prometheus.

Grafana-Visualisierung erstellen

Sie können ein Grafana-Dashboard erstellen und die wichtigsten Kennzahlen und den für die Daten geeigneten Visualisierungstyp auswählen.

Das folgende Verfahren zeigt das Hinzufügen der ADC-CPU-Metrik zu einem Grafana-Panel:

  1. Geben Sie den Panel-Titel als ADC-CPUan.
  2. Geben Sie auf der Registerkarte Abfrage für die Abfrage A die Metrik als cpu_usean.
  3. Wählen Sie auf der Registerkarte Einstellungen den Visualisierungstypaus.

    Sie können die Daten und ihre Darstellung in Grafana ändern. Weitere Informationen finden Sie in der Grafana-Dokumentation.

    Grafana-Dashboards

Importieren Sie vorgefertigte Dashboards für Grafana

Sie können auch vorgefertigte Dashboards in Grafana importieren. Sehen Sie sich die verfügbaren Dashboardsan.

Informationen zur Problembehandlung im Zusammenhang mit Citrix ADC Observability Exporter finden Sie unter Citrix ADC CPX Troubleshooting.

Citrix ADC Observability Exporter mit Prometheus und Grafana