Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inovex/mqtt_blackbox_exporter
Prometheus Exporter for MQTT monitoring
https://github.com/inovex/mqtt_blackbox_exporter
exporter monitoring mqtt prometheus
Last synced: 3 months ago
JSON representation
Prometheus Exporter for MQTT monitoring
- Host: GitHub
- URL: https://github.com/inovex/mqtt_blackbox_exporter
- Owner: inovex
- License: apache-2.0
- Created: 2017-03-21T12:33:07.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-21T21:49:42.000Z (over 1 year ago)
- Last Synced: 2024-04-15T03:03:29.272Z (7 months ago)
- Topics: exporter, monitoring, mqtt, prometheus
- Language: Go
- Size: 684 KB
- Stars: 76
- Watchers: 19
- Forks: 24
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MQTT Blackbox Exporter
[](https://travis-ci.org/inovex/mqtt_blackbox_exporter)
[](https://goreportcard.com/report/github.com/inovex/mqtt_blackbox_exporter)
[](https://hub.docker.com/r/inovex/mqtt_blackbox_exporter/)
Tests MQTT messaging roundtrips (publish/subscribe on same topic).
Definition of roundtrip:
- start subscriber on $topic
- start publisher on $topic
- publish $messages on $topic
- receive $message on $topic
## Build
```
$ mkdir -p ${GOPATH}/src/github.com/inovex/
$ git clone https://github.com/inovex/mqtt_blackbox_exporter.git ${GOPATH}/src/github.com/inovex/mqtt_blackbox_exporter/
$ cd ${GOPATH}/src/github.com/inovex/mqtt_blackbox_exporter/
$ make
```
This will build the mqtt_blackbox_exporter for all target platforms and write them to the ``build/`` directory.
Binaries are provided on Github, see https://github.com/inovex/mqtt_blackbox_exporter.
## Install
Place the binary somewhere in a ``PATH`` directory and make it executable (``chmod +x mqtt_blackbox_exporter``).
## Configure
See ``config.yaml.dist`` for a configuration example.
## Run
Native:
```
$ ./mqtt_blackbox_exporter -config.file config.yaml
```
Using Docker:
```
docker run --rm -it -p 9214:9214 -v ${PWD}/:/data/ inovex/mqtt_blackbox_exporter: -config.file /data/config.yaml
```
```
$ curl -s http://127.0.0.1:9214/metrics
...
# HELP probe_mqtt_completed_total Number of completed probes.
# TYPE probe_mqtt_completed_total counter
probe_mqtt_completed_total{broker="ssl://mqtt.example.net:8883",name="mqtt broker SSL"} 64
...
# HELP probe_mqtt_duration_seconds Time taken to execute probe.
# TYPE probe_mqtt_duration_seconds histogram
probe_mqtt_duration_seconds_bucket{broker="ssl://mqtt.example.net:8883",name="mqtt broker SSL",le="0.005"} 0
probe_mqtt_duration_seconds_bucket{broker="ssl://mqtt.example.net:8883",name="mqtt broker SSL",le="0.01"} 0
probe_mqtt_duration_seconds_sum{broker="ssl://mqtt.example.net:8883",name="mqtt broker SSL"} 50.09346619300002
probe_mqtt_duration_seconds_count{broker="ssl://mqtt.example.net:8883",name="mqtt broker SSL"} 64
...
# HELP probe_mqtt_messages_published_total Number of published messages.
# TYPE probe_mqtt_messages_published_total counter
probe_mqtt_messages_published_total{broker="ssl://mqtt.example.net:8883",name="mqtt broker SSL"} 640
...
# HELP probe_mqtt_messages_received_total Number of received messages.
# TYPE probe_mqtt_messages_received_total counter
probe_mqtt_messages_received_total{broker="ssl://mqtt.example.net:8883",name="mqtt broker SSL"} 640
...
# HELP probe_mqtt_started_total Number of started probes.
# TYPE probe_mqtt_started_total counter
probe_mqtt_started_total{broker="ssl://mqtt.example.net:8883",name="mqtt broker SSL"} 64
...
```
## Release
The release is done automatically by [goreleaser](https://github.com/goreleaser/goreleaser). To release a new version,
just set a git tag. Goreleaser run by Github Actions will create the binaries and upload them to the according Github release.