MicroProfile Metrics Reader: Funktionen und Operationen

Mit dem MicroProfile Metrics Reader kann auf Echtzeitdaten zugegriffen werden, die den Zustand und die Auslastung des angesprochenen Systems beschreiben. Die Echtzeitdaten bilden die Grundlage für die technische Überwachung und werden von verschiedenen Systemen und Anwendungen im standardisierten MicroProfile Metrics-Format zur Weiterverarbeitung bereitgestellt.

Der MicroProfile Metrics Reader kann für folgende Endpunkte verwendet werden:

Keycloak:

<Pfad zu keycloak>/auth/metrics
<Pfad zu keycloak>/auth/health
Bsp. http://localhost:8085/auth/metrics

Für Keycloak muss die Datei keycloak.conf im Ordner <X4Server>\keycloak\conf\keycloak.conf folgende Zeilen enthalten:

NONE

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

Weitere Informationen zu Keycloak Health Checks finden Sie in der offiziellen Keycloak-Dokumentation:

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

wildfly:

<Pfad zu wildfly>/metrics
<Pfad zu wildfly>/health
Bsp. http://localhost:9990/metrics

Weitere Informationen zu wildfly Health Checks finden Sie hier (Angaben ohne Gewähr):

Eigenschaften (Properties)

Operation

Hier legen Sie fest, welche Operation der Adapter ausführt.

Mögliche Werte:

Health: Liefert Information zum Gesundheitszustand des Systems.
ListMetrics: Gibt alle Messdaten des Systems zurück.
Info: Erzeugt einen Output mit gefilterten Messdaten des Systems. Die Filter werden im Input festgelegt.

Parameter

`Adapter`	Hauptklasse des Adapters (nicht verändern!) Mögliche Werte: de.softproject.integration.nativeadapter.NativeAdapter: Hauptklasse (Standard)
`repository`	Das virtuelle Repository des Adapterprojekts. Mögliche Werte: 12c0441f-ea9f-4ebe-9467-5f885bd1d1e3 (Default)
`protocol`	Verwendetes Protokoll (HTTP oder HTTPS) Mögliche Werte: `http`: HTTP (unverschlüsselt) verwenden (Standard) `https`: HTTPS (SSL-verschlüsselt) verwenden
`host`	IP-Adresse oder Host-Name des physikalischen Servers. Hinweis: Der Parameter `host` fügt einen `HTTP-Header` namens `host` hinzu. Mögliche Werte: Beliebige gültige Zeichenkette ohne Protokollangabe (z.B. `localhost`)
`port`	Portnummer des HTTP(S)-Dienstes. Bei `-1` wird der Port automatisch gesetzt. Mögliche Werte: Beliebige ganze Zahl `-1`: Der Port wird automatisch gesetzt. `8085`: Standardport für wildfly `9990`: Standardport für Keycloak
`path`	Ordnerpfad auf dem Server, beginnend mit einem Schrägstrich. Mögliche Werte: Pfad zum Endpunkt Beispiel für Keycloak: `/auth/health` `/auth/metrics` Beispiel für wildfly: `/health` `/metrics`
`username`	Benutzername für die Basisauthentifizierung, wenn der Anbieter dies verlangt. Mögliche Werte: Beliebige Zeichenkette
`password`	Passwort für die Basisauthentifizierung, wenn der Anbieter dies verlangt. Mögliche Werte: Beliebige Zeichenkette

Statuswerte

`1`	Die Operation wurde erfolgreich ausgeführt.
`0`	Die Operation wurde erfolgreich ausgeführt, jedoch ohne Ergebnis.
`-1`	Die Operation konnte nicht ausgeführt werden.