Document and add support to input plugins for logging alias (#6357)

This commit is contained in:
Greg
2019-09-23 16:39:50 -06:00
committed by Daniel Nelson
parent e42d2e39c6
commit 817c9a69a9
111 changed files with 961 additions and 659 deletions

View File

@@ -4,7 +4,6 @@ import (
"context"
"errors"
"fmt"
"log"
"strings"
"time"
@@ -61,6 +60,8 @@ type MQTTConsumer struct {
ClientID string `toml:"client_id"`
tls.ClientConfig
Log telegraf.Logger
clientFactory ClientFactory
client Client
opts *mqtt.ClientOptions
@@ -212,7 +213,7 @@ func (m *MQTTConsumer) connect() error {
return err
}
log.Printf("I! [inputs.mqtt_consumer] Connected %v", m.Servers)
m.Log.Infof("Connected %v", m.Servers)
m.state = Connected
m.sem = make(semaphore, m.MaxUndeliveredMessages)
m.messages = make(map[telegraf.TrackingID]bool)
@@ -223,7 +224,7 @@ func (m *MQTTConsumer) connect() error {
SessionPresent() bool
}
if t, ok := token.(sessionPresent); ok && t.SessionPresent() {
log.Printf("D! [inputs.mqtt_consumer] Session found %v", m.Servers)
m.Log.Debugf("Session found %v", m.Servers)
return nil
}
@@ -244,7 +245,7 @@ func (m *MQTTConsumer) connect() error {
func (m *MQTTConsumer) onConnectionLost(c mqtt.Client, err error) {
m.acc.AddError(fmt.Errorf("connection lost: %v", err))
log.Printf("D! [inputs.mqtt_consumer] Disconnected %v", m.Servers)
m.Log.Debugf("Disconnected %v", m.Servers)
m.state = Disconnected
return
}
@@ -292,9 +293,9 @@ func (m *MQTTConsumer) onMessage(acc telegraf.TrackingAccumulator, msg mqtt.Mess
func (m *MQTTConsumer) Stop() {
if m.state == Connected {
log.Printf("D! [inputs.mqtt_consumer] Disconnecting %v", m.Servers)
m.Log.Debugf("Disconnecting %v", m.Servers)
m.client.Disconnect(200)
log.Printf("D! [inputs.mqtt_consumer] Disconnected %v", m.Servers)
m.Log.Debugf("Disconnected %v", m.Servers)
m.state = Disconnected
}
m.cancel()
@@ -303,7 +304,7 @@ func (m *MQTTConsumer) Stop() {
func (m *MQTTConsumer) Gather(acc telegraf.Accumulator) error {
if m.state == Disconnected {
m.state = Connecting
log.Printf("D! [inputs.mqtt_consumer] Connecting %v", m.Servers)
m.Log.Debugf("Connecting %v", m.Servers)
m.connect()
}
@@ -346,7 +347,7 @@ func (m *MQTTConsumer) createOpts() (*mqtt.ClientOptions, error) {
for _, server := range m.Servers {
// Preserve support for host:port style servers; deprecated in Telegraf 1.4.4
if !strings.Contains(server, "://") {
log.Printf("W! [inputs.mqtt_consumer] Server %q should be updated to use `scheme://host:port` format", server)
m.Log.Warnf("Server %q should be updated to use `scheme://host:port` format", server)
if tlsCfg == nil {
server = "tcp://" + server
} else {

View File

@@ -102,6 +102,7 @@ func TestLifecycleSanity(t *testing.T) {
},
}
})
plugin.Log = testutil.Logger{}
plugin.Servers = []string{"tcp://127.0.0.1"}
parser := &FakeParser{}
@@ -124,10 +125,12 @@ func TestRandomClientID(t *testing.T) {
var err error
m1 := New(nil)
m1.Log = testutil.Logger{}
err = m1.Init()
require.NoError(t, err)
m2 := New(nil)
m2.Log = testutil.Logger{}
err = m2.Init()
require.NoError(t, err)
@@ -137,6 +140,7 @@ func TestRandomClientID(t *testing.T) {
// PersistentSession requires ClientID
func TestPersistentClientIDFail(t *testing.T) {
plugin := New(nil)
plugin.Log = testutil.Logger{}
plugin.PersistentSession = true
err := plugin.Init()
@@ -255,6 +259,7 @@ func TestTopicTag(t *testing.T) {
plugin := New(func(o *mqtt.ClientOptions) Client {
return client
})
plugin.Log = testutil.Logger{}
plugin.Topics = []string{"telegraf"}
plugin.TopicTag = tt.topicTag()
@@ -295,6 +300,7 @@ func TestAddRouteCalledForEachTopic(t *testing.T) {
plugin := New(func(o *mqtt.ClientOptions) Client {
return client
})
plugin.Log = testutil.Logger{}
plugin.Topics = []string{"a", "b"}
err := plugin.Init()
@@ -325,6 +331,7 @@ func TestSubscribeCalledIfNoSession(t *testing.T) {
plugin := New(func(o *mqtt.ClientOptions) Client {
return client
})
plugin.Log = testutil.Logger{}
plugin.Topics = []string{"b"}
err := plugin.Init()
@@ -355,6 +362,7 @@ func TestSubscribeNotCalledIfSession(t *testing.T) {
plugin := New(func(o *mqtt.ClientOptions) Client {
return client
})
plugin.Log = testutil.Logger{}
plugin.Topics = []string{"b"}
err := plugin.Init()