82 lines
2.7 KiB
Markdown
82 lines
2.7 KiB
Markdown
# MQTT Consumer Input Plugin
|
|
|
|
The [MQTT][mqtt] consumer plugin reads from the specified MQTT topics
|
|
and creates metrics using one of the supported [input data formats][].
|
|
|
|
### Configuration
|
|
|
|
```toml
|
|
[[inputs.mqtt_consumer]]
|
|
## MQTT broker URLs to be used. The format should be scheme://host:port,
|
|
## schema can be tcp, ssl, or ws.
|
|
servers = ["tcp://127.0.0.1:1883"]
|
|
|
|
## Topics that will be subscribed to.
|
|
topics = [
|
|
"telegraf/host01/cpu",
|
|
"telegraf/+/mem",
|
|
"sensors/#",
|
|
]
|
|
|
|
## The message topic will be stored in a tag specified by this value. If set
|
|
## to the empty string no topic tag will be created.
|
|
# topic_tag = "topic"
|
|
|
|
## QoS policy for messages
|
|
## 0 = at most once
|
|
## 1 = at least once
|
|
## 2 = exactly once
|
|
##
|
|
## When using a QoS of 1 or 2, you should enable persistent_session to allow
|
|
## resuming unacknowledged messages.
|
|
# qos = 0
|
|
|
|
## Connection timeout for initial connection in seconds
|
|
# connection_timeout = "30s"
|
|
|
|
## Maximum messages to read from the broker that have not been written by an
|
|
## output. For best throughput set based on the number of metrics within
|
|
## each message and the size of the output's metric_batch_size.
|
|
##
|
|
## For example, if each message from the queue contains 10 metrics and the
|
|
## output metric_batch_size is 1000, setting this to 100 will ensure that a
|
|
## full batch is collected and the write is triggered immediately without
|
|
## waiting until the next flush_interval.
|
|
# max_undelivered_messages = 1000
|
|
|
|
## Persistent session disables clearing of the client session on connection.
|
|
## In order for this option to work you must also set client_id to identity
|
|
## the client. To receive messages that arrived while the client is offline,
|
|
## also set the qos option to 1 or 2 and don't forget to also set the QoS when
|
|
## publishing.
|
|
# persistent_session = false
|
|
|
|
## If unset, a random client ID will be generated.
|
|
# client_id = ""
|
|
|
|
## Username and password to connect MQTT server.
|
|
# username = "telegraf"
|
|
# password = "metricsmetricsmetricsmetrics"
|
|
|
|
## Optional TLS Config
|
|
# tls_ca = "/etc/telegraf/ca.pem"
|
|
# tls_cert = "/etc/telegraf/cert.pem"
|
|
# tls_key = "/etc/telegraf/key.pem"
|
|
## Use TLS but skip chain & host verification
|
|
# insecure_skip_verify = false
|
|
|
|
## Data format to consume.
|
|
## Each data format has its own unique set of configuration options, read
|
|
## more about them here:
|
|
## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md
|
|
data_format = "influx"
|
|
```
|
|
|
|
### Metrics
|
|
|
|
- All measurements are tagged with the incoming topic, ie
|
|
`topic=telegraf/host01/cpu`
|
|
|
|
[mqtt]: https://mqtt.org
|
|
[input data formats]: /docs/DATA_FORMATS_INPUT.md
|