Resolve Traps OIDs to names (#10934)

* Resolving trap OIDs to readable names * Fix tests * Update pkg/snmp/traps/formatter.go Co-authored-by: Alexandre Yang <[email protected]> * Address review * Fail-fast * Fix ineff-assign * Rename variables_raw to variables * Fix service name Co-authored-by: Alexandre Yang <[email protected]>
DataDog · Mar 15, 2022 · 0702d55 · 0702d55
1 parent 1646c60
commit 0702d55
Show file tree

Hide file tree

Showing 14 changed files with 1,057 additions and 415 deletions.
diff --git a/pkg/logs/internal/launchers/traps/launcher.go b/pkg/logs/internal/launchers/traps/launcher.go
@@ -9,6 +9,7 @@ import (
 	"github.com/DataDog/datadog-agent/pkg/logs/config"
 	tailer "github.com/DataDog/datadog-agent/pkg/logs/internal/tailers/traps"
 	"github.com/DataDog/datadog-agent/pkg/logs/pipeline"
+	"github.com/DataDog/datadog-agent/pkg/security/log"
 	"github.com/DataDog/datadog-agent/pkg/snmp/traps"
 )
 
@@ -36,7 +37,16 @@ func (l *Launcher) Start() {
 
 func (l *Launcher) startNewTailer(source *config.LogSource, inputChan chan *traps.SnmpPacket) {
 	outputChan := l.pipelineProvider.NextPipelineChan()
-	l.tailer = tailer.NewTailer(source, inputChan, outputChan)
+	oidResolver, err := traps.NewMultiFilesOIDResolver()
+	if err != nil {
+		log.Errorf("unable to load traps database: %w. Will not listen for SNMP traps", err)
+		return
+	}
+	l.tailer, err = tailer.NewTailer(oidResolver, source, inputChan, outputChan)
+	if err != nil {
+		log.Errorf("unable to load traps database: %w. Will not listen for SNMP traps", err)
+		return
+	}
 	l.tailer.Start()
 }
 

diff --git a/pkg/logs/internal/tailers/traps/tailer.go b/pkg/logs/internal/tailers/traps/tailer.go
@@ -6,7 +6,6 @@
 package traps
 
 import (
-	"encoding/json"
 	"time"
 
 	"github.com/DataDog/datadog-agent/pkg/logs/config"
@@ -18,19 +17,25 @@ import (
 // Tailer consumes and processes a stream of trap packets, and sends them to a stream of log messages.
 type Tailer struct {
 	source     *config.LogSource
+	formatter  traps.Formatter
 	inputChan  traps.PacketsChannel
 	outputChan chan *message.Message
 	done       chan interface{}
 }
 
 // NewTailer returns a new Tailer
-func NewTailer(source *config.LogSource, inputChan traps.PacketsChannel, outputChan chan *message.Message) *Tailer {
+func NewTailer(oidResolver traps.OIDResolver, source *config.LogSource, inputChan traps.PacketsChannel, outputChan chan *message.Message) (*Tailer, error) {
+	formatter, err := traps.NewJSONFormatter(oidResolver)
+	if err != nil {
+		return nil, err
+	}
 	return &Tailer{
 		source:     source,
 		inputChan:  inputChan,
 		outputChan: outputChan,
+		formatter:  formatter,
 		done:       make(chan interface{}, 1),
-	}
+	}, nil
 }
 
 // Start starts the tailer.
@@ -50,19 +55,14 @@ func (t *Tailer) run() {
 
 	// Loop terminates when the channel is closed.
 	for packet := range t.inputChan {
-		data, err := traps.FormatPacketToJSON(packet)
+		data, err := t.formatter.FormatPacket(packet)
 		if err != nil {
 			log.Errorf("failed to format packet: %s", err)
 			continue
 		}
 		t.source.BytesRead.Add(int64(len(data)))
-		content, err := json.Marshal(data)
-		if err != nil {
-			log.Errorf("failed to serialize packet data to JSON: %s", err)
-			continue
-		}
 		origin := message.NewOrigin(t.source)
-		origin.SetTags(traps.GetTags(packet))
-		t.outputChan <- message.NewMessage(content, origin, message.StatusInfo, time.Now().UnixNano())
+		origin.SetTags(t.formatter.GetTags(packet))
+		t.outputChan <- message.NewMessage(data, origin, message.StatusInfo, time.Now().UnixNano())
 	}
 }
diff --git a/pkg/logs/internal/tailers/traps/tailer_test.go b/pkg/logs/internal/tailers/traps/tailer_test.go
@@ -6,24 +6,39 @@
 package traps
 
 import (
-	"encoding/json"
+	"fmt"
 	"net"
 	"testing"
 	"time"
 
 	"github.com/gosnmp/gosnmp"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 
 	"github.com/DataDog/datadog-agent/pkg/logs/config"
 	"github.com/DataDog/datadog-agent/pkg/logs/message"
 	"github.com/DataDog/datadog-agent/pkg/snmp/traps"
 )
 
+// NoOpOIDResolver is a dummy OIDResolver implementation that is unable to get any Trap or Variable metadata.
+type NoOpOIDResolver struct{}
+
+// GetTrapMetadata always return an error in this OIDResolver implementation
+func (or NoOpOIDResolver) GetTrapMetadata(trapOID string) (traps.TrapMetadata, error) {
+	return traps.TrapMetadata{}, fmt.Errorf("trap OID %s is not defined", trapOID)
+}
+
+// GetVariableMetadata always return an error in this OIDResolver implementation
+func (or NoOpOIDResolver) GetVariableMetadata(trapOID string, varOID string) (traps.VariableMetadata, error) {
+	return traps.VariableMetadata{}, fmt.Errorf("trap OID %s is not defined", trapOID)
+}
+
 func TestTrapsShouldReceiveMessages(t *testing.T) {
 	inputChan := make(traps.PacketsChannel, 1)
 	outputChan := make(chan *message.Message)
-	tailer := NewTailer(config.NewLogSource("test", &config.LogsConfig{}), inputChan, outputChan)
+	tailer, err := NewTailer(&NoOpOIDResolver{}, config.NewLogSource("test", &config.LogsConfig{}), inputChan, outputChan)
+	require.NoError(t, err)
 	tailer.Start()
 
 	p := &traps.SnmpPacket{
@@ -46,18 +61,23 @@ func TestTrapsShouldReceiveMessages(t *testing.T) {
 		return
 	}
 
+	formattedPacket := format(t, p)
 	assert.Equal(t, message.StatusInfo, msg.GetStatus())
-	assert.Equal(t, format(t, p), msg.Content)
-	assert.Equal(t, traps.GetTags(p), msg.Origin.Tags())
+	assert.Equal(t, formattedPacket, msg.Content)
+	assert.Equal(t, []string{
+		"snmp_version:2",
+		"device_namespace:default",
+		"snmp_device:127.0.0.1",
+	}, msg.Origin.Tags())
 
 	close(inputChan)
 	tailer.WaitFlush()
 }
 
 func format(t *testing.T, p *traps.SnmpPacket) []byte {
-	data, err := traps.FormatPacketToJSON(p)
-	assert.NoError(t, err)
-	content, err := json.Marshal(data)
+	formatter, err := traps.NewJSONFormatter(NoOpOIDResolver{})
+	require.NoError(t, err)
+	formattedPacket, err := formatter.FormatPacket(p)
 	assert.NoError(t, err)
-	return content
+	return formattedPacket
 }
diff --git a/pkg/logs/schedulers/traps/scheduler.go b/pkg/logs/schedulers/traps/scheduler.go
@@ -31,8 +31,8 @@ func (s *Scheduler) Start(sourceMgr schedulers.SourceManager) {
 		// source to forward SNMP traps as logs.
 		source := logsConfig.NewLogSource(logsConfig.SnmpTraps, &logsConfig.LogsConfig{
 			Type:    logsConfig.SnmpTrapsType,
-			Service: "snmp",
-			Source:  "snmp",
+			Service: "snmp-traps",
+			Source:  "snmp-traps",
 		})
 		log.Debug("Adding SNMPTraps source to the Logs Agent")
 		sourceMgr.AddSource(source)

diff --git a/pkg/snmp/traps/format.go b/pkg/snmp/traps/format.go