Operation: Info

Die Operation Info erzeugt einen Output mit gefilterten Messdaten des Systems. Die Filter werden im Input festgelegt. Für diese Operation wird der Endpunkt metrics verwendet.

Zudem müssen die folgenden Parameter gesetzt werden:

protocol
host
port
path

Input

Der Adapter erwartet als Input eine XML-Datei im folgenden Format:

CODE

<?xmlversion="1.0"encoding="UTF-8"?>
<filter>
  <types>
    <value>gauge</value>
    <value></value>
  </types>
  <keyBeginsWith>
    <value>vendor</value>
    <value></value>
  </keyBeginsWith>
  <keyContains>
    <value>used</value>
    <value></value>
  </keyContains>
</filter>

Folgende Elemente sind im Input enthalten:

Element	Beschreibung
`<filter>`	Wurzelelement für die Operation `Info`.
`<types>`	Art der Messung. Enthält das Element `value`. Mögliche Werte für das Element `value`: `gauge` `counter`
`<keyBeginsWith>`	Filter sucht, ob ein Wert mit dem angegebenen Wert beginnt. Enthält das Element `value`. Mögliche Werte für das Element `value`: `<base>` `<vendor>` `<wildfly>` (Angabe nur bei wildfly als Endpunkt)
`<keyContains>`	Filter sucht, ob der angebebene Wert enthalten ist. Enthält das Element `value`. Mögliche Werte für das Element `value`: `used`

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"?>
<info>
   <server>
      <host>localhost</host>
      <port>9990</port>
      <path>/metrics</path>
   </server>
   <metricscount>151</metricscount>
   <metricstype>
      <counter>22</counter>
      <gauge>129</gauge>
   </metricstype>
   <rootcategories>
      <base>19</base>
      <vendor>3</vendor>
      <wildfly>129</wildfly>
   </rootcategories>
   <hastimestamps>false</hastimestamps>
   <haslabels>true</haslabels>
</info>

Output mit Keycloak als Endpunkt

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

CODE

<?xml version="1.0" encoding="UTF-8"?>
<info>
	<server>
		<host>localhost</host>
		<port>8085</port>
		<path>/auth/metrics</path>
	</server>
	<metricscount>41</metricscount>
	<metricstype>
		<gauge>30</gauge>
		<counter>11</counter>
	</metricstype>
	<rootcategories>
		<base>15</base>
		<vendor>26</vendor>
	</rootcategories>
	<hastimestamps>false</hastimestamps>
	<haslabels>true</haslabels>
</info>

Elemente im Output

Folgende Elemente sind im Output für wildfly und Keycloak enthalten:

Element	Beschreibung
`<info>`	Wurzelelement für den Output der Operation `Info`.
`<server>`	Enthält die Elemente: `<host>`: IP-Adresse oder Host-Name des physikalischen Servers `<port>`: Portnummer des HTTP(S)-Dienstes `<path>`: Pfad zum Endpunkt
`<metricscount>`	Summe der Messwerte
`<metricstype>`	Enthält die Elemente: `<gauge>` `<counter>`
`<rootcategories>`	Enthält die Elemente: `<base>` `<vendor>` `<wildfly>` (Angabe nur bei wildfly als Endpunkt)
`<hastimestamps>`	Gibt an, ob die Messdaten einen Zeitstempel haben: `true` `false`
`<haslabels>`	Gibt an, ob ein Label enthalten ist. `true` `false`