Simple and generic Prometheus exporter for MQTT. Tested with Mosquitto MQTT and Xiaomi sensors.
It exposes metrics from MQTT message out of the box (you just need to specify the target if not on localhost).
MQTT-exporter expects a topic and a flat JSON payload, the value must be numeric values.
It also provides message counters for each MQTT topic (since PR #5):
mqtt_message_total{instance="mqtt-exporter:9000", job="mqtt-exporter", topic="zigbee2mqtt_0x00157d00032b1234"} 10
topic 'zigbee2mqtt/0x00157d00032b1234', payload '{"temperature":26.24,"humidity":45.37}'
will be converted as:
mqtt_temperature{topic="zigbee2mqtt_0x00157d00032b1234"} 25.24
mqtt_humidity{topic="zigbee2mqtt_0x00157d00032b1234"} 45.37
Parameters are passed using environment variables.
The list of parameters are:
IGNORED_TOPICS: Comma-separated lists of topics to ignore (default: None)LOG_LEVEL: Logging level (default: INFO)MQTT_ADDRESS: IP or hostname of MQTT broker (default: 127.0.0.1)MQTT_PORT: TCP port of MQTT broker (default: 1883)MQTT_TOPIC: Topic path to subscribe to (default: #)MQTT_KEEPALIVE: Keep alive interval to maintain connection with MQTT broker (default: 60)MQTT_USERNAME: Username which should be used to authenticate against the MQTT broker (default: None)MQTT_PASSWORD: Password which should be used to authenticate against the MQTT broker (default: None)PROMETHEUS_PORT: HTTP server PORT to expose Prometheus metrics (default: 9000)PROMETHEUS_PREFIX: Prefix added to the metric name, example: mqtt_temperature (default: mqtt_)TOPIC_LABEL: Define the Prometheus label for the topic, example temperature{topic="device1"} (default: topic)
With an interactive shell:
docker run -it -p 9000:9000 -e "MQTT_ADDRESS=192.168.0.1" kpetrem/mqtt-exporterIf you need the container to start on system boot (e.g. on your server/Raspberry Pi):
docker run -d -p 9000:9000 --restart unless-stopped --name mqtt-exporter -e "MQTT_ADDRESS=192.168.0.1" kpetrem/mqtt-exporterversion: "3"
services:
mqtt-exporter:
image: kpetrem/mqtt-exporter
ports:
- 9000:9000
environment:
- MQTT_ADDRESS=192.168.0.1
restart: unless-stoppedpip install -r requirements/base.txt
MQTT_ADDRESS=192.168.0.1 python exporter.py
See below an example of Prometheus configuration to scrape the metrics:
scrape_configs:
- job_name: mqtt-exporter
static_configs:
- targets: ["mqtt-exporter:9000"]
If you want nicer metrics, you can configure mqtt-exporter in your docker-compose.yml as followed:
version: "3"
services:
mqtt-exporter:
image: kpetrem/mqtt-exporter
ports:
- 9000:9000
environment:
- MQTT_ADDRESS=192.168.0.1
- PROMETHEUS_PREFIX=sensor_
- TOPIC_LABEL=sensor
restart: unless-stopped
Result:
sensor_temperature{sensor="zigbee2mqtt_bedroom"} 22.3
And then remove zigbee2mqtt_ prefix from sensor label via Prometheus configuration:
scrape_configs:
- job_name: mqtt-exporter
static_configs:
- targets: ["mqtt-exporter:9000"]
metric_relabel_configs:
- source_labels: [sensor]
regex: 'zigbee2mqtt_(.*)'
replacement: '$1'
target_label: sensor
Result:
sensor_temperature{sensor=bedroom"} 22.3
You can install invoke package on your system and then use it to install environement, run an autoformat or just run the exporter:
invoke install: to install virtualenv under .venv/ and install all dev requirementsinvoke reformat: reformat using black and isortinvoke start: start the app
Please ensure you have run the following before pushing a commit:
blackandisort(orinvoke reformat)pylamato run all linters
Follow usual best practices:
- document your code (inline and docstrings)
- constant are in upper case
- use comprehensible variable name
- one function = one purpose
- function name should define perfectly its purpose