> ## Documentation Index
> Fetch the complete documentation index at: https://docs.germainux.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Prometheus Metrics

> GermainUX exposes Prometheus-formatted metrics for monitoring, dashboarding, and alerting.

Service
`Management`

Availability
2016.1 or later

> [card] [Service endpoints](#service-endpoints)
>
> Where metrics are exposed

> [card] [Third-party service metrics](#third-party-service-metrics)
>
> Vendor-enabled metric sources

> [card] [Metric reference](#metric-reference)
>
> Names, types and units

## Overview

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 | `<HOST>:<PORT>/actuator/prometheus` |
| Aggregation | `<HOST>:<PORT>/actuator/prometheus` |
| Analytics | `<HOST>:<PORT>/actuator/prometheus` |
| Server REST | `<HOST>:<PORT>/actuator/prometheus` |
| Server Ingestion | `<HOST>:<PORT>/ingestion/actuator/prometheus` |
| Session | `<HOST>:<PORT>/actuator/prometheus` |
| Storage | `<HOST>:<PORT>/actuator/prometheus` |

> [!NOTE]
>
> **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 | [Monitoring Apache ZooKeeper](https://zookeeper.apache.org/doc/current/zookeeperMonitor.html) |
| Hazelcast Management Center (Enterprise) | [Prometheus monitoring](https://docs.hazelcast.com/management-center/5.3/integrate/prometheus-monitoring) |

## 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 GermainUX agents processed since service was started |   |
| germain\_ingestion\_engineMessages\_total | Counter | Number of messages from GermainUX 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 |   |   |   |

## Get Help

> [card] [Contact GermainUX Support](https://docs.germainux.com/main/support.md)
>
> The GermainUX team helps you get up and running faster, empower your team, turn data into actionable insights, and optimize performance to deliver measurable business outcomes.

> [card] Can't find what you need?
>
> Search all GermainUX docs with **Ctrl + K**, or use the feedback buttons at the bottom of this page to tell us what is missing.

The content of this document is proprietary to GERMAIN SOFTWARE.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.