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

# Metrics

# Metrics

All server metrics are published to `/prometheus` on the admin port (default 8586).
The metrics are in the Prometheus format and can be scraped by Prometheus or any other monitoring system that supports
Prometheus format.

## Metrics Description

### Counters

| Name                                     | Description                                                                                             | Type    |
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------- |
| jvm\_gc\_memory\_promoted\_bytes\_total  | Count of positive increases in the size of the old generation memory pool before GC to after GC         | counter |
| jvm\_gc\_memory\_allocated\_bytes\_total | Incremented for an increase in the size of the (young) heap memory pool after one GC to before the next | counter |
| pipeline\_client\_request\_status\_total | status codes returned by pipeline client by operation                                                   | counter |
| logback\_events\_total                   | Number of events that made it to the logs                                                               | counter |
| jvm\_classes\_unloaded\_classes\_total   | The total number of classes unloaded since the Java virtual machine has started execution               | counter |

### Gauges

| Name                                       | Description                                                                                                                                                                      | Type  |
| ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
| jvm\_gc\_pause\_seconds\_max               | Time spent in GC pause                                                                                                                                                           | gauge |
| jvm\_memory\_usage\_after\_gc\_percent     | The percentage of long-lived heap pool used after the last GC event, in the range \[0..1]                                                                                        | gauge |
| jvm\_buffer\_count\_buffers                | An estimate of the number of buffers in the pool                                                                                                                                 | gauge |
| jvm\_gc\_max\_data\_size\_bytes            | Max size of long-lived heap memory pool                                                                                                                                          | gauge |
| jvm\_memory\_used\_bytes                   | The amount of used memory                                                                                                                                                        | gauge |
| process\_cpu\_usage                        | The "recent cpu usage" for the Java Virtual Machine process                                                                                                                      | gauge |
| process\_uptime\_seconds                   | The uptime of the Java virtual machine                                                                                                                                           | gauge |
| jvm\_classes\_loaded\_classes              | The number of classes that are currently loaded in the Java virtual machine                                                                                                      | gauge |
| jvm\_memory\_max\_bytes                    | The maximum amount of memory in bytes that can be used for memory management                                                                                                     | gauge |
| system\_cpu\_usage                         | The "recent cpu usage" of the system the application is running in                                                                                                               | gauge |
| process\_files\_open\_files                | The open file descriptor count                                                                                                                                                   | gauge |
| system\_cpu\_count                         | The number of processors available to the Java virtual machine                                                                                                                   | gauge |
| system\_load\_average\_1m                  | 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 | gauge |
| http\_latency\_requests\_seconds\_max      | HTTP request latency in seconds.                                                                                                                                                 | gauge |
| jvm\_gc\_live\_data\_size\_bytes           | Size of long-lived heap memory pool after reclamation                                                                                                                            | gauge |
| jvm\_buffer\_memory\_used\_bytes           | An estimate of the memory that the Java virtual machine is using for this buffer pool                                                                                            | gauge |
| process\_files\_max\_files                 | The maximum file descriptor count                                                                                                                                                | gauge |
| jvm\_threads\_live\_threads                | The current number of live threads including both daemon and non-daemon threads                                                                                                  | gauge |
| process\_start\_time\_seconds              | Start time of the process since unix epoch.                                                                                                                                      | gauge |
| jvm\_buffer\_total\_capacity\_bytes        | An estimate of the total capacity of the buffers in this pool                                                                                                                    | gauge |
| jvm\_threads\_states\_threads              | The current number of threads                                                                                                                                                    | gauge |
| jdbi\_latency\_requests\_seconds\_max      | JDBI queries latency in seconds.                                                                                                                                                 | gauge |
| jvm\_threads\_daemon\_threads              | The current number of live daemon threads                                                                                                                                        | gauge |
| jvm\_gc\_overhead\_percent                 | 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]            | gauge |
| jvm\_memory\_committed\_bytes              | The amount of memory in bytes that is committed for the Java virtual machine to use                                                                                              | gauge |
| jvm\_threads\_peak\_threads                | The peak live thread count since the Java virtual machine started or peak was reset                                                                                              | gauge |
| http\_server\_requests\_sec\_created       | HTTP methods duration                                                                                                                                                            | gauge |
| jdbi\_requests\_seconds\_created           | jdbi requests duration distribution                                                                                                                                              | gauge |
| pipeline\_client\_request\_status\_created | status codes returned by pipeline client by operation                                                                                                                            | gauge |

### Summaries

| Name                             | Description                      | Type    |
| -------------------------------- | -------------------------------- | ------- |
| jvm\_gc\_pause\_seconds          | Time spent in GC pause           | summary |
| http\_latency\_requests\_seconds | HTTP request latency in seconds. | summary |
| jdbi\_latency\_requests\_seconds | JDBI queries latency in seconds. | summary |

### Histograms

| Name                            | Description                         | Type      |
| ------------------------------- | ----------------------------------- | --------- |
| jdbi\_requests\_seconds         | jdbi requests duration distribution | histogram |
| http\_server\_requests\_seconds | HTTP requests duration distribution | histogram |
| http\_server\_requests\_sec     | HTTP methods duration               | histogram |
