Monitoring configuration can be done via Rest-Api calls. Basic Authorisation is used.

Metric definition

parameter description
name name of the metric
type count, license, value
interval Optional interval in seconds in which the metric is validated. Defaults to global value.

Sample metric:

1
2
3
4
5
6
7
 {
    "name" : "People",
    "type" : "count",
    "form" : "CTM:People",
    "query": "'Profile Status'=\"Enabled\"",
    "interval" : 5
 }

Metric types

Two types of metrics types are available:

  • count
  • license
  • value

count

Executes a query against an AR System and validates the resultlist of the query.

license

Executes a query against an AR System Form “AR System Current License Usage” and sums the values per user. Valid queries are “floating” or “fixed”.

For license metrics to work you need to have license tracking enabled.

AR System Administration Console -> Server Information -> Configuration -> License Tracking

value

Executes a query against an AR System and returns the value of a field. Only Integer and Float Values can be used. If the query returns more than one record, the first record will be used.

The configuration option field is required for this metric.

Sample metric:

1
2
3
4
5
6
7
8
 {
    "name" : "People",
    "type" : "value",
    "form" : "CTM:People",
    "query": "'Remedy Login ID'=\"Allen\"",
    "field": "Corporate ID"
    "interval" : 5
 }

Get all metrics

Operation: Get

Url: https://your.armonitor.url/metrics

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
[ 
    { 
        "name": "SocialBridge", 
        "type": "count", 
        "form": "SHR:SHRCAI_SocialBridge", 
        "query": "'Status' < \"Completed\" AND 'Modified Date' < ($TIMESTAMP$ - 300)", 
        "interval": 30 
    }, 
    { 
        "name": "AI_ApprovalComments", 
        "type": "count", 
        "form": "UDM:JobLog", 
        "query": "'Job Name' = \"Approval Comment\" AND 'Create Date' > ($TIMESTAMP$ - 1800)", 
        "interval": 30 
    }
] 

The response also contains a lastRun object for every metric that has run since the process started, see “Run status of a metric” below.

Get a single metric

Operation: Get

Url: https://your.armonitor.url/metrics/SocialBridge

Response:

1
2
3
4
5
6
7
{ 
    "name": "SocialBridge", 
    "type": "count", 
    "form": "SHR:SHRCAI_SocialBridge", 
    "query": "'Status' < \"Completed\" AND 'Modified Date' < ($TIMESTAMP$ - 300)", 
    "interval": 30 
}

Add a new metric

Operation: Post

Url: https://your.armonitor.url/metrics

Request:

1
2
3
4
5
6
7
{ 
    "name": "SocialBridge", 
    "type": "count", 
    "form": "SHR:SHRCAI_SocialBridge", 
    "query": "'Status' < \"Completed\" AND 'Modified Date' < ($TIMESTAMP$ - 300)", 
    "interval": 30 
}

Response:

1
2
3
4
5
6
7
8
9
10
{
    "status": "success",
    "data": { 
        "name": "SocialBridge", 
        "type": "count", 
        "form": "SHR:SHRCAI_SocialBridge", 
        "query": "'Status' < \"Completed\" AND 'Modified Date' < ($TIMESTAMP$ - 300)", 
        "interval": 30 
    }
}

Change an existing metric

Operation: Put

Url: https://your.armonitor.url/metrics/SocialBridge

Request:

1
2
3
4
5
6
7
{ 
    "name": "SocialBridge", 
    "type": "count", 
    "form": "SHR:SHRCAI_SocialBridge", 
    "query": "'Status' < \"Completed\" AND 'Modified Date' < ($TIMESTAMP$ - 900)", 
    "interval": 90 
}

Response:

1
2
3
4
5
6
7
8
9
10
{
    "status": "success",
    "data": { 
        "name": "SocialBridge", 
        "type": "count", 
        "form": "SHR:SHRCAI_SocialBridge", 
        "query": "'Status' < \"Completed\" AND 'Modified Date' < ($TIMESTAMP$ - 900)", 
        "interval": 90 
    }
}

Delete a metric

Operation: Delete

Url: https://your.armonitor.url/metrics/SocialBridge

Response:

1
2
3
4
{
    "status": "success",
    "message": "metric deleted"
}

An unknown metric is answered with 404 and {"status": "error", "message": "Metric SocialBridge not found."} when it is read. Changing (PUT) a metric validates it like POST (400 on errors) and does not create unknown metrics (400).

Deleting a metric removes its series from /prometheus/metrics.

Names, renaming and series

  • A successful PUT removes all series of the metric; they are created again by the next run, so old label values (e.g. the old query) disappear.
  • PUT with a different name in the body renames the metric (position in the configuration is kept, series and lastRun of the old name are removed). A name that already exists is answered with 400 and {"status": "error", "message": "Metric <name> does already exist."}.
  • A metric is not started again while its previous run is still in flight.
  • The Prometheus name is armonitor_<name>; characters other than a-zA-Z0-9_: become _ (only in the Prometheus name). Two metrics with the same resulting name: the second reports a lastRun error.

Export options

Environment variables (defaults keep the export format unchanged):

  • GROUPCOUNT_RESET=true: groups that are no longer in the data disappear from a groupCount metric.
  • LICENSE_DETAILS=legacy|labels|both: labels exports one gauge per license metric, e.g.

    armonitor_lic_by_application{type="license",query="fixed",form="undefined",interval="30",application="Remedy Mid-Tier"} 1
    
  • RAPI_PAGE_SIZE (default 2000): groupCount and license metrics read all entries page by page (countOnly for the total, then sort=1&firstEntry=<n>&maxEntries=<RAPI_PAGE_SIZE>). If the backend does not support paging, only the first page is used and lastRun.message says Result limited to <n> entries (RAPI paging not supported).
  • AR_PORT is optional; without it no port parameter is sent.

Special characters in queries

Forms and queries are percent-encoded when they are sent to RAPI (%, #, ? and non-ASCII characters as UTF-8). A / in a query is sent as it is. Known limitations: a \ is not supported by RAPI, ? in a qualification may be decoded and truncated by a reverse proxy in front of RAPI (the same applies to %2F), so avoid it.

Run status of a metric

Operation: Get

Url: https://your.armonitor.url/metrics/SocialBridge

Every metric that has run since the process started contains a lastRun object:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
    "status": "success",
    "data": {
        "name": "SocialBridge",
        "type": "count",
        "form": "SHR:SHRCAI_SocialBridge",
        "query": "'Status' < \"Completed\" AND 'Modified Date' < ($TIMESTAMP$ - 300)",
        "interval": 30,
        "lastRun": {
            "at": "2026-10-09T20:15:00.000Z",
            "status": "ok",
            "value": 42,
            "dataSize": 42,
            "runTime": 120,
            "message": null
        }
    }
}
  • status is ok or error. On error message is set (sanitized, at most 500 characters) and value is null.
  • value is the number of records for count and groupCount, the numeric field value for value and the total license count for license.
  • lastRun is absent until the metric has run, and after a change or delete of the metric until the next run.
  • lastRun is kept in memory per pod and never written to conf/metrics.json. A lastRun in the body of POST/PUT is ignored.
  • Invalid entries of conf/metrics.json are listed with lastRun.status error and the message Invalid configuration: ....

Test a metric

Operation: Post

Url: https://your.armonitor.url/metrics/test

Runs the query once without saving anything. Nothing is exported and lastRun stays unchanged. name and interval are optional and ignored. The time limit is 30 seconds.

Request:

1
2
3
4
5
{
    "type": "count",
    "form": "SHR:SHRCAI_SocialBridge",
    "query": "'Status' < \"Completed\""
}

Response (200, also when Remedy reports an error; check data.status):

1
2
3
4
5
6
7
8
9
10
11
{
    "status": "success",
    "data": {
        "at": "2026-10-09T20:15:00.000Z",
        "status": "ok",
        "value": 42,
        "dataSize": 42,
        "runTime": 120,
        "message": null
    }
}

An invalid configuration (structure, unknown form) is answered with 400 and {"status": "error", "message": "..."}.

Monitor status

Operation: Get

Url: https://your.armonitor.url/status

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "status": "success",
    "data": {
        "version": "1.21.0",
        "startedAt": "2026-10-09T20:00:00.000Z",
        "lastTick": "2026-10-09T20:15:01.000Z",
        "tickSeconds": 1,
        "metrics": 12,
        "running": 2,
        "errors": 1,
        "now": "2026-10-09T20:15:01.250Z"
    }
}

metrics counts all entries of conf/metrics.json (invalid ones included), running the scheduler runs in flight and errors the metrics with a failed last run plus the invalid entries. The values are per pod and in memory only.