Operation: Health

Die Operation Health liefert Information zum Gesundheitszustand des Systems.

Für diese Operation müssen die folgenden Parameter gesetzt werden:

protocol
host
port
path

Input

Für diese Operation ist kein Input erforderlich.

Output mit wildfly als Endpunkt

Mit wildfly als Endpunkt generiert der Adapter eine XML-Datei in folgendem Format:

CODE

<?xml version="1.0" encoding="UTF-8"?>
<health>
	<item>
		<name>suspend-state</name>
		<outcome>true</outcome>
		<data>
			<item>
				<value>RUNNING</value>
			</item>
		</data>
	</item>
	<item>
		<name>server-state</name>
		<outcome>true</outcome>
		<data>
			<item>
				<value>running</value>
			</item>
		</data>
	</item>
	<item>
		<name>deployments-status</name>
		<outcome>true</outcome>
		<data>
			<deployment>
				<x4-7.4.0-SNAPSHOT.ear>OK</x4-7.4.0-SNAPSHOT.ear>
			</deployment>
			<deployment>
				<X4ControlCenter-7.4.0-SNAPSHOT.war>OK</X4ControlCenter-7.4.0-SNAPSHOT.war>
			</deployment>
		</data>
	</item>
	<item>
		<name>boot-errors</name>
		<outcome>true</outcome>
	</item>
	<item>
		<name>live-server</name>
		<outcome>true</outcome>
	</item>
	<item>
		<name>started-server</name>
		<outcome>true</outcome>
	</item>
	<item>
		<outcome>true</outcome>
	</item>
</health>

Folgende Elemente sind im Output mit wildfly als Endpunkt enthalten:

Element	Beschreibung
`<health>`	Wurzelelement für die Operation `Health`.
`<item>`	Das Element `<item>` kann folgende Elemente enthalten: `<name>` `<outcome>` `<data>`
`<name>`	Name des durchgeführten Health-Checks
`<outcome>`	Gibt an, ob der Health-Check erfolgreich ausgeführt wurde und ob der untersuchte Dienst läuft. Mögliche Werte: `true`: untersuchter Dienst läuft `false`: untersuchter Dienst läuft nicht wie erwartet.
`<data>`	Das Element `<data>` kann folgende Elemente beinhalten: `<item>` mit dem Element `<value>` `<deployment>` für die bereitgestellte Software Mögliche Werte für das Element value: `running`

Für wildfly können die Daten auch über folgende URL aufgerufen werden:

http://localhost:9990/health

Output mit Keycloak als Endpunkt

Mit Keycloak als Endpunkt generiert der Adapter eine XML-Datei in folgendem Format:

Das von Keycloak generierte JSON wird in X4 als XML ausgegeben.

CODE

<?xml version="1.0" encoding="UTF-8"?>
<health>
   <status>UP</status>
   <checks>
      <item>
         <name>Keycloak database connections health check</name>
         <status>UP</status>
      </item>
   </checks>
</health>

Folgende Elemente sind im Output mit Keycloak als Endpoint enthalten:

Element	Beschreibung
`<health>`	Wurzelelement für die Operation `Health`.
`<status>`	Gibt den Status an. Mögliche Werte: `UP`: Der Dienst läuft. `DOWN`: Der Dienst läuft nicht.
`<checks>`	Das Element `<checks>` enthält das Element `<item>` mit den Elementen `<name>` und `<status>`. Information zu `<status>` ist identisch mit obiger Information zu `<status>`.
`<name>`	Name des durchgeführten Health-Checks

Für Keycloak können die Daten auch über folgende URL aufgerufen werden:

http://localhost:8085/auth/health