Prometheus Instrumentation

If the controller is started with the –prometheus PASSPHRASE command line parameter, MistServer makes Prometheus-compatible instrumentation available.

Once used as a command line parameter, the PASSPHRASE is stored into the configuration file, and need not be given again over the command line. It can be cleared by using the same parameter again, and providing an empty string instead: –prometheus "".

Alternatively the PASSPHRASE can be set up through the user interface by enabling the Prometheus stats output in the General tab.

The instrumentation can be accessed over the API port (by default 4242) by requesting the path /PASSPHRASE. Documentation of this instrumentation itself is present inside the output, so not repeated here.

Alternatively, the same data can also be accessed in JSON format as the path /PASSPHRASE.json. This format does not contain any documentation, but the same data is used, so please refer to the Prometheus-style output for details.

Some of the data is stream-bound, and only available while a stream is active (has at least one session associated with it).

The configuration of Prometheus or some other statistics gathering software is beyond the scope of this manual. Please see the documentation of your statistics gathering software for further details. The same goes for visualization of the gathered data.