⚙️ GermainUX Prometheus Metrics
GermainUX exposes Prometheus-formatted metrics for monitoring, dashboarding, and alerting. Use the endpoints and metric reference below to integrate GermainUX services with Prometheus or another compatible observability platform.
🔗 Service endpoints
|
Service |
Endpoint |
|---|---|
|
Action |
|
|
Aggregation |
|
|
Analytics |
|
|
Server REST |
|
|
Server Ingestion |
|
|
Session |
|
|
Storage |
|
Authentication: By default, the Action, Aggregation, Analytics, and Server endpoints can be accessed without authentication. Review your deployment and network-security configuration before exposing these endpoints outside a trusted environment.
📦 Third-party service metrics
GermainUX deployments may also use third-party services that can expose Prometheus metrics. Follow the vendor documentation to enable and configure those metrics.
|
Service |
Documentation |
|
Apache ZooKeeper |
|
|
Hazelcast Management Center (Enterprise) |
📊 Metric reference
The following tables list the available metric names, metric types, descriptions, and units for each GermainUX service. A blank description or unit means that the source configuration does not define one.
🖥️ REST Server metrics
|
Metric name |
Type |
Description |
Unit |
|
application_ready_time_seconds |
Gauge |
|
Seconds |
|
application_started_time_seconds |
Gauge |
|
Seconds |
|
disk_total_bytes |
Gauge |
Total disk size |
Bytes |
|
executor_active_threads |
Gauge |
|
|
|
executor_completed_tasks_total |
Counter |
|
|
|
executor_pool_max_threads |
Gauge |
|
|
|
executor_pool_size_threads |
Gauge |
Number of threads in a thread pool executor |
|
|
executor_queue_remaining_tasks |
Gauge |
Number of tasks still pending in the queue |
|
|
executor_queued_tasks |
Gauge |
Tasks waiting to be executed |
|
|
germain_mail_total |
Counter |
Number of emails sent |
|
|
hikaricp_connections |
Gauge |
Number of connections |
|
|
hikaricp_connections_acquire_seconds |
Summary |
Connection acquire time |
Seconds |
|
hikaricp_connections_acquire_seconds_max |
Gauge |
Max of connection acquire time |
Seconds |
|
hikaricp_connections_active |
Gauge |
Number of active connections |
|
|
hikaricp_connections_creation_seconds |
Summary |
Connection creation time |
Seconds |
|
hikaricp_connections_creation_seconds_max |
Gauge |
Max of creation connection time |
Seconds |
|
hikaricp_connections_idle |
Gauge |
Number of idle connections |
|
|
hikaricp_connections_max |
Gauge |
Max number of connections |
|
|
hikaricp_connections_pending |
Gauge |
Number of pending connections |
|
|
hikaricp_connections_timeout_total |
Counter |
Total number of timeout connections |
|
|
hikaricp_connections_usage_seconds |
Summary |
Connection usage time |
Seconds |
|
hikaricp_connections_usage_seconds_max |
Gauge |
Max of connection usage time |
Seconds |
|
http_server_requests_active_seconds |
Summary |
|
Seconds |
|
http_server_requests_active_seconds_max |
Gauge |
Maximum time a request has been active |
Seconds |
|
http_server_requests_seconds |
Summary |
|
Seconds |
|
http_server_requests_seconds_max |
Gauge |
Max response time for HTTP requests |
Seconds |
|
jvm_buffer_count_buffers |
Gauge |
An estimate of the number of buffers in the pool |
|
|
jvm_buffer_memory_used_bytes |
Gauge |
An estimate of the memory that the Java virtual machine is using for this buffer pool |
Bytes |
|
jvm_buffer_total_capacity_bytes |
Gauge |
An estimate of the total capacity of the buffers in this pool |
Bytes |
|
jvm_classes_loaded_classes |
Gauge |
The number of classes that are currently loaded in the Java virtual machine |
|
|
jvm_classes_unloaded_classes_total |
Counter |
The total number of classes unloaded since the Java virtual machine has started execution |
|
|
jvm_compilation_time_ms_total |
Counter |
|
Milliseconds |
|
jvm_gc_live_data_size_bytes |
Gauge |
Size of long-lived heap memory pool after reclamation |
Bytes |
|
jvm_gc_memory_allocated_bytes_total |
Counter |
Incremented for an increase in the size of the (young) heap memory pool after one GC to before the next |
Bytes |
|
jvm_gc_memory_promoted_bytes_total |
Counter |
Count of positive increases in the size of the old generation memory pool before GC to after GC |
Bytes |
|
jvm_gc_overhead_percent |
Gauge |
An approximation of the percent of CPU time used by GC activities over the last lookback period or since monitoring began, whichever is shorter, in the range [0..1] |
|
|
jvm_gc_pause_seconds |
Summary |
Time spent in GC pause |
Seconds |
|
jvm_gc_pause_seconds_max |
Gauge |
Time spent in GC pause |
|
|
jvm_info |
Gauge |
JVM information |
|
|
jvm_memory_max_bytes |
Gauge |
The maximum amount of memory in bytes that can be used for memory management |
Bytes |
|
jvm_memory_usage_after_gc_percent |
Gauge |
The percentage of long-lived heap pool used after the last GC event, in the range [0..1] |
|
|
jvm_memory_used_bytes |
Gauge |
The amount of used memory |
Bytes |
|
jvm_threads_daemon_threads |
Gauge |
The current number of live daemon threads |
|
|
jvm_threads_live_threads |
Gauge |
The current number of live threads including both daemon and non-daemon threads |
|
|
jvm_threads_peak_threads |
Gauge |
The peak live thread count since the Java virtual machine started or peak was reset |
|
|
jvm_threads_started_threads_total |
Counter |
|
|
|
jvm_threads_states_threads |
Gauge |
The current number of threads |
|
|
logback_events_total |
Counter |
Number of events that made it to the logs |
|
|
process_cpu_usage |
Gauge |
The "recent cpu usage" for the Java Virtual Machine process |
|
|
process_files_max_files |
Gauge |
The maximum file descriptor count |
|
|
process_files_open_files |
Gauge |
The open file descriptor count |
|
|
process_start_time_seconds |
Gauge |
Start time of the process since unix epoch |
Seconds |
|
process_uptime_seconds |
Gauge |
The uptime of the Java virtual machine |
Seconds |
|
spring_kafka_listener_seconds |
Summary |
|
Seconds |
|
spring_kafka_template_seconds |
Summary |
|
Seconds |
|
spring_kafka_template_seconds_max |
Gauge |
|
Seconds |
|
system_cpu_count |
Gauge |
The number of processors available to the Java virtual machine |
|
|
system_cpu_usage |
Gauge |
The "recent cpu usage" of the system the application is running in |
|
|
system_load_average_1m |
Gauge |
The sum of the number of runnable entities queued to available processors and the number of runnable entities running on the available processors averaged over a period of time |
|
|
tasks_scheduled_execution_active_seconds |
Summary |
|
Seconds |
|
tasks_scheduled_execution_active_seconds_max |
Gauge |
|
Seconds |
|
tasks_scheduled_execution_seconds |
Summary |
|
Seconds |
|
tomcat_cache_access_total |
Counter |
|
|
|
tomcat_cache_hit_total |
Counter |
|
|
|
tomcat_connections_config_max_connections |
Gauge |
|
|
|
tomcat_connections_current_connections |
Gauge |
|
|
|
tomcat_connections_keepalive_current_connections |
Gauge |
|
|
|
tomcat_global_error_total |
Counter |
|
|
|
tomcat_global_received_bytes_total |
Counter |
|
Bytes |
|
tomcat_global_request_max_seconds |
Gauge |
Max time a single request can take to complete before it is terminated |
Seconds |
|
tomcat_global_request_seconds |
Summary |
|
Seconds |
|
tomcat_global_sent_bytes_total |
Counter |
|
Bytes |
|
tomcat_servlet_error_total |
Counter |
|
|
|
tomcat_servlet_request_max_seconds |
Gauge |
|
Seconds |
|
tomcat_servlet_request_seconds |
Summary |
|
Seconds |
|
tomcat_threads_busy_threads |
Gauge |
|
|
|
tomcat_threads_config_max_threads |
Gauge |
Max number of threads a connector can handle simultaneously |
|
📥 Ingestion Server metrics
|
Metric name |
Type |
Description |
Unit |
|
application_ready_time_seconds |
Gauge |
|
Seconds |
|
application_started_time_seconds |
Gauge |
|
Seconds |
|
disk_free_bytes |
Gauge |
Free space in disk |
Bytes |
|
disk_total_bytes |
Gauge |
Total disk size |
Bytes |
|
executor_active_threads |
Gauge |
Number of active threads in the executor |
|
|
executor_completed_tasks_total |
Counter |
|
|
|
executor_pool_core_threads |
Gauge |
|
|
|
executor_pool_max_threads |
Gauge |
|
|
|
executor_pool_size_threads |
Gauge |
Number of threads in a thread pool executor |
|
|
executor_queue_remaining_tasks |
Gauge |
Number of tasks still pending in the queue |
|
|
executor_queued_tasks |
Gauge |
Tasks waiting to be executed |
|
|
germain_ingestion_agentMessages_total |
Counter |
Number of messages from Germain UX agents processed since service was started |
|
|
germain_ingestion_engineMessages_total |
Counter |
Number of messages from Germain UX engines processed since service was started |
|
|
germain_ingestion_facts_total |
Counter |
Total number of facts ingested since service was started |
|
|
germain_ingestion_fragments_total |
Counter |
Number of UX replay fragments processed since service was started |
|
|
hikaricp_connections |
Gauge |
Number of connections |
|
|
hikaricp_connections_acquire_seconds |
Summary |
Connection acquire time |
Seconds |
|
hikaricp_connections_acquire_seconds_max |
Gauge |
Max of connection acquire time |
|
|
hikaricp_connections_active |
Gauge |
Number of active connections |
|
|
hikaricp_connections_creation_seconds |
Summary |
Connection creation time |
Seconds |
|
hikaricp_connections_creation_seconds_max |
Gauge |
Max of connection creation time |
Seconds |
|
hikaricp_connections_idle |
Gauge |
Number of idle connections |
|
|
hikaricp_connections_max |
Gauge |
Max number of connections |
|
|
hikaricp_connections_min |
Gauge |
Min number of connections |
|
|
hikaricp_connections_pending |
Gauge |
Number of pending connections |
|
|
hikaricp_connections_timeout_total |
Counter |
Total number of timeout connections |
|
|
hikaricp_connections_usage_seconds |
Summary |
Connection usage time |
Seconds |
|
hikaricp_connections_usage_seconds_max |
Gauge |
Max of connection usage time |
Seconds |
|
http_server_requests_active_seconds |
Summary |
|
Seconds |
|
http_server_requests_active_seconds_max |
Gauge |
Maximum time a request has been active |
Seconds |
|
http_server_requests_seconds |
Summary |
|
Seconds |
|
http_server_requests_seconds_max |
Gauge |
Max response time for HTTP requests |
Seconds |
|
jdbc_connections_active |
Gauge |
|
|
|
jdbc_connections_idle |
Gauge |
|
|
|
jdbc_connections_max |
Gauge |
Max JDBC connections |
|
|
jdbc_connections_min |
Gauge |
Min number of JDBC connections |
|
💾 Storage metrics
|
Metric name |
Type |
Description |
Unit |
|
application_ready_time_seconds |
Gauge |
|
|
|
application_started_time_seconds |
Gauge |
|
Seconds |
|
disk_free_bytes |
Gauge |
Free space in disk |
Bytes |
|
disk_total_bytes |
Gauge |
Total disk size |
Bytes |
|
executor_active_threads |
Gauge |
Number of active threads in the executor |
|
|
executor_completed_tasks_total |
Counter |
|
|
|
executor_pool_core_threads |
Gauge |
|
|
|
executor_pool_max_threads |
Gauge |
|
|
|
executor_pool_size_threads |
Gauge |
Number of threads in a thread pool executor |
|
|
executor_queue_remaining_tasks |
|
|
|