fhemberger/mqtt_exporter repository overview

⁠Prometheus exporter for MQTT

Configurable general purpose Prometheus exporter for MQTT.

Subscribes to one or more MQTT topics, and lets you configure prometheus metrics based on pattern matching.

⁠Usage

• Create a folder to hold the config (default: conf/)
• Add metric config(s) in YAML format to the folder. Files are combined and read as a single config. (See exampleconf/metric_example.yaml for details)
• Install dependencies with pip3 install -r requirements-frozen.txt
• Run ./mqtt_exporter.py

⁠Docker

For your convenience, there is also a Docker image available:

docker run -d \
  -v "$(pwd)/myconfig:/usr/src/app/conf:ro" \
  -p "9344:9344" \
  ghcr.io/fhemberger/mqtt_exporter

If you want to mount your configuration to a different directory, add the -c flag:

docker run -d \
  -v "$(pwd)/myconfig:/myconfig:ro" \
  -p "9344:9344" \
  ghcr.io/fhemberger/mqtt_exporter -c /myconfig

⁠Python dependencies

• paho-mqtt
• prometheus-client
• PyYAML
• yamlreader

⁠TODO

• Add persistence of metrics on restart