---
title: Monitoring
description: The following sections describe monitoring endpoints exposed by IG, and the metrics available at the endpoints.
component: pinggateway
version: 2023.11
page_id: pinggateway:reference:Monitoring
canonical_url: https://docs.pingidentity.com/pinggateway/2026/reference/Monitoring.html
llms_txt: https://docs.pingidentity.com/pinggateway/llms.txt
docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md
revdate: 2023-01-02T16:36:04Z
superseded_by: https://docs.pingidentity.com/pinggateway/2026/reference/Monitoring.html
section_ids:
  vert_x_metrics: Vert.x Metrics
  monitoring-types: Monitoring types
  monitoring-metrics: Monitoring Endpoints
  monitoring-prom: Prometheus Scrape Endpoint
  monitoring-crest: Common REST Monitoring Endpoint
---

# Monitoring

The following sections describe monitoring endpoints exposed by IG, and the metrics available at the endpoints.

For information about how to set up and maintain monitoring, refer to [Monitor services](../maintenance-guide/monitoring.html).

## Vert.x Metrics

Vert.x metrics for HTTP clients, TCP clients, and servers are available by default at the Prometheus Scrape Endpoint and Common REST Monitoring Endpoint endpoints. Vert.x metrics provide low-level information about requests and responses, such as the number of bytes, duration, the number of concurrent requests. The available metrics are based on those described in [Vert.x core tools metrics](https://vertx.io/docs/vertx-micrometer-metrics/java/#_vert_x_core_tools_metrics).

For more information about Vert.x and IG, refer to the `vertx` object in [AdminHttpApplication (`admin.json`)](AdminHttpApplication.html), and [Monitoring Vert.x Metrics](../maintenance-guide/monitoring.html#monitor-vertx).

## Monitoring types

This section describes the data types used in monitoring:

* Counter

  Cumulative metric for a numerical value that only increases.

* Gauge

  Metric for a numerical value that can increase or decrease.

* Summary

  Metric that samples observations, providing a count of observations, sum total of observed amounts, average rate of events, and moving average rates across a sliding time window.

  The Prometheus view does not provide time-based statistics, as rates can be calculated from the time-series data. Instead, the Prometheus view includes summary metrics whose names have the following suffixes or labels:

  * `_count`: number of events recorded

  * `_total`: sum of the amounts of events recorded

  * `{quantile="0.5"}`: 50% at or below this value

  * `{quantile="0.75"}`: 75% at or below this value

  * `{quantile="0.95"}`: 95% at or below this value

  * `{quantile="0.98"}`: 98% at or below this value

  * `{quantile="0.99"}`: 99% at or below this value

  * `{quantile="0.999"}`: 99.9% at or below this value

* Timer

  Metric combining time-series summary statistics.

  Common REST views show summaries as JSON objects. JSON summaries have the following fields:

  ```json
  {
   "count": number,           // events recorded for this metric
   "max": number,             // maximum duration recorded
   "mean": number,            // total/count, or 0 if count is 0
   "min": number,             // minimum duration recorded for this metric
   "mean_rate": number,       // average rate
   "p50": number,             // 50% at or below this value
   "p75": number,             // 75% at or below this value
   "p95": number,             // 95% at or below this value
   "p98": number,             // 98% at or below this value
   "p99": number,             // 99% at or below this value
   "p999": number,            // 99.9% at or below this value
   "stddev": number,          // standard deviation of recorded durations
   "m15_rate": number,        // fifteen-minute average rate
   "m5_rate": number,         // five-minute average rate
   "m1_rate": number,         // one-minute average rate
   "duration_units": string,  // time unit used in durations
   "rate_units": string,      // event count unit and time unit used in rate
   "total": number            // sum of the durations of events recorded
  }
  ```

## Monitoring Endpoints

This section describes the monitoring endpoints exposed in IG.

### Prometheus Scrape Endpoint

All ForgeRock products automatically expose a monitoring endpoint where Prometheus can scrape metrics, in a standard Prometheus format. For information about configuring Prometheus to scrape metrics, refer to the [Prometheus website](https://prometheus.io).

When IG is set up as described in the documentation, the endpoint is <http://ig.example.com:8080/openig/metrics/prometheus>.

For information about available metrics, refer to:

* [Route metrics at the Prometheus Scrape Endpoint](Handlers.html#prom-route-metrics-prom)

* [Router metrics at the Prometheus Scrape Endpoint](Handlers.html#prom-router-metrics-prom)

* [Timer metrics At the Prometheus Scrape Endpoint](Decorators.html#timer-metrics-prom)

For an example that queries the Prometheus Scrape Endpoint, refer to [Monitor the Prometheus Scrape Endpoint](../maintenance-guide/monitoring.html#proc-monitor-prometheus).

### Common REST Monitoring Endpoint

All ForgeRock products expose a monitoring endpoint where metrics are exposed as a JSON format monitoring resource.

When IG is set up as described in the documentation, the endpoint is `http://ig.example.com:8080/openig/metrics/api?_queryFilter=true`.

For information about available metrics, refer to:

* [Route metrics at the Common REST Monitoring Endpoint](Handlers.html#prom-route-metrics-crest)

* [Router metrics at the Common REST Monitoring Endpoint](Handlers.html#prom-router-metrics-crest)

* [Timer metrics at the Common REST Monitoring Endpoint](Decorators.html#timer-metrics-api)

For an example that queries the Common REST Monitoring Endpoint, refer to [Monitor the Common REST Monitoring Endpoint](../maintenance-guide/monitoring.html#proc-monitor-plat).