Scheduler metrics
Before you can use scheduler metrics, you must enable metrics. For the complete list of scheduler metrics, refer to API scheduler metrics available in IDM.
Example scheduler metrics
scheduler.trigger.acquired.success
Request
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Accept-API-Version: resource=1.0" \ --request GET \ 'http://localhost:8080/openidm/metrics/api?_queryFilter=/_id+eq+"scheduler.trigger.acquired.success"'
Response
{
"result": [
{
"_id": "scheduler.trigger.acquired.success",
"m15_rate": 1.3331465689081097,
"m1_rate": 1.0309301543856877,
"m5_rate": 1.2318064768948462,
"mean_rate": 1.0258321337261471,
"units": "events/second",
"total": 183,
"count": 183,
"_type": "summary"
}
],
"resultCount": 1,
"pagedResultsCookie": null,
"totalPagedResultsPolicy": "EXACT",
"totalPagedResults": 1,
"remainingPagedResults": -1
}scheduler.trigger.fired
Request
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Accept-API-Version: resource=1.0" \ --request GET \ 'http://localhost:8080/openidm/metrics/api?_queryFilter=/_id+eq+"scheduler.trigger.fired"'
Response
{
"result": [
{
"_id": "scheduler.trigger.fired",
"m15_rate": 1.1575004755551879,
"m1_rate": 1.0055565867908252,
"m5_rate": 1.0976754941332376,
"mean_rate": 1.0083534436743353,
"units": "events/second",
"total": 224,
"count": 224,
"_type": "summary"
}
],
"resultCount": 1,
"pagedResultsCookie": null,
"totalPagedResultsPolicy": "EXACT",
"totalPagedResults": 1,
"remainingPagedResults": -1
}scheduler.job.job-group.job-name.executed
The following example retrieves the metric for an executed schedule with the following details:
-
job-group =
scheduler-service-group -
job-name =
script
Request
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Accept-API-Version: resource=1.0" \ --request GET \ 'http://localhost:8080/openidm/metrics/api?_queryFilter=/_id+eq+"scheduler.job.scheduler-service-group.script.executed"'
Response
{
"result": [
{
"_id": "scheduler.job.scheduler-service-group.script.executed",
"count": 391,
"max": 17.04553,
"mean": 1.3264534620189976,
"min": 0.524604,
"p50": 1.3127419999999999,
"p75": 1.555721,
"p95": 1.7416239999999998,
"p98": 1.898285,
"p99": 2.075185,
"p999": 2.4402909999999998,
"stddev": 0.39220923689155185,
"m15_rate": 1.1311176673815566,
"m1_rate": 1.000355220709147,
"m5_rate": 1.056353857818992,
"mean_rate": 1.0048492196855094,
"duration_units": "milliseconds",
"rate_units": "calls/second",
"total": 580.803062,
"_type": "timer"
}
],
"resultCount": 1,
"pagedResultsCookie": null,
"totalPagedResultsPolicy": "EXACT",
"totalPagedResults": 1,
"remainingPagedResults": -1
}scheduler.job.job-group.job-name.completed
The following example retrieves the metric for a completed schedule with the following details:
-
job-group =
scheduler-service-group -
job-name =
script
Request
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Accept-API-Version: resource=1.0" \ --request GET \ 'http://localhost:8080/openidm/metrics/api?_queryFilter=/_id+eq+"scheduler.job.scheduler-service-group.script.completed"'
Response
{
"result": [
{
"_id": "scheduler.job.scheduler-service-group.script.completed",
"m15_rate": 1.2596544396953329,
"m1_rate": 1.0147166389216893,
"m5_rate": 1.1109942946670412,
"mean_rate": 1.0036465219104702,
"units": "events/second",
"total": 398,
"count": 398,
"_type": "summary"
}
],
"resultCount": 1,
"pagedResultsCookie": null,
"totalPagedResultsPolicy": "EXACT",
"totalPagedResults": 1,
"remainingPagedResults": -1
}