Operation: Info

The Info operation generates an output with filtered measurement data from the system. The filters are defined in the input. The metrics endpoint is used for this operation.

The following parameters also need to be set:

protocol
host
port
path

Input

The adapter expects an XML file in the following format as input:

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>

The following elements are included in the input:

Element	Description
`<filter>`	Root element for the `Info` operation.
`<types>`	Type of measurement. Contains the `value` element. Possible values for the `value` element: `gauge` `counter`
`<keyBeginsWith>`	Filters for values at the beginning. Contains the `value` element. Possible values for the `value` element: `<base>` `<vendor>` `<wildfly>` (only with wildfly as endpoint)
`<keyContains>`	Filters for values contained. Contains the `value` element. Possible values for the `value` element: `used`

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"?>
<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 with Keycloak as endpoint

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

Elements in the output

The following elements are included in the output for wildfly and Keycloak:

Element	Description
`<info>`	Root element for the output of the `Info` operation.
`<server>`	Contains the elements: `<host>`: IP address or host name of the physical server `<port>`: HTTP(S) service port number `<path>`: Path to the endpoint
`<metricscount>`	Total of measured values
`<metricstype>`	Contains the elements: `<gauge>` `<counter>`
`<rootcategories>`	Contains the elements: `<base>` `<vendor>` `<wildfly>` (only with wildfly as endpoint)
`<hastimestamps>`	Indicates whether the measured data has a time stamp: `true` `false`
`<haslabels>`	Indicates whether a label is present. `true` `false`