Wie man die Prometheus API abfragt

Dieser Leitfaden erklärt, wie man die Prometheus HTTP API mit der Metrik events verwendet, einschließlich Sofortabfragen, Zeitbereichsabfragen und der Erkundung von Zeitreihen. Folgende Metriken sind verfügbar: events, mails.

---

1. /api/v1/query – Sofortige Abfrage

Dokumentation: https://nextgen.kajomigenerator.de/docs/#!/Prometheus/getprometheusapiv1query

Zweck

Führt einen PromQL-Ausdruck zu einem bestimmten Zeitpunkt aus.

Beispielabfrage

GET /prometheus/api/v1/query?query=events{mailing_id="31699", category="KJMTrack", action="*"}&time=0

Erklärung

• query: events{mailing_id="31699", category="KJMTrack", action="*"}
  
  
  
  • Filtert die events-Metrik nach:
  
  
  • mailing_id = 31699
  
  
  • category = KJMTrack
  
  
  • action = * (Platzhalter, falls vom Backend unterstützt)
  
  
• time = 0: Spezieller Wert, der als Abfrage über den gesamten Zeitbereich interpretiert werden kann, ohne einen bestimmten Zeitpunkt zu berücksichtigen.

---

2. /api/v1/series – Serienabfrage

Dokumentation: https://nextgen.kajomigenerator.de/docs/#!/Prometheus/getprometheusapiv1series

Zweck

Gibt alle Kombinationen von Labels (Zeitreihen) zurück, die einer Metrik und optionalen Filtern entsprechen.

Beispielabfrage

GET /prometheus/api/v1/series?match[]=events{mailing_id="31699", category="KJMTrack", action="*"}&start=0&end=9999999999

Erklärung

• match[]: Gibt die Metrik und die Filter an.
• start = 0, end = 9999999999: Deckt alle möglichen Daten ab und fragt damit effektiv den gesamten Bereich ab.
• Gibt die passenden Serien (Label-Kombinationen) für den angegebenen Filter zurück.

---

3. /api/v1/query_range – Zeitbereichsabfrage

Dokumentation: https://nextgen.kajomigenerator.de/docs/#!/Prometheus/getprometheusapiv1query_range

Zweck

Führt eine PromQL-Abfrage über einen Zeitraum hinweg aus und gibt Zeitreihen mit mehreren Datenpunkten zurück.

Beispielabfrage

GET /prometheus/api/v1/query_range?query=events{mailing_id="31699", category="KJMTrack", action="*"}&start=1678900000&end=1678990000&step=60

Erklärung

• query: Filtert die events-Metrik.
• start / end: Zeitraum im Unix-Zeitstempel.
• step = 60: Abtastung der Daten alle 60 Sekunden.
• Wird verwendet, um Trends darzustellen oder Muster im Zeitverlauf zu analysieren.

---

Zusammenfassung

Endpoint	Beschreibung
/api/v1/query	Momentaufnahme (mit time=0 für vollständigen Satz)
/api/v1/series	Verfügbare Serien und Label-Kombinationen erkunden
/api/v1/query_range	Zeitbasierte Abfrage für Diagramme oder Analysen

---

Die Filter können angepasst werden, um verschiedene mailing_id, category, action usw. je nach Anwendungsfall abzufragen.

Alle Felder für die Events API sind hier zu finden: (📘 Events Query Dokumentation)