telegraf/plugins/outputs/mqtt
Dwight Spencer ddde8809f4 Add README.md for mqtt output (#3764) 2018-02-16 13:51:20 -08:00
..
README.md Add README.md for mqtt output (#3764) 2018-02-16 13:51:20 -08:00
mqtt.go Limit wait time for writes in mqtt output (#3699) 2018-01-22 11:15:13 -08:00
mqtt_test.go Add Serializer plugins, and 'file' output plugin 2016-02-12 14:13:49 -07:00

README.md

MQTT Producer Output Plugin

This plugin writes to a MQTT Broker acting as a mqtt Producer.

[[outputs.mqtt]]
  ## URLs of mqtt brokers
  servers = ["localhost:1883"]
  
  ## topic for producer messages
  topic = "telegraf"
  
  ## QoS policy for messages
  qos = 2
  
  ## username and password to connect MQTT server.
  # username = "telegraf"
  # password = "metricsmetricsmetricsmetrics"
   
  ## client ID, if not set a random ID is generated
  # client_id = ""
    
  ## Timeout for write operations. default: 5s
  # timeout = "5s"
  ## Optional SSL Config
  # ssl_ca = "/etc/telegraf/ca.pem"
  # ssl_cert = "/etc/telegraf/cert.pem"
  # ssl_key = "/etc/telegraf/key.pem"
  
  ## Use SSL but skip chain & host verification
  # insecure_skip_verify = false
  
  ## Data format to output.
  data_format = "influx"


Required parameters:

  • servers: List of strings, this is for speaking to a cluster of mqtt brokers. On each flush interval, Telegraf will randomly choose one of the urls to write to. Each URL should just include host and port e.g. -> ["{host}:{port}","{host2}:{port2}"]
  • topic_prefix: The mqtt topic prefix to publish to. MQTT outputs send metrics to this topic format "<topic_prefix>///" ( ex: prefix/web01.example.com/mem)
  • qos: The mqtt QoS policy for sending messages. See https://www.ibm.com/support/knowledgecenter/en/SSFKSJ_9.0.0/com.ibm.mq.dev.doc/q029090_.htm for details.

Optional parameters:

  • username: The username to connect MQTT server.
  • password: The password to connect MQTT server.
  • client_id: The unique client id to connect MQTT server. If this paramater is not set then a random ID is generated.
  • timeout: Timeout for write operations. default: 5s
  • ssl_ca: SSL CA
  • ssl_cert: SSL CERT
  • ssl_key: SSL key
  • insecure_skip_verify: Use SSL but skip chain & host verification (default: false)
  • data_format: About Telegraf data formats