Changed wording to expose prometheus metrics

Before, the confusing "publish prometheus metrics was used"

Fixes #80
This commit is contained in:
Christoph Petrausch
2022-02-02 08:08:27 +01:00
committed by GitHub
parent 453511db70
commit 06cde09749

View File

@@ -5,11 +5,11 @@
This exporter translates from MQTT topics to prometheus metrics. The core design is that clients send arbitrary JSON messages This exporter translates from MQTT topics to prometheus metrics. The core design is that clients send arbitrary JSON messages
on the topics. The translation between the MQTT representation and prometheus metrics is configured in the mqtt2prometheus exporter since we often can not change the IoT devices sending on the topics. The translation between the MQTT representation and prometheus metrics is configured in the mqtt2prometheus exporter since we often can not change the IoT devices sending
the messages. Clients can push metrics via MQTT to an MQTT Broker. This exporter subscribes to the broker and the messages. Clients can push metrics via MQTT to an MQTT Broker. This exporter subscribes to the broker and
publish the received messages as prometheus metrics. Currently, the exporter supports only MQTT 3.1. expose the received messages as prometheus metrics. Currently, the exporter supports only MQTT 3.1.
![Overview Diagram](docs/overview.drawio.svg) ![Overview Diagram](docs/overview.drawio.svg)
I wrote this exporter to publish metrics from small embedded sensors based on the NodeMCU to prometheus. I wrote this exporter to expose metrics from small embedded sensors based on the NodeMCU to prometheus.
The used arduino scetch can be found in the [dht22tomqtt](https://github.com/hikhvar/dht22tomqtt) repository. The used arduino scetch can be found in the [dht22tomqtt](https://github.com/hikhvar/dht22tomqtt) repository.
A local hacking environment with mqtt2prometheus, a MQTT broker and a prometheus server is in the [hack](https://github.com/hikhvar/mqtt2prometheus/tree/master/hack) directory. A local hacking environment with mqtt2prometheus, a MQTT broker and a prometheus server is in the [hack](https://github.com/hikhvar/mqtt2prometheus/tree/master/hack) directory.