AE REST API – AE Leistungsmetriken

Der Systemmetrik-Endpunkt ermöglicht es Ihnen, unter Verwendung von Filteroptionen historische Leistungsdaten der AE im json-Format abzufragen für:

  • Verteilung von Prozessmeldungen (MsgDist)

  • genutzte Zeit und DB-Zeiten (TimevsDB)

  • Meldungszähler für jede Meldungs-Queue (MQCount)

  • Länge der Meldungs-Queue-Tabellen (MQLength)

  • mittlere Zeit der aufgetretenen Meldungen (MsgTime)

  • aktuelle Auslastungswerte aller laufenden Prozesse (BusyValues)

  • Nutzung der JWP-Threads (JwpThreadUtilization)

Wenn Sie z. B. die genutzte Zeit und die DB-Zeiten (TimevsDB), abfragen möchten, müssen Sie den entsprechenden Typ und andere relevante Parameter an Ihre Abfrage anhängen:

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

Beispiel: 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-Antwort: 

[
  {
    "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
    }
  },
  ...
]

Welche historischen Daten zur Abfrage bereitstehen, hängt von den Erfassungs- und Speichereinstellungen ab, die für Ihr Automation Engine-System in den Leistungsparametern der Variablen UC_SYSTEM_SETTINGS festgelegt sind. Weitere Informationen finden Sie unter PERFORMANCE-Parameter.

Dieser Endpunkt ermöglicht Ihnen auch, die AE-Leistungsmetriken für die letzten scrapeIntervalSeconds im prometheus-Format abzufragen. Dazu hängen Sie /prometheus an Ihre Abfrage an, z. B.:

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

Siehe auch: