Prometheus-Setup

Setup-Guide für Prometheus

Überblick

Dieses Dokument enthält Anweisungen zum Einrichten von Prometheus-Monitoring für die Anwendung Lobster Data Platform.

Voraussetzungen

• Prometheus Server installiert

• Zugriff auf Zielanwendungen zum Abgreifen von Kennzahlen vorhanden

• Gültiger Authentifizierungs-Token für gesicherte Endpunkte

Aufbau der Konfigurationsdatei

Die Konfiguration für Prometheus wird durch die Datei prometheus.yml (https://prometheus.io/docs/prometheus/latest/configuration/configuration/) mit den folgenden Schlüsselkomponenten definiert:

Globale Einstellungen

global:
  scrape_interval: 15s      # Default interval for scraping metrics
  evaluation_interval: 15s  # Default interval for evaluating rules

Scrape-Konfiguration

External System Monitoring

Monitors an external system with the following configuration:

• Ziel: <server name> z. B. localhost, 10.xx.yy.zz

• Kennzahlen-Pfad: /system/metrics

• Scrape-Intervall: 25 seconds

• Timeout: 10 seconds

• Authentisierung: Bearer token authentication

Sicherheitseinstellungen

Authentisierungsverfahren

The configuration supports multiple authentication methods but LDP only uses one:

• Bearer Token: Currently active authentication method

Die Konfiguration sieht mehrere Authentisierungsverfahren  vor, aber Lobster Data Platform verwendet nur die folgende:

• Bearer Token (derzeit einziges verfügbares Authentisierungsverfahren)

Token Management

• Store tokens securely and avoid committing them to version control

• Each environment should have its own set of authentication credentials

Konfigurationsdatei (Beispiel)

Das folgende Beispiel für eine  prometheus.yml-Konfigurationsdatei kann als Ausgangspunkt für eine spezifische Konfiguration verwendet werden:

# prometheus.yml
global:
  scrape_interval: 15s
  evaluation_interval: 15s
scrape_configs:
  - job_name: 'lobster-data-app'
    static_configs:
      - targets: [ 'localhost:8080' ]
    scrape_interval: 25s
    scrape_timeout: 10s
    metrics_path: /system/metrics
    bearer_token: 'your-application-token-here'

Anpassen der Konfiguration

Schritte zur Anpassung dieser Konfiguration an eine individuelle Umgebung:

• Zieladressen ersetzen:

  • localhost:8080 ersetzen durch die Host/Port-Adresse der betreffenden Applikation

• Authentisierungs-Tokens ersetzen:

  • your-application-token-here ersetzen durch den Authentisierungs-Token für die betreffende Applikation

• Einstellungen für den Zeitablauf vornehmen:

  • scrape_interval passend für die gewünschte Abfragefrequenz für das Monitoring einstellen

  • scrape_timeout auf einen höheren Wert setzen, falls die abgefragten Endpunkte zu langsam reagieren

Schritte zur Implementierung

Vorbereiten der Konfiguration

• Zieladresse für die Umgebung anpassen

• Authentisierungs-Tokens mit gültigen Anmeldedaten ersetzen

• Scrape-Intervall passend zu den Anforderungen für das gewünschte Monitoring einstellen

Konfiguration validieren

Prometheus starten

Setup verifizieren

• Prometheus web interface aufrufen (default: http://localhost:9090)

• Zielstatus prüfen unter Status → Targets

• Überprüfen ob Kennzahlen gesammelt werden

Troubleshooting

Häufige Probleme

1. Anmeldung scheitert: Prüfen ob Bearer Tokens valide und noch nicht abgelaufen sind

2. Verbindungs-Timeouts: Netzwerkverbindung und Firewall-Einstellungen prüfen

3. Fehlende Kennzahlen: Sicherstellen, dass die Zielanwendungen die Kennzahlen unter dem konfigurierten Pfad bereitstellen

Health Monitoring

• Prometheus-Log-Dateien nach Scraping-Fehlern durchsuchen

• Zielstatus in der Prometheus-Benutzeroberfläche überprüfen

• Überprüfen, ob die Kennzahlen mit der erwarteten Beschriftung übertragen werden

Best Practices

• Sicherheit

  • Umgebungsspezifische Tokens verwenden

  • Angemessene Zugriffskontrolle implementieren

• Performance

  • Abfrageintervalle anforderungsgerecht einstellen

  • Ressourcenbedarf von Prometheus überwachen

  • Richtlinien für die Vorhaltung von Kennzahlen beachten

• Wartung

  • Regelmäßige Überprüfung der Konfiguration

  • Health Monitoring für das Zielsystem

  • Aktualisieren der Anmeldeinformationen nach Bedarf