MicroProfile Metrics Reader: Functionality and Operation

The MicroProfile Metrics Reader can be used to access real-time data that describes the status and utilization of the addressed system. The real-time data forms the basis for technical monitoring and is provided by various systems and applications in the standardized MicroProfile Metrics format for further processing.

The MicroProfile Metrics Reader can be used for the following endpoints:

Keycloak:

<Path to Keycloak>/auth/metrics
<Path to Keycloak>/auth/health
Example: http://localhost:8085/auth/metrics

For Keycloak, the keycloak.conf file in the <X4Server>\keycloak\conf\keycloak.conf folder must contain the following lines:

NONE

# If the server should expose metrics and healthcheck endpoints.
metrics-enabled=true
health-enabled=true

Further information on Keycloak Health Checks can be found in the official Keycloak documentation:

https://www.keycloak.org/server/health

wildfly:

<Path to wildfly>/metrics
<Path to wildfly>/health
Example: http://localhost:9990/metrics

Further information on wildfly Health Checks can be found here (no guarantee for content of external links):

Properties

Operation

Defines the operation executed by the adapter.

Possible values:

Health: Provides information on the health status of the system.
ListMetrics: Returns all measurement data of the system.
Info: Generates an output with filtered measurement data of the system. The filters are defined in the input.

Parameters

`Adapter`	Main adapter class (do not change!) Possible values: de.softproject.integration.nativeadapter.NativeAdapter: Main class (Default)
`repository`	The virtual repository of the adapter project. Possible values: 12c0441f-ea9f-4ebe-9467-5f885bd1d1e3 (Default)
`protocol`	Used protocol (HTTP oder HTTPS) Possible values: `http`: Use HTTP (no encryption) (Default) `https`: Use HTTPS (SSL-encrypted)
`host`	IP address or host name of the physical server. Note: The `host` parameter adds an `HTTP-Header` named `host`. Possible values: Any valid character string without protocol specification (e. g. `localhost`)
`port`	Port number of the HTTP(S) service. With -1, the port is set automatically. Possible values: Any integer `-1`: The port is set automatically. `8085`: Default port for wildfly `9990`: Default port for Keycloak
`path`	Folder path on the server, starting with a slash. Possible values: Path to the endpoint Example for Keycloak: `/auth/health` `/auth/metrics` Example for wildfly: `/health` `/metrics`
`username`	User name for basic authentication, if required by the provider. Possible values: Any string
`password`	Password for basic authentication, if required by the provider. Possible values: Any string

Status values

`1`	The operation was executed successfully.
`0`	The operation was executed successfully, but without result.
`-1`	The operation failed due to an error.