Metrics at the Common REST Monitoring Endpoint (deprecated)
The Common REST Monitoring Endpoint exposes metrics as a JSON format monitoring resource.
When PingGateway is set up as described in the documentation, the endpoint
is http://ig.example.com:8080/openig/metrics/api?_queryFilter=true.
For an example that queries the Common REST Monitoring Endpoint, refer to Monitor the Common REST Monitoring Endpoint.
Route metrics at the Common REST Monitoring Endpoint (deprecated)
Route metrics at the Common REST Monitoring Endpoint are published with an _id in the
following pattern:
-
heap.router-name.route.route-name.metric
The following table summarizes the recorded metrics:
| Name | Monitoring type | Description |
|---|---|---|
|
Counter |
Number of requests processed by the router or route since it was deployed. |
|
Gauge |
Number of requests being processed by the router or route at this moment. |
|
Counter |
Number of responses that threw an exception. |
|
Counter |
Number of responses that were not handled by PingGateway. |
|
Counter |
Number of responses with an HTTP status code |
|
Counter |
Number of responses with an HTTP status code |
|
Counter |
Number of responses with an HTTP status code |
|
Counter |
Number of responses with an HTTP status code |
|
Counter |
Number of responses with an HTTP status code |
|
Counter |
Number of responses with an HTTP status code |
|
Timer |
Time-series summary statistics. |
Learn more in Common REST Monitoring Endpoint.
Router metrics at the Common REST Monitoring Endpoint (deprecated)
Router metrics at the Common REST Monitoring Endpoint are JSON objects, with the following form:
-
[heap name].[router name].deployed-routes
The following table summarizes the recorded metrics:
| Name | Monitoring type | Description |
|---|---|---|
|
|
Number of routes deployed in the configuration. |
For more information about the the Common REST Monitoring Endpoint, refer to Common REST Monitoring Endpoint.
Timer metrics at the Common REST Monitoring Endpoint (deprecated)
This section describes the metrics recorded at the the ForgeRock Common REST Monitoring Endpoint.
When PingGateway is set up as described in the documentation, the endpoint is http://ig.example.com:8080/openig/metrics/api?_queryFilter=true.
Metrics are published with an _id in the following pattern:
heap.router-name.route-name.decorator-name.object
| Name | Monitoring type | Description |
|---|---|---|
|
|
Time to process the request and response in the decorated handler, or in the decorated filter and its downstream filters and handler. |
|
|
Time to process the request and response in the decorated filter. |
|
|
Time to process the request and response in filters and handlers that are downstream of the decorated filter. |