Status Interface

Das BPC bietet HTTP-Schnittstellen zur Statusüberwachung an. Diese melden im positiven Fall immer eine HTTP Antwort mit dem Status 200 OK und nur darauf sollte geprüft werden.

URL* Beschreibung

URL*	Beschreibung
`/cxf/bpc-core/status`	Umfangreiche Statusinformationen über das gesamte BPC, wenn man aktuell authentifiziert ist. Manche Informationen sind nur enthalten, wenn man die Rolle "bpcAdmin" besitzt.
`/cxf/bpc-core/status/bpc`	Diese URL antwortet mit dem HTTP Status 200, wenn der Karaf läuft und sich alle BPC-Module NICHT im Status 'Resolved' befinden. 503, wenn mindestens ein BPC-Modul im Status 'Resolved' ist.
`/cxf/bpc-core/status/maintenance`	Diese URL antwortet mit dem HTTP Status 503, wenn sich das BPC im Wartungsmodus befindet. 200, wenn der Wartungsmodus nicht aktiv ist.
`/cxf/bpc-core/status/elasticsearch`	Diese URL antwortet mit dem HTTP Status 200, wenn es derzeit keine Probleme gibt. 503, in folgenden Fällen: Das BPC kann keine Verbindung zu Elasticsearch herstellen Der vom BPC verwendete ES-Client meldet, dass keine ES-Nodes zur Verfügung stehen Der Cluster-Health Gesamtstatus ist auf RED (ein ES-Admin muss das Problem manuell korrigieren)
`/cxf/bpc-core/status/health`	Zusammenfassung der einzelnen Statusabfragen (BPC Status, Wartungsmodus aktiv, Elasticsearch Status). Liefert nur dann den HTTP Status 200, wenn alle einzelnen Statusabfragen erfolgreich waren, andernfalls den jeweiligen Fehlercode.
`\* beginnend mit http://SERVERADRESSE:PORT oder https://SERVERADRESSE:PORT`

/cxf/bpc-core/status

Umfangreiche Statusinformationen über das gesamte BPC, wenn man aktuell authentifiziert ist. Manche Informationen sind nur enthalten, wenn man die Rolle "bpcAdmin" besitzt.

/cxf/bpc-core/status/bpc

Diese URL antwortet mit dem HTTP Status 200, wenn der Karaf läuft und sich alle BPC-Module NICHT im Status 'Resolved' befinden.
503, wenn mindestens ein BPC-Modul im Status 'Resolved' ist.

/cxf/bpc-core/status/maintenance

Diese URL antwortet mit dem HTTP Status 503, wenn sich das BPC im Wartungsmodus befindet.
200, wenn der Wartungsmodus nicht aktiv ist.

/cxf/bpc-core/status/elasticsearch

Diese URL antwortet mit dem HTTP Status 200, wenn es derzeit keine Probleme gibt. 503, in folgenden Fällen:

Das BPC kann keine Verbindung zu Elasticsearch herstellen
Der vom BPC verwendete ES-Client meldet, dass keine ES-Nodes zur Verfügung stehen
Der Cluster-Health Gesamtstatus ist auf RED (ein ES-Admin muss das Problem manuell korrigieren)

/cxf/bpc-core/status/health

Zusammenfassung der einzelnen Statusabfragen (BPC Status, Wartungsmodus aktiv, Elasticsearch Status).
Liefert nur dann den HTTP Status 200, wenn alle einzelnen Statusabfragen erfolgreich waren, andernfalls den jeweiligen Fehlercode.

\* beginnend mit http://SERVERADRESSE:PORT oder https://SERVERADRESSE:PORT

Noch eine Info zu den 'currentBpcProblems' die im JSON vom /cxf/bpc-core/status-Endpunkt zurückgeliefert werden:

es werden hier nicht alle aufgetretenen Exceptions hinterlegt, sondern nur ein paar spezielle beim Start des Backend-Cores.
bei den Exceptions handelt es sich nur um Exceptions die im Backend Core Bundle aufgetreten sind. Also nicht, wenn der Monitor etc. ein Problem hat.
es werden maximal die 12 zuletzt aufgetretenen Exceptions vorgehalten. Ältere fliegen automatisch aus der Liste.
die 12er Liste wird nicht persistiert
die 12er Liste ist nur bei einem Karaf-Neustart bzw. Neustart des Backend-Cores mal wieder leer
Wenn eine Exceptions mehrfach auftritt, dann ist sie auch mehrfach - mit unterschiedlichen Timestamps - vorhanden (max 12 Stück)

Das Feld 'currentBpcProblems' wird in Zukunft entfernt bzw. durch eine sinnvollere Lösung ersetzt.

Keywords: