Prometheus-Schnittstelle

Information

Dieses Topic beschreibt die Prometheus-Schnittstelle, die ab S 39.5.37 genutzt werden kann, um Informationen über den Betrieb des Servers abzufragen/zu überwachen.

Konfiguration

Die Konfiguration erfolgt in der web.conf oder per Umgebungsvariablen.
Defaultmäßig sind die folgenden Werte konfiguriert:
- webservices__prometheus__enable = false
- webservices__prometheus__connection = 0.0.0.0:9999
- webservices__prometheus__entrypoint = /metrics

Rückgabewerte

Metriken

Die Informationen werden im json-Format ausgegeben und haben diese Struktur:

TEXT

# HELP planta_server_count_max_active_sessions_total Maximum of parallel active sessions 
# TYPE planta_server_count_max_active_sessions_total counter 
planta_server_count_max_active_sessions_total 3.0 
# HELP planta_server_count_sessions_by_mode_total Count started and ended sessions by mode 
# TYPE planta_server_count_sessions_by_mode_total counter 
planta_server_count_sessions_by_mode_total{sessionMode="client"} 0.0 
planta_server_count_sessions_by_mode_total{sessionMode="clientless"} 3.0 
planta_server_count_sessions_by_mode_total{sessionMode="desktopclient"} 0.0 
planta_server_count_sessions_by_mode_total{sessionMode="master"} 1.0 
planta_server_count_sessions_by_mode_total{sessionMode="migration"} 0.0 
planta_server_count_sessions_by_mode_total{sessionMode="scheduler"} 0.0 
planta_server_count_sessions_by_mode_total{sessionMode="unittest"} 0.0 
planta_server_count_sessions_by_mode_total{sessionMode="webclient"} 0.0 
# HELP planta_server_jvm_memory_pool_allocated_bytes_total Total bytes allocated in a given JVM memory pool. Only updated after GC, not continuously. 
# TYPE planta_server_jvm_memory_pool_allocated_bytes_total counter
planta_server_jvm_memory_pool_allocated_bytes_total{pool="CodeHeap 'non-nmethods'"} 2.076928 
planta_server_jvm_memory_pool_allocated_bytes_total{pool="CodeHeap 'non-profiled nmethods'"} 12.860544 
planta_server_jvm_memory_pool_allocated_bytes_total{pool="CodeHeap 'profiled nmethods'"} 49.468928 
planta_server_jvm_memory_pool_allocated_bytes_total{pool="Compressed Class Space"} 17.722848 
planta_server_jvm_memory_pool_allocated_bytes_total{pool="G1 Eden Space"} 476.053504 
planta_server_jvm_memory_pool_allocated_bytes_total{pool="G1 Old Gen"} 216.96561599999998 
planta_server_jvm_memory_pool_allocated_bytes_total{pool="G1 Survivor Space"} 8.912896 
planta_server_jvm_memory_pool_allocated_bytes_total{pool="Metaspace"} 165.78789600000002 
# HELP planta_server_native_memory_pool_allocated_bytes Total bytes allocated in a given native memory pool as indicated by the native server part. 
# TYPE planta_server_native_memory_pool_allocated_bytes gauge 
planta_server_native_memory_pool_allocated_bytes{nativeMemoryType="freeAndMapped"} 0.0 
planta_server_native_memory_pool_allocated_bytes{nativeMemoryType="freeUnmapped"} 1.040384 
planta_server_native_memory_pool_allocated_bytes{nativeMemoryType="inUse"} 0.0 
planta_server_native_memory_pool_allocated_bytes{nativeMemoryType="totalReserved"} 1.048576 
# HELP planta_server_sum_active_sessions Number of all active sessions 
# TYPE planta_server_sum_active_sessions gauge 
planta_server_sum_active_sessions 1.0 
# HELP planta_server_track_active_sessions_by_mode Track active session by mode (Planta server and client sessions) 
# TYPE planta_server_track_active_sessions_by_mode gauge 
planta_server_track_active_sessions_by_mode{threadType="client"} 0.0 
planta_server_track_active_sessions_by_mode{threadType="clientless"} 0.0 
planta_server_track_active_sessions_by_mode{threadType="desktopclient"} 0.0 
planta_server_track_active_sessions_by_mode{threadType="master"} 1.0 
planta_server_track_active_sessions_by_mode{threadType="migration"} 0.0 
planta_server_track_active_sessions_by_mode{threadType="scheduler"} 0.0 
planta_server_track_active_sessions_by_mode{threadType="unittest"} 0.0 
planta_server_track_active_sessions_by_mode{threadType="webclient"} 0.0

Details

Aufbau

# TYPE – Typ der Metrik (counter, gauge, histogram, summary)

# HELP – Beschreibung der Metrik

Metrikname – muss den Prometheus-Namenskonventionen entsprechen

Labels – Schlüssel/Wert-Paare in {...}

Wert (Zahl, float)

Alle Metriken des Servers haben den Prefix “planta_server_”, dies erleichert die Zuordnung/Auffindung in anderen Systemen.

Verfügbare Metriken:

planta_server_sum_active_sessions - Summe aller aktiven Sessions

planta_server_count_max_active_sessions_total - Maximale Anzahl aktiver Session

planta_server_track_active_sessions_by_mode - Anzahl aktiver Session per SessionMode

planta_server_count_sessions_by_mode_total - Summer aller bisherigen Sessions per SessionMode

Label: sessionMode

mögliche Werte:
- client
- clientless
- desktopclient
- master
- migration
- scheduler
- unittest
- webclient

planta_server_native_memory_pool_allocated_bytes - aktuell verwendeter Speicher im worker per nativeMemoryType
Label: nativeMemoryType

mögliche Werte:
- freeAndMapped
- freeUnmapped
- inUse
- totalReserved

planta_server_jvm_memory_pool_allocated_bytes_total - aktuell verwendeter Speicher im manager per pool

Label: pool

mögliche Werte:
- CodeHeap 'non-nmethods' - Speicherbereich für vom JIT-Compiler generierte Hilfsklassen und sonstigen Code, der keine „normalen“ Methoden (nmethods) ist.
- CodeHeap 'non-profiled nmethods' - Hier landen weniger optimierte, aber kompilierte Methoden.
- CodeHeap 'profiled nmethods' - stark genutzte Methoden, die die JVM nach Analyse besonders effizient kompiliert hat.
- Compressed Class Space - Teil des Metaspace (Klassen-Metadaten-Speicher).
- G1 Eden Space - Teil des Java Heaps im Garbage Collector G1 (Garbage-First GC).
- G1 Old Gen - Bereich für langfristig lebende Objekte.
- G1 Survivor Space - Objekte, die den ersten GC überleben, landen hier.
- Metaspace - Enthält Informationen über geladene Klassen, Methoden, Felder usw.