Platform Metrics
Platform Metrics
Overview
From version 2.3.0 platform stores various metrics into InfluxDB. Installation package contains Grafana UI and pre-defined dashboards for metrics representations.
https://<ControlServerAddress>/grafana/
Some of dashboards are intended to be presented in Control Server UI and some of them you can use as a sample template for you own dashboards.
Here are the metrics reference guide.
Task Run metrics
rpaplatform_task - counter
Triggers every time (ones), when Automation process run change its status. Value always 1.
rpaplatform_task_time - counter
Triggers every time (ones), when Automation process run change its status. Value contains milliseconds from the last status change.
Task run metrics tags
| tag | description |
|---|---|
| ap_id | Automation Process id. |
| ap_uuid | Automation Process UUID |
| ap_name | Automation Process name |
| run_id | Automation Process Run id. |
| run_uuid | Automation Process Run uuid. |
| task_uuid | Optional. Task UUID, if record represents task run. |
| task_class | Optional. Task class name, if record represents task run. |
| node_id | Optional. Node id, if node already assigned. |
| node_name | Optional. Node name, if node already assigned. |
| task_status | Automation Process Run status. SUBMITTED, QUEUED, DEPLOYING_ON_NODE, IN_PROGRESS, STOPPING, STOPPED, FAILED, COMPLETED, STOPPED_IDLE |
| task_type | task or module. Task or Automation Process run |
Human Task Metrics
rpaplatform_htask - counter
Triggers every time (ones), when Human Task change its status. Value always 1.
rpaplatform_htask_time - counter
Triggers every time (ones), when Human Task change its status. Value contains milliseconds from the last status change.
Human Task metrics tags
| tag | description |
|---|---|
| ap_id | Automation Process id. |
| ap_uuid | Automation Process UUID |
| ap_name | Automation Process name |
| run_id | Automation Process Run id. |
| run_uuid | Automation Process Run uuid. |
| task_uuid | Optional. Task UUID, if record represents task run. |
| task_class | Optional. Task class name, if record represents task run. |
| node_id | Optional. Node id, if node already assigned. |
| node_name | Optional. Node name, if node already assigned. |
| htask_status | Human Task status. AVAILABLE, IN_PROGRESS, COMPLETED, STOPPED |
| user_name | Name of user who perform human task action. |
| user_id | Id of user who perform human task action. |
Node Metrics
rpaplatform_node_cpu - gauge
Triggers every minute with value = number of node CPUs.
rpaplatform_node_cpu_usage - gauge
Triggers every minute with value = node's cpu usage.
rpaplatform_node_memory_free - gauge
Triggers every minute with value = node's free memory.
rpaplatform_node_memory_total - gauge
Triggers every minute with value = node's total memory.
rpaplatform_node_free_ui_executors - gauge
Triggers every minute with value = free node's desktop executors.
rpaplatform_node_free_task_executors - gauge
Triggers every minute with value = free node's task executors.
Node metrics tags
| tag | description |
|---|---|
| node_id | Node id. |
| node_name | Node name. |
rpaplatform_queue - counter
Triggers for every OCR or ML queue operation.
Node metrics tags
| tag | description |
|---|---|
| ap_id | Automation Process id. |
| ap_uuid | Automation Process UUID |
| ap_name | Automation Process name |
| run_id | Automation Process Run id. |
| run_uuid | Automation Process Run uuid. |
| queue_name | Queue name: ML, OCR |
| queue_operation | Queue operation: send, receive |
Docker Container metrics
Telegraf docker plugin is using to collect metrics. Please refer to the plugin documentation for metric specification.
https://github.com/influxdata/telegraf/tree/master/plugins/inputs/docker
ActiveMQ metrics
Telegraf ActiveMQ plugin is using to collect metrics. Please refer to the plugin documentation for metric specification.
https://github.com/influxdata/telegraf/tree/master/plugins/inputs/activemq