Skip to content

Commit

Permalink
Fix typos in mqtt output documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
danielnelson committed Feb 12, 2019
1 parent 6ac4fc8 commit c08b454
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 11 deletions.
11 changes: 5 additions & 6 deletions plugins/outputs/mqtt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,13 @@ This plugin writes to a [MQTT Broker](http://http://mqtt.org/) acting as a mqtt
# tls_key = "/etc/telegraf/key.pem"
## Use TLS but skip chain & host verification
# insecure_skip_verify = false

## When true, metrics will be sent in one MQTT message per flush. Otherwise,
## metrics are written one metric per MQTT message.
# batch = false

## When true, metric will have RETAIN flag set, making broker cache entries until someone
## actually reads it
# retain = flase

## When true, messages will have RETAIN flag set.
# retain = false

## Data format to output.
# data_format = "influx"
Expand All @@ -60,5 +59,5 @@ This plugin writes to a [MQTT Broker](http://http://mqtt.org/) acting as a mqtt
* `tls_cert`: TLS CERT
* `tls_key`: TLS key
* `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)
9 changes: 4 additions & 5 deletions plugins/outputs/mqtt/mqtt.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,12 @@ import (
"sync"
"time"

paho "github.com/eclipse/paho.mqtt.golang"
"github.com/influxdata/telegraf"
"github.com/influxdata/telegraf/internal"
"github.com/influxdata/telegraf/internal/tls"
"github.com/influxdata/telegraf/plugins/outputs"
"github.com/influxdata/telegraf/plugins/serializers"

paho "github.com/eclipse/paho.mqtt.golang"
)

var sampleConfig = `
Expand Down Expand Up @@ -49,10 +48,10 @@ var sampleConfig = `
## When true, metrics will be sent in one MQTT message per flush. Otherwise,
## metrics are written one metric per MQTT message.
# batch = false
## When true, metric will have RETAIN flag set, making broker cache entries until someone
## actually reads it
# retain = flase
# retain = false
## Data format to output.
## Each data format has its own unique set of configuration options, read
Expand All @@ -72,7 +71,7 @@ type MQTT struct {
ClientID string `toml:"client_id"`
tls.ClientConfig
BatchMessage bool `toml:"batch"`
Retain bool
Retain bool `toml:"retain"`

client paho.Client
opts *paho.ClientOptions
Expand Down

0 comments on commit c08b454

Please sign in to comment.