Operation: Health

The Health operation provides information on the health status of the system.

The following parameters must be set for this operation:

protocol
host
port
path

Input

This operation does not require any input.

Output with Wildfly as endpoint

With Wildfly as the endpoint, the adapter generates an XML file in the following 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>

The following elements are contained in the output with Wildfly as endpoint:

Element	Description
`<health>`	Root element for the `Health` operation.
`<item>`	The `<item>` element can contain the following elements: `<name>` `<outcome>` `<data>`
`<name>`	Name of the health check performed
`<outcome>`	Indicates whether the health check was carried out successfully and whether the examined service is running. Possible values: `true`: analyzed service is running `false`: analyzed service is not running as expected.
`<data>`	The `<data>` element can contain the following elements: `<item>` with the element `<value>` `<deployment>` for the provided software Possible values for the element `<value>`: `running`

For Wildfly, the data can also be accessed via the following URL:

http://localhost:9990/health

Output with Keycloak as endpoint

With Keycloak as the endpoint, the adapter generates an XML file in the following format:

The JSON generated from Keycloak is output as XML in X4.

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>

The following elements are contained in the output with Keycloak as the endpoint:

Element	Description
`<health>`	Root element for the `Health` operation.
`<status>`	Indicates the status. Possible values: `UP`: The service is running. `DOWN`: The service is not running.
`<checks>`	The `<checks>` element contains the `<item>` element with the `<name>` and `<status>` elements. Information on `<status>` is identical with the above information on `<status>`.
`<name>`	Name of the health check performed

For Keycloak, the data can also be accessed via the following URL:

http://localhost:8085/auth/health