Monitoring Api

Die Monitoring Api ist der einfachste Weg, um an Laufzeitdaten zu kommen. Über diese API ist es möglich, die Laufzeitdaten der Engine abzufragen. Die Daten werden in einem In-Memory-Datenspeicher gespeichert.

Konfiguration

Der Engine Docker Container muss mit folgenden Einstellungen gestartet werden, um die Monitoring API zu verwenden:


environment:
    - monitoringApiExtension__exposeEndpoint=true
volumes:
    - ./extensions/monitoringApi:/extensions/monitoringApi

Mit der Umgebungsvariable monitoringApiExtension__exposeEndpoint wird gesteuert, ob die Extension beim Start der Engine geladen werden soll.

Endpunkte

Die Extension stellt verschiedene HTTP Endpunkte bereit, um erfasste Metriken auszulesen.

Diese Endpunkte laufen über dieselbe Adresse über welche auch die Engine selbst erreichbar ist.

Methode	HTTP Request
flownodeDurationInMs	GET /monitoring/flownode_duration_in_ms
flownodesFinished	GET /monitoring/flownodes_finished
processDurationInMs	GET /monitoring/process_duration_in_ms
processesFailed	GET /monitoring/processes_failed
processesFinished	GET /monitoring/processes_finished
processesRunning	GET /monitoring/processes_running

Beispiel CURL

Ein beispielhafter Curl-Befehl für den Endpunkt flownodeDurationInMs könnte für eine unter localhost:8000 laufende Engine folgendermaßen aussehen:


curl -X GET http://localhost:8000/monitoring/flownode_duration_in_ms

flownodeDurationInMs

Gibt eine Liste mit Flow Nodes und deren Dauer zurück.

Parameter

Name	Typ	Hinweis
processModelId	string	optional

Rückgabetyp

Name	Typ
name	string
help	string
value	array

Datenobjekt (Value)

Name	Typ
timestamp	string
processModelId	string
processModelName	string
flowNodeId	string
flowNodeName	string
value	integer

Autorisierung

Es wird keine Autorisierung benötigt.

HTTP Request Header

Der HTTP Request Header erlaubt das Format application/json.

flownodesFinished

Gibt eine Liste mit beendeten Flow Nodes und deren Anzahl zurück.

Parameter

Name	Typ	Hinweis
processModelId	string	optional
flowNodeId	string	optional

Rückgabetyp

Name	Typ
name	string
help	string
value	array

Datenobjekt (Value)

Name	Typ
timestamp	string
processModelId	string
processModelName	string
flowNodeId	string
flowNodeName	string
value	integer

Autorisierung

Es wird keine Autorisierung benötigt.

HTTP Request Header

Der HTTP Request Header erlaubt das Format application/json.

processDurationInMs

Gibt eine Liste mit Prozessen und deren Dauer zurück.

Parameter

Name	Typ	Hinweis
processModelId	string	optional

Rückgabetyp

Name	Typ
name	string
help	string
value	array

Datenobjekt (Value)

Name	Typ
timestamp	string
processModelId	string
processModelName	string
value	integer

Autorisierung

Es wird keine Autorisierung benötigt.

HTTP Request Header

Der HTTP Request Header erlaubt das Format application/json.

processesFailed

Gibt eine Liste mit den fehlerhaften Prozessen und deren Anzahl zurück.

Parameter

Name	Typ	Hinweis
processModelId	string	optional

Rückgabetyp

Name	Typ
name	string
help	string
value	array

Datenobjekt (Value)

Name	Typ
timestamp	string
processModelId	string
processModelName	string
endEventId	string
endEventName	string
value	integer

Autorisierung

Es wird keine Autorisierung benötigt.

HTTP Request Header

Der HTTP Request Header erlaubt das Format application/json.

processesFinished

Gibt eine Liste mit den beendeten Prozessen und deren Anzahl zurück.

Parameter

Name	Typ	Hinweis
processModelId	string	optional

Rückgabetyp

Name	Typ
name	string
help	string
value	array

Datenobjekt (Value)

Name	Typ
timestamp	string
processModelId	string
processModelName	string
endEventId	string
endEventName	string
value	integer

Autorisierung

Es wird keine Autorisierung benötigt.

HTTP Request Header

Der HTTP Request Header erlaubt das Format application/json.

processesRunning

Gibt eine Liste mit den aktiven Prozessen und deren Anzahl zurück.

Parameter

Name	Typ	Hinweis
processModelId	string	optional

Rückgabetyp

Name	Typ
name	string
help	string
value	array

Datenobjekt (Value)

Name	Typ
timestamp	string
processModelId	string
processModelName	string
value	integer

Autorisierung

Es wird keine Autorisierung benötigt.

HTTP Request Header

Der HTTP Request Header erlaubt das Format application/json.