telegraf/plugins/outputs/mqtt/mqtt.go

242 lines
5.1 KiB
Go
Raw Normal View History

2015-10-04 13:52:29 +00:00
package mqtt
import (
"fmt"
"log"
2015-10-04 13:52:29 +00:00
"strings"
"sync"
"time"
2015-10-04 13:52:29 +00:00
2019-02-12 01:25:25 +00:00
paho "github.com/eclipse/paho.mqtt.golang"
"github.com/influxdata/telegraf"
2016-01-20 18:57:35 +00:00
"github.com/influxdata/telegraf/internal"
2018-05-04 23:33:23 +00:00
"github.com/influxdata/telegraf/internal/tls"
2016-01-20 18:57:35 +00:00
"github.com/influxdata/telegraf/plugins/outputs"
"github.com/influxdata/telegraf/plugins/serializers"
2015-10-04 13:52:29 +00:00
)
var sampleConfig = `
servers = ["localhost:1883"] # required.
## MQTT outputs send metrics to this topic format
## "<topic_prefix>/<hostname>/<pluginname>/"
## ex: prefix/web01.example.com/mem
topic_prefix = "telegraf"
2018-05-19 02:03:00 +00:00
## QoS policy for messages
## 0 = at most once
## 1 = at least once
## 2 = exactly once
# 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 = ""
2018-05-19 02:03:00 +00:00
## Timeout for write operations. default: 5s
# timeout = "5s"
2018-05-04 23:33:23 +00:00
## 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
2018-05-19 02:03:00 +00:00
## When true, metrics will be sent in one MQTT message per flush. Otherwise,
## metrics are written one metric per MQTT message.
# batch = false
2019-02-12 01:25:25 +00:00
## When true, metric will have RETAIN flag set, making broker cache entries until someone
## actually reads it
2019-02-12 01:25:25 +00:00
# retain = false
2018-05-19 02:03:00 +00:00
## Data format to output.
2017-04-27 21:59:18 +00:00
## 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_OUTPUT.md
data_format = "influx"
`
2015-10-04 13:52:29 +00:00
type MQTT struct {
Servers []string `toml:"servers"`
Username string
Password string
Database string
Timeout internal.Duration
2015-10-04 13:52:29 +00:00
TopicPrefix string
QoS int `toml:"qos"`
ClientID string `toml:"client_id"`
2018-05-04 23:33:23 +00:00
tls.ClientConfig
2018-05-19 01:55:02 +00:00
BatchMessage bool `toml:"batch"`
2019-02-12 01:25:25 +00:00
Retain bool `toml:"retain"`
client paho.Client
opts *paho.ClientOptions
serializer serializers.Serializer
2015-10-04 13:52:29 +00:00
sync.Mutex
}
func (m *MQTT) Connect() error {
var err error
m.Lock()
defer m.Unlock()
2016-02-09 22:03:46 +00:00
if m.QoS > 2 || m.QoS < 0 {
return fmt.Errorf("MQTT Output, invalid QoS value: %d", m.QoS)
}
2015-10-04 13:52:29 +00:00
m.opts, err = m.createOpts()
2015-10-04 13:52:29 +00:00
if err != nil {
return err
}
m.client = paho.NewClient(m.opts)
if token := m.client.Connect(); token.Wait() && token.Error() != nil {
2015-10-04 13:52:29 +00:00
return token.Error()
}
return nil
}
func (m *MQTT) SetSerializer(serializer serializers.Serializer) {
m.serializer = serializer
}
2015-10-04 13:52:29 +00:00
func (m *MQTT) Close() error {
if m.client.IsConnected() {
m.client.Disconnect(20)
2015-10-04 13:52:29 +00:00
}
return nil
}
func (m *MQTT) SampleConfig() string {
return sampleConfig
}
func (m *MQTT) Description() string {
return "Configuration for MQTT server to send metrics to"
}
func (m *MQTT) Write(metrics []telegraf.Metric) error {
2015-10-04 13:52:29 +00:00
m.Lock()
defer m.Unlock()
if len(metrics) == 0 {
2015-10-04 13:52:29 +00:00
return nil
}
hostname, ok := metrics[0].Tags()["host"]
if !ok {
hostname = ""
}
2015-10-04 13:52:29 +00:00
2018-05-19 01:55:02 +00:00
metricsmap := make(map[string][]telegraf.Metric)
for _, metric := range metrics {
2015-10-04 13:52:29 +00:00
var t []string
if m.TopicPrefix != "" {
t = append(t, m.TopicPrefix)
}
if hostname != "" {
t = append(t, hostname)
}
t = append(t, metric.Name())
2015-10-04 13:52:29 +00:00
topic := strings.Join(t, "/")
2018-05-19 01:55:02 +00:00
if m.BatchMessage {
metricsmap[topic] = append(metricsmap[topic], metric)
} else {
buf, err := m.serializer.Serialize(metric)
if err != nil {
log.Printf("D! [outputs.mqtt] Could not serialize metric: %v", err)
continue
2018-05-19 01:55:02 +00:00
}
err = m.publish(topic, buf)
if err != nil {
return fmt.Errorf("Could not write to MQTT server, %s", err)
}
}
2018-05-19 01:55:02 +00:00
}
for key := range metricsmap {
buf, err := m.serializer.SerializeBatch(metricsmap[key])
if err != nil {
2018-05-19 01:55:02 +00:00
return err
}
publisherr := m.publish(key, buf)
if publisherr != nil {
return fmt.Errorf("Could not write to MQTT server, %s", publisherr)
2015-10-04 13:52:29 +00:00
}
}
return nil
}
func (m *MQTT) publish(topic string, body []byte) error {
token := m.client.Publish(topic, byte(m.QoS), m.Retain, body)
token.WaitTimeout(m.Timeout.Duration)
2015-10-04 13:52:29 +00:00
if token.Error() != nil {
return token.Error()
}
return nil
}
func (m *MQTT) createOpts() (*paho.ClientOptions, error) {
2015-10-04 13:52:29 +00:00
opts := paho.NewClientOptions()
opts.KeepAlive = 0
2015-10-04 13:52:29 +00:00
if m.Timeout.Duration < time.Second {
m.Timeout.Duration = 5 * time.Second
}
opts.WriteTimeout = m.Timeout.Duration
if m.ClientID != "" {
opts.SetClientID(m.ClientID)
} else {
opts.SetClientID("Telegraf-Output-" + internal.RandomString(5))
}
2018-05-04 23:33:23 +00:00
tlsCfg, err := m.ClientConfig.TLSConfig()
if err != nil {
return nil, err
}
2015-10-04 13:52:29 +00:00
scheme := "tcp"
if tlsCfg != nil {
2015-10-04 13:52:29 +00:00
scheme = "ssl"
opts.SetTLSConfig(tlsCfg)
2015-10-04 13:52:29 +00:00
}
user := m.Username
if user != "" {
2015-10-04 13:52:29 +00:00
opts.SetUsername(user)
}
password := m.Password
if password != "" {
opts.SetPassword(password)
}
if len(m.Servers) == 0 {
2020-05-15 22:43:32 +00:00
return opts, fmt.Errorf("could not get host informations")
2015-10-04 13:52:29 +00:00
}
for _, host := range m.Servers {
server := fmt.Sprintf("%s://%s", scheme, host)
opts.AddBroker(server)
}
opts.SetAutoReconnect(true)
return opts, nil
}
func init() {
outputs.Add("mqtt", func() telegraf.Output {
2015-10-04 13:52:29 +00:00
return &MQTT{}
})
}