Skip to main content
Skip table of contents

Prometheus Interface

Information

  • This topic describes the Prometheus interface that can be used from S 39.5.37 to query/monitor information on the server operation.

Configuration

  • Configuration is carried out via the environment variable in the manager container of the PLANTA Server.

  • The following values are configured by default:

    • planta__server__webservices__prometheus__enable = false

    • planta__server__webservices__prometheus__connection = 0.0.0.0:9999

    • planta__server__webservices__prometheus__entrypoint = /metrics

Return values

Metrics

The information is output in json format and have the following structure:

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 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.11008
planta_server_jvm_memory_pool_allocated_bytes_total{pool="CodeHeap 'non-profiled nmethods'"} 17.482624
planta_server_jvm_memory_pool_allocated_bytes_total{pool="CodeHeap 'profiled nmethods'"} 57.545088
planta_server_jvm_memory_pool_allocated_bytes_total{pool="Compressed Class Space"} 18.18084
planta_server_jvm_memory_pool_allocated_bytes_total{pool="G1 Eden Space"} 939.524096
planta_server_jvm_memory_pool_allocated_bytes_total{pool="G1 Old Gen"} 234.791408
planta_server_jvm_memory_pool_allocated_bytes_total{pool="G1 Survivor Space"} 14.680064
planta_server_jvm_memory_pool_allocated_bytes_total{pool="Metaspace"} 170.798792
# HELP planta_server_native_memory_pool_allocated_bytes 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

Metrics up to S 39.1.0

The information is output in json format and have the following structure:

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_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_native_memory_pool_allocated_bytes_total Total bytes allocated in a given native memory pool as indicated by the native server part.
# TYPE planta_server_native_memory_pool_allocated_bytes_total gauge
planta_server_native_memory_pool_allocated_bytes_total{nativeMemoryType="freeUnmapped",} 1.040384
planta_server_native_memory_pool_allocated_bytes_total{nativeMemoryType="freeAndMapped",} 0.0
planta_server_native_memory_pool_allocated_bytes_total{nativeMemoryType="totalReserved",} 1.048576
planta_server_native_memory_pool_allocated_bytes_total{nativeMemoryType="inUse",} 0.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="scheduler",} 0.0
planta_server_count_sessions_by_mode_total{sessionMode="desktopclient",} 0.0
planta_server_count_sessions_by_mode_total{sessionMode="clientless",} 3.0
planta_server_count_sessions_by_mode_total{sessionMode="webclient",} 0.0
planta_server_count_sessions_by_mode_total{sessionMode="client",} 0.0
planta_server_count_sessions_by_mode_total{sessionMode="unittest",} 0.0
planta_server_count_sessions_by_mode_total{sessionMode="migration",} 0.0
planta_server_count_sessions_by_mode_total{sessionMode="master",} 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="scheduler",} 0.0
planta_server_track_active_sessions_by_mode{threadType="desktopclient",} 0.0
planta_server_track_active_sessions_by_mode{threadType="clientless",} 0.0
planta_server_track_active_sessions_by_mode{threadType="webclient",} 0.0
planta_server_track_active_sessions_by_mode{threadType="client",} 0.0
planta_server_track_active_sessions_by_mode{threadType="unittest",} 0.0
planta_server_track_active_sessions_by_mode{threadType="migration",} 0.0
planta_server_track_active_sessions_by_mode{threadType="master",} 1.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 'profiled nmethods'",} 58.267904
planta_server_jvm_memory_pool_allocated_bytes_total{pool="G1 Old Gen",} 214.344176
planta_server_jvm_memory_pool_allocated_bytes_total{pool="G1 Eden Space",} 845.1522560000001
planta_server_jvm_memory_pool_allocated_bytes_total{pool="CodeHeap 'non-profiled nmethods'",} 16.425983999999996
planta_server_jvm_memory_pool_allocated_bytes_total{pool="G1 Survivor Space",} 9.26704
planta_server_jvm_memory_pool_allocated_bytes_total{pool="Compressed Class Space",} 17.832656
planta_server_jvm_memory_pool_allocated_bytes_total{pool="Metaspace",} 168.53624
planta_server_jvm_memory_pool_allocated_bytes_total{pool="CodeHeap 'non-nmethods'",} 2.658432

Structure

# TYPE – Type of the metric (counter, gauge, histogram, summary)

# HELP – Description of the metric

Metric name – Must comply with the Prometheus name conventions

Labels – Key/value pairs in {...}

Value (number, float)

All server metrics have the planta_server_ prefix which makes it easier to assign or find them in other systems.

Available Metrics

planta_server_sum_active_sessions - Sum of all active sessions

planta_server_count_max_active_sessions_total - Maximum number of active sessions

planta_server_track_active_sessions_by_mode - Number of active sessions per SessionMode

planta_server_count_sessions_by_mode_total - Sum of all previous sessions per SessionMode

Label: sessionMode

  • Possible values:

    • client

    • clientless

    • desktopclient

    • master

    • migration

    • scheduler

    • unittest

    • webclient

planta_server_native_memory_pool_allocated_bytes (up to S 39.1.0 planta_server_native_memory_pool_allocated_byte_total)- currently used storage in the worker per nativeMemoryType

Label: nativeMemoryType

  • Possible values:

    • freeAndMapped

    • freeUnmapped

    • inUse

    • totalReserved

planta_server_jvm_memory_pool_allocated_bytes_total - currently used memory in the manager per pool

Label: pool

  • Possible values:

    • CodeHeap 'non-nmethods' - storage area for auxiliary classes generated by the JIT compiler and other code that is not “normal” methods (nmethods).

    • CodeHeap 'non-profiled nmethods' - Here, less optimized but compiled methods are stored.

    • CodeHeap 'profiled nmethods' - frequently used methods, which have been compiled with particular efficiency by JVM after analysis.

    • Compressed Class Space - part of the Metaspace (class meta data memory).

    • G1 Eden Space - part of the Java Heap in the Garbage Collector G1 (Garbage First GC).

    • G1 Old Gen - area for long-lived objects.

    • G1 Survivor Space - objects that survive the first GC are stored here.

    • Metaspace - contains information on loaded classes, methods, fields, etc.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close