mqtt

README

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

Documentation

Index

• type MQTT
  • func (m *MQTT) Close() error
  • func (m *MQTT) Connect() error
  • func (m *MQTT) Description() string
  • func (m *MQTT) SampleConfig() string
  • func (m *MQTT) SetSerializer(serializer serializers.Serializer)
  • func (m *MQTT) Write(metrics []tinymonitor.Metric) error

Types

type MQTT

type MQTT struct {
	Servers     []string `toml:"servers"`
	Username    string
	Password    string
	Database    string
	Timeout     itscripts.Duration
	TopicPrefix string
	QoS         int    `toml:"qos"`
	ClientID    string `toml:"client_id"`

	// Path to CA file
	SSLCA string `toml:"ssl_ca"`
	// Path to host cert file
	SSLCert string `toml:"ssl_cert"`
	// Path to cert key file
	SSLKey string `toml:"ssl_key"`
	// Use SSL but skip chain & host verification
	InsecureSkipVerify bool

	sync.Mutex
	// contains filtered or unexported fields
}

func (*MQTT) Close

func (m *MQTT) Close() error

func (*MQTT) Connect

func (m *MQTT) Connect() error

func (*MQTT) Description

func (m *MQTT) Description() string

func (*MQTT) SampleConfig

func (m *MQTT) SampleConfig() string

func (*MQTT) SetSerializer

func (m *MQTT) SetSerializer(serializer serializers.Serializer)

func (*MQTT) Write

func (m *MQTT) Write(metrics []tinymonitor.Metric) error