Fix typos in mqtt output documentation

This commit is contained in:
Daniel Nelson 2019-02-11 17:25:25 -08:00
parent 6ac4fc8f06
commit c08b454af4
No known key found for this signature in database
GPG Key ID: CAAD59C9444F6155
2 changed files with 9 additions and 11 deletions

View File

@ -37,9 +37,8 @@ This plugin writes to a [MQTT Broker](http://http://mqtt.org/) acting as a mqtt
## metrics are written one metric per MQTT message. ## metrics are written one metric per MQTT message.
# batch = false # batch = false
## When true, metric will have RETAIN flag set, making broker cache entries until someone ## When true, messages will have RETAIN flag set.
## actually reads it # retain = false
# retain = flase
## Data format to output. ## Data format to output.
# data_format = "influx" # data_format = "influx"
@ -60,5 +59,5 @@ This plugin writes to a [MQTT Broker](http://http://mqtt.org/) acting as a mqtt
* `tls_cert`: TLS CERT * `tls_cert`: TLS CERT
* `tls_key`: TLS key * `tls_key`: TLS key
* `insecure_skip_verify`: Use TLS but skip chain & host verification (default: false) * `insecure_skip_verify`: Use TLS but skip chain & host verification (default: false)
* `retain`: Set `retain` flag when publishing, instructing server to cache metric until someone reads it (default: false) * `retain`: Set `retain` flag when publishing
* `data_format`: [About Telegraf data formats](https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md) * `data_format`: [About Telegraf data formats](https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md)

View File

@ -6,13 +6,12 @@ import (
"sync" "sync"
"time" "time"
paho "github.com/eclipse/paho.mqtt.golang"
"github.com/influxdata/telegraf" "github.com/influxdata/telegraf"
"github.com/influxdata/telegraf/internal" "github.com/influxdata/telegraf/internal"
"github.com/influxdata/telegraf/internal/tls" "github.com/influxdata/telegraf/internal/tls"
"github.com/influxdata/telegraf/plugins/outputs" "github.com/influxdata/telegraf/plugins/outputs"
"github.com/influxdata/telegraf/plugins/serializers" "github.com/influxdata/telegraf/plugins/serializers"
paho "github.com/eclipse/paho.mqtt.golang"
) )
var sampleConfig = ` var sampleConfig = `
@ -52,7 +51,7 @@ var sampleConfig = `
## When true, metric will have RETAIN flag set, making broker cache entries until someone ## When true, metric will have RETAIN flag set, making broker cache entries until someone
## actually reads it ## actually reads it
# retain = flase # retain = false
## Data format to output. ## Data format to output.
## Each data format has its own unique set of configuration options, read ## Each data format has its own unique set of configuration options, read
@ -72,7 +71,7 @@ type MQTT struct {
ClientID string `toml:"client_id"` ClientID string `toml:"client_id"`
tls.ClientConfig tls.ClientConfig
BatchMessage bool `toml:"batch"` BatchMessage bool `toml:"batch"`
Retain bool Retain bool `toml:"retain"`
client paho.Client client paho.Client
opts *paho.ClientOptions opts *paho.ClientOptions