AE REST API - AE Performance Metrics

The system metrics endpoint allows you to retrieve AE historic performance data in json format using filter options for:

distribution of processes messages (MsgDist)
used time and DB times (TimevsDB)
message count for each message queue (MQCount)
length of the message queue tables (MQLength)
mean time of occurred messages (MsgTime)
current busy values of all running processes (BusyValues)
utilization of the JWP threads (JwpThreadUtilization)

For example, if you want to get the used time and DB times (TimevsDB), make sure append the relevant type and other relevant parameters to your query:

Request: GET http://{host}:{port}/ae/api/v1/{client}/system/metrics?type={type}&time_frame_from={from}&time_frame_to={to}

Example: http://10.49.161.5:8088/ae/api/v1/0/system/metrics?type=TimevsDB&time_frame_from=2021-07-01T00%3A00%3A00Z&time_frame_to=2021-08-02T00%3A00%3A00Z

HTTP 200 Response:

[
  {
    "idnr": 1042712,
    "type": "TimevsDB",
    "timestamp": "2021-07-05T10:13:18Z",
    "wp_name": "AUTOMIC#WP004",
    "tcp_ip_addr": "10.0.0.16",
    "srv_type": "PWP",
    "interval": 1,
    "values": {
      "time": 94.0,
      "db": 51.0
    }
  },
  ...
]

The historic data available for retrieval depends on the collection and storage settings defined for your Automation Engine system in the performance parameters of the UC_SYSTEM_SETTINGS variable. For more information, see PERFORMANCE Parameters.

This endpoint also allows you to retrieve AE performance metrics for the last scrapeIntervalSeconds using the prometheus format. To do so, make sure you append /prometheus to your request, for example:

Request: GET http://{host}:{port}/ae/api/v1/{client}/system/metrics/prometheus