Monitoring einrichten

Voraussetzungen

Stellen Sie sicher, dass die folgenden Komponenten verfügbar sind:

• Prometheus 2.x oder neuer, laufend und erreichbar
• Grafana 10.x oder neuer, laufend und erreichbar
• Reva mit erreichbarem /api/metrics-Endpunkt von Prometheus aus

Prüfen Sie, ob der Metriken-Endpunkt funktioniert:

curl http://<reva-host>:3978/api/metrics

Sie sollten eine Ausgabe im Prometheus-Textformat mit Metriken sehen, die mit reva_ beginnen.

Prometheus-Konfiguration

Kopieren oder mergen Sie config/prometheus/prometheus.yml in Ihre Prometheus-Konfiguration.

# prometheus.yml (Docker Compose)
scrape_configs:
  - job_name: "reva"
    metrics_path: "/api/metrics"
    scrape_interval: 30s
    static_configs:
      - targets: ["reva:3978"]

# prometheus.yml (Kubernetes)
scrape_configs:
  - job_name: "reva"
    metrics_path: "/api/metrics"
    scrape_interval: 30s
    kubernetes_sd_configs:
      - role: pod
        namespaces:
          names: ["reva"]
    relabel_configs:
      - source_labels: [__meta_kubernetes_pod_label_app]
        regex: reva
        action: keep

Laden Sie Prometheus nach der Konfigurationsänderung neu:

docker compose exec prometheus kill -HUP 1

kubectl rollout restart deployment/prometheus -n monitoring

Grafana-Dashboard importieren

Reva liefert ein vorgefertigtes Grafana-Dashboard unter config/grafana/reva-dashboard.json mit. Importieren Sie es in vier Schritten:

1. Öffnen Sie Grafana und navigieren Sie zu Dashboards > Import.
2. Klicken Sie auf Upload JSON file und wählen Sie config/grafana/reva-dashboard.json.
3. Wählen Sie im Import-Dialog Ihre Prometheus-Datenquelle aus dem Dropdown.
4. Klicken Sie auf Import.

Dashboard-Panels

Das Dashboard „Reva — Release Virtual Assistant“ enthält sieben Panels in vier Reihen:

Alarme konfigurieren

Kopieren Sie config/prometheus/alerts.yml in Ihr Prometheus-Regelverzeichnis (dasselbe Verzeichnis wie prometheus.yml oder wohin rule_files zeigt).

Alarmregeln

Folgende Alarme sind vordefiniert:

AlertManager-Routing

Um Alarmbenachrichtigungen zu erhalten, konfigurieren Sie AlertManager mit einem Empfänger. Beispiel für Slack:

# alertmanager.yml
route:
  receiver: "slack"
  routes:
    - match:
        severity: critical
      receiver: "slack"
      repeat_interval: 1h

receivers:
  - name: "slack"
    slack_configs:
      - api_url: "https://hooks.slack.com/services/..."
        channel: "#reva-alerts"
        title: '{{ .CommonAnnotations.summary }}'
        text: '{{ .CommonAnnotations.description }}'

Verifizierung

Führen Sie nach Abschluss der Einrichtung diese vier Prüfungen durch, um sicherzustellen, dass alles funktioniert:

1. Prometheus-Target: Navigieren Sie zu http://<prometheus>:9090/targets und prüfen Sie, ob reva den Status UP anzeigt.
2. Direkte Abfrage: Führen Sie reva_uptime_seconds in der Prometheus-Abfrageoberfläche aus. Es sollte ein positiver Wert zurückgegeben werden.
3. Grafana-Panels: Öffnen Sie das Reva-Dashboard. Alle Panels sollten Daten anzeigen (einige können Null sein, wenn noch kein Traffic stattgefunden hat).
4. Alarmregeln: Navigieren Sie zu http://<prometheus>:9090/rules und prüfen Sie, ob die Regelgruppe reva.rules geladen ist.

Metrik-Referenz

Gauges

Counter