meinberg-ltos-exporter

README

Prometheus Exporter for Meinberg LTOS

[!CAUTION] This exporter is experimental and has only been tested against the following Meinberg devices:

• M600 with a grc180 receiver and LTOS 7.10.008.
• M300 with a pzf511 receiver and LTOS 7.06.014-light

[!TIP] Please provide feedback through GitHub issues, include the anonymized/obfuscated JSON output of /api/status to facilitate extending the exporter.

Prometheus exporter meinberg_ltos_exporter is designed for Meinberg devices running LTOS. It retrieves the status of a device via its REST API and makes the data available as scrape-able Prometheus metrics.

Building

To build the exporter, run the following command:

make build

This will create an executable named meinberg_ltos_exporter.

Local Development

Run the following in three separate terminal windows:

make run
go run tests/mock_server.go
curl -s http://localhost:10123/metrics | grep mbg_ltos

Configuration

The exporter can be configured via the following parameters:

usage: meinberg_ltos_exporter --ltos-api-url=LTOS-API-URL [<flags>]

Prometheus exporter for Meinberg LTOS devices


Flags:
  -h, --[no-]help                Show context-sensitive help (also try --help-long and --help-man).
      --[no-]version             Show application version.
      --web.listen-address="localhost"
                                 Address to listen on ($MEINBERG_LTOS_EXPORTER_LISTEN_ADDR)
      --web.listen-port="10123"  Port to listen on ($MEINBERG_LTOS_EXPORTER_LISTEN_PORT)
      --web.telemetry-path="/metrics"
                                 Path under which to expose metrics ($MEINBERG_LTOS_EXPORTER_METRICS_PATH)
      --ltos-api-url=LTOS-API-URL
                                 URL of the Meinberg LTOS API ($MEINBERG_LTOS_EXPORTER_LTOS_API_URL)
      --auth-user=AUTH-USER      Basic auth username ($MEINBERG_LTOS_EXPORTER_AUTH_USER)
      --auth-pass=AUTH-PASS      Basic auth password ($MEINBERG_LTOS_EXPORTER_AUTH_PASS)
      --timeout=5s               Timeout for HTTP requests to Meinberg device ($MEINBERG_LTOS_EXPORTER_TIMEOUT)
      --[no-]ignore-ssl-verify   Ignore SSL certificate verification ($MEINBERG_LTOS_EXPORTER_IGNORE_SSL_VERIFY)
      --log-level=info           Log level (debug, info, warn, error)

These parameters can be provided as environment variables or command-line arguments.

Authentication

The exporter supports Basic Authentication. Ensure the user has the "info" access level (lowest permission level) configured on the LTOS device.