TimerDecorator
Records time in milliseconds to process filters and handlers.
Decorator Usage
{
"name": string,
"type": "TimerDecorator",
"config": {
"timeUnit": string
}
} IG configures a default TimerDecorator named timer. You can use timer as the decorator name without explicitly declaring a decorator named timer.
"timeUnit": duration string, optionalUnit of time used in the decorator output. The unit of time can be any unit allowed in the
durationfield.Default:
msFor information about supported formats for
duration, see duration.
Decorated Object Usage
{
"name": string,
"type": string,
"config": object,
decorator name: boolean
}"name": string, required except for inline objectsThe unique name of the object, just like an object that is not decorated.
"type": string, requiredThe class name of the decorated object, which must be either a filter or a handler.
"config": object, required unless emptyThe configuration of the object, just like an object that is not decorated.
decorator name: boolean, requiredIG looks for the presence of the decorator name field for the TimerDecorator.
To activate the timer, set the value of the decorator name field to
true.To deactivate the TimerDecorator temporarily, set the value to
false.
Timer Metrics At the Prometheus Scrape Endpoint
This section describes the timer metrics recorded at the Prometheus Scrape Endpoint. For more information about metrics, see "Monitoring Endpoints".
When IG is set up as described in the documentation, the endpoint is http://openig.example.com:8080/openig/metrics/prometheus.
Each timer metric is labelled with the following fully qualified names:
decorated_objectheapname(decorator name)routerouter
| Name | Type [a] | Description |
|---|---|---|
| | | Time to process the request and response in the decorated handler. |
| | | Time to process the request and response 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. |
[a] As described in "Monitoring Types" | ||
Timer Metrics At the Common REST Monitoring Endpoint
This section describes the metrics recorded at the the ForgeRock Common REST Monitoring Endpoint. For more information about metrics, see "Monitoring Endpoints".
When IG is set up as described in the documentation, the endpoint is http://openig.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 | Type [a] | 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. |
[a] As described in "Monitoring Types" | ||
Timer Metrics in SLF4J Logs
SLF4J logs are named in this format:
<className>.<decoratorName>.<decoratedObjectName>
If the decorated object is not named, the object path is used in the log.
When a route's top-level handler is decorated, the timer decorator records the elapsed time for operations traversing the whole route:
2018-09-04T12:16:08,994Z | INFO | I/O dispatcher 17 | o.f.o.d.t.T.t.top-level-handler | @myroute | Elapsed time: 13 ms
When an individual handler in the route is decorated, the timer decorator records the elapsed time for operations traversing the handler:
2018-09-04T12:44:02,161Z | INFO | http-nio-8080-exec-8 | o.f.o.d.t.T.t.StaticResponseHandler-1 | @myroute | Elapsed time: 1 ms