code review updates

elastic · Feb 3, 2025 · e2cf24a · e2cf24a
1 parent 7106b06
commit e2cf24a
Show file tree

Hide file tree

Showing 18 changed files with 120 additions and 68 deletions.
diff --git a/x-pack/filebeat/input/netflow/decoder/config/config.go b/x-pack/filebeat/input/netflow/decoder/config/config.go
@@ -30,8 +30,11 @@ type Config struct {
 
 // Defaults returns a configuration object with defaults settings:
 // - no protocols are enabled.
-// - log output is discarded
+// - log output is set to the logger that is passed in.
 // - session expiration is checked once every hour.
+// - resets are detected.
+// - templates are not shared.
+// - cache is disabled.
 func Defaults(logger *logp.Logger) Config {
 	return Config{
 		protocols:       []string{},
@@ -50,12 +53,6 @@ func (c *Config) WithProtocols(protos ...string) *Config {
 	return c
 }
 
-// WithLogOutput sets the output io.Writer for logging.
-func (c *Config) WithLogOutput(output *logp.Logger) *Config {
-	c.logOutput = output
-	return c
-}
-
 // WithExpiration configures the expiration timeout for sessions and templates.
 // A value of zero disables expiration.
 func (c *Config) WithExpiration(timeout time.Duration) *Config {

diff --git a/x-pack/filebeat/input/netflow/decoder/examples/go-netflow-example.go b/x-pack/filebeat/input/netflow/decoder/examples/go-netflow-example.go
@@ -18,8 +18,7 @@ import (
 func main() {
 	logger := logp.L().Named("netflow")
 
-	decoder, err := decoder.NewDecoder(decoder.NewConfig().
-		WithLogOutput(logger).
+	decoder, err := decoder.NewDecoder(decoder.NewConfig(logger).
 		WithProtocols("v1", "v5", "v9", "ipfix"))
 	if err != nil {
 		logger.Fatal("Failed creating decoder:", err)

diff --git a/x-pack/filebeat/input/netflow/decoder/ipfix/ipfix_test.go b/x-pack/filebeat/input/netflow/decoder/ipfix/ipfix_test.go
@@ -12,13 +12,19 @@ import (
 
 	"github.com/stretchr/testify/assert"
 
+	"github.com/elastic/elastic-agent-libs/logp"
+
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/config"
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/fields"
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/record"
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/test"
 	v9 "github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/v9"
 )
 
+func init() {
+	logp.TestingSetup()
+}
+
 func TestMessageWithOptions(t *testing.T) {
 	rawString := "" +
 		"000a01e45bf435e1000000a500000000000200480400001000080004000c0004" +
@@ -67,7 +73,7 @@ func TestMessageWithOptions(t *testing.T) {
 			"version":      uint64(10),
 		},
 	}
-	proto := New(config.Defaults())
+	proto := New(config.Defaults(logp.L()))
 	flows, err := proto.OnPacket(bytes.NewBuffer(raw), test.MakeAddress(t, "127.0.0.1:1234"))
 	assert.NoError(t, err)
 	if assert.Len(t, flows, 7) {
@@ -84,7 +90,7 @@ func TestOptionTemplates(t *testing.T) {
 	key := v9.MakeSessionKey(addr, 1234, false)
 
 	t.Run("Single options template", func(t *testing.T) {
-		proto := New(config.Defaults())
+		proto := New(config.Defaults(logp.L()))
 		flows, err := proto.OnPacket(test.MakePacket([]uint16{
 			// Header
 			// Version, Length, Ts, SeqNo, Source
@@ -113,7 +119,7 @@ func TestOptionTemplates(t *testing.T) {
 	})
 
 	t.Run("Multiple options template", func(t *testing.T) {
-		proto := New(config.Defaults())
+		proto := New(config.Defaults(logp.L()))
 		raw := test.MakePacket([]uint16{
 			// Header
 			// Version, Count, Ts, SeqNo, Source
@@ -151,7 +157,7 @@ func TestOptionTemplates(t *testing.T) {
 	})
 
 	t.Run("records discarded", func(t *testing.T) {
-		proto := New(config.Defaults())
+		proto := New(config.Defaults(logp.L()))
 		raw := test.MakePacket([]uint16{
 			// Header
 			// Version, Count, Ts, SeqNo, Source
@@ -193,7 +199,7 @@ func TestOptionTemplates(t *testing.T) {
 func TestCustomFields(t *testing.T) {
 	addr := test.MakeAddress(t, "127.0.0.1:12345")
 
-	conf := config.Defaults()
+	conf := config.Defaults(logp.L())
 	conf.WithCustomFields(fields.FieldDict{
 		fields.Key{EnterpriseID: 0x12345678, FieldID: 33}: &fields.Field{Name: "customField", Decoder: fields.String},
 	})

diff --git a/x-pack/filebeat/input/netflow/decoder/protocol/registry_test.go b/x-pack/filebeat/input/netflow/decoder/protocol/registry_test.go
@@ -11,10 +11,16 @@ import (
 
 	"github.com/stretchr/testify/assert"
 
+	"github.com/elastic/elastic-agent-libs/logp"
+
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/config"
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/record"
 )
 
+func init() {
+	logp.TestingSetup()
+}
+
 type testProto int
 
 func (testProto) Version() uint16 {
@@ -61,7 +67,7 @@ func TestRegistry_Get(t *testing.T) {
 		assert.NoError(t, err)
 		gen, err := registry.Get("my_proto")
 		assert.NoError(t, err)
-		assert.Equal(t, testProto(0), gen(config.Defaults()))
+		assert.Equal(t, testProto(0), gen(config.Defaults(logp.L())))
 	})
 	t.Run("two protocols", func(t *testing.T) {
 		registry := ProtocolRegistry{}
@@ -71,10 +77,10 @@ func TestRegistry_Get(t *testing.T) {
 		assert.NoError(t, err)
 		gen, err := registry.Get("my_proto")
 		assert.NoError(t, err)
-		assert.Equal(t, testProto(1), gen(config.Defaults()))
+		assert.Equal(t, testProto(1), gen(config.Defaults(logp.L())))
 		gen, err = registry.Get("other_proto")
 		assert.NoError(t, err)
-		assert.Equal(t, testProto(2), gen(config.Defaults()))
+		assert.Equal(t, testProto(2), gen(config.Defaults(logp.L())))
 	})
 	t.Run("not registered", func(t *testing.T) {
 		registry := ProtocolRegistry{}

diff --git a/x-pack/filebeat/input/netflow/decoder/v1/v1.go b/x-pack/filebeat/input/netflow/decoder/v1/v1.go
@@ -59,11 +59,13 @@ type NetflowProtocol struct {
 }
 
 func init() {
-	_ := protocol.Registry.Register(ProtocolName, New)
+	if err := protocol.Registry.Register(ProtocolName, New); err != nil {
+		panic(err)
+	}
 }
 
 func New(config config.Config) protocol.Protocol {
-	return NewProtocol(ProtocolID, &templateV1, readV1Header, logp.L().Named(LogPrefix))
+	return NewProtocol(ProtocolID, &templateV1, readV1Header, config.LogOutput().Named(LogPrefix))
 }
 
 func NewProtocol(version uint16, template *template.Template, readHeader ReadHeaderFn, logger *logp.Logger) protocol.Protocol {

diff --git a/x-pack/filebeat/input/netflow/decoder/v1/v1_test.go b/x-pack/filebeat/input/netflow/decoder/v1/v1_test.go
@@ -17,18 +17,23 @@ import (
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/record"
 	template2 "github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/template"
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/test"
+	"github.com/elastic/elastic-agent-libs/logp"
 )
 
+func init() {
+	logp.TestingSetup()
+}
+
 func TestNetflowProtocol_New(t *testing.T) {
-	proto := New(config.Defaults())
+	proto := New(config.Defaults(logp.L()))
 
 	assert.Nil(t, proto.Start())
 	assert.Equal(t, uint16(1), proto.Version())
 	assert.Nil(t, proto.Stop())
 }
 
 func TestNetflowProtocol_OnPacket(t *testing.T) {
-	proto := New(config.Defaults())
+	proto := New(config.Defaults(logp.L()))
 
 	rawS := "00010002000000015bf689f605946fb0" +
 		"acd910e5c0a8017b00000000000000000000000e00002cfa" +
@@ -105,7 +110,7 @@ func TestNetflowProtocol_OnPacket(t *testing.T) {
 }
 
 func TestNetflowProtocol_BadPacket(t *testing.T) {
-	proto := New(config.Defaults())
+	proto := New(config.Defaults(logp.L()))
 
 	rawS := "00010002000000015bf689f605"
 	raw, err := hex.DecodeString(rawS)

diff --git a/x-pack/filebeat/input/netflow/decoder/v5/v5.go b/x-pack/filebeat/input/netflow/decoder/v5/v5.go
@@ -53,7 +53,9 @@ var templateV5 = template.Template{
 }
 
 func init() {
-	_ := protocol.Registry.Register(ProtocolName, New)
+	if err := protocol.Registry.Register(ProtocolName, New); err != nil {
+		panic(err)
+	}
 }
 
 func New(config config.Config) protocol.Protocol {

diff --git a/x-pack/filebeat/input/netflow/decoder/v5/v5_test.go b/x-pack/filebeat/input/netflow/decoder/v5/v5_test.go
@@ -13,22 +13,28 @@ import (
 
 	"github.com/stretchr/testify/assert"
 
+	"github.com/elastic/elastic-agent-libs/logp"
+
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/config"
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/record"
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/template"
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/test"
 )
 
+func init() {
+	logp.TestingSetup()
+}
+
 func TestNetflowProtocol_New(t *testing.T) {
-	proto := New(config.Defaults())
+	proto := New(config.Defaults(logp.L()))
 
 	assert.Nil(t, proto.Start())
 	assert.Equal(t, uint16(5), proto.Version())
 	assert.Nil(t, proto.Stop())
 }
 
 func TestNetflowProtocol_OnPacket(t *testing.T) {
-	proto := New(config.Defaults())
+	proto := New(config.Defaults(logp.L()))
 
 	rawS := "00050002000000015bf68d8b35fcb9780000000000000000" +
 		"acd910e5c0a8017b00000000000000000000000e00002cfa" +
@@ -119,7 +125,7 @@ func TestNetflowProtocol_OnPacket(t *testing.T) {
 }
 
 func TestNetflowProtocol_BadPacket(t *testing.T) {
-	proto := New(config.Defaults())
+	proto := New(config.Defaults(logp.L()))
 
 	rawS := "00050002000000015bf689f605"
 	raw, err := hex.DecodeString(rawS)

diff --git a/x-pack/filebeat/input/netflow/decoder/v6/v6.go b/x-pack/filebeat/input/netflow/decoder/v6/v6.go
@@ -47,7 +47,9 @@ var templateV6 = template.Template{
 }
 
 func init() {
-	_ := protocol.Registry.Register(ProtocolName, New)
+	if err := protocol.Registry.Register(ProtocolName, New); err != nil {
+		panic(err)
+	}
 }
 
 func New(config config.Config) protocol.Protocol {

diff --git a/x-pack/filebeat/input/netflow/decoder/v6/v6_test.go b/x-pack/filebeat/input/netflow/decoder/v6/v6_test.go
@@ -13,22 +13,28 @@ import (
 
 	"github.com/stretchr/testify/assert"
 
+	"github.com/elastic/elastic-agent-libs/logp"
+
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/config"
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/record"
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/template"
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/test"
 )
 
+func init() {
+	logp.TestingSetup()
+}
+
 func TestNetflowProtocol_New(t *testing.T) {
-	proto := New(config.Defaults())
+	proto := New(config.Defaults(logp.L()))
 
 	assert.Nil(t, proto.Start())
 	assert.Equal(t, uint16(6), proto.Version())
 	assert.Nil(t, proto.Stop())
 }
 
 func TestNetflowProtocol_OnPacket(t *testing.T) {
-	proto := New(config.Defaults())
+	proto := New(config.Defaults(logp.L()))
 
 	rawS := "00060002000000015bf68d8b35fcb9780000000000000000" +
 		"acd910e5c0a8017b00000000000000000000000e00002cfa" +
@@ -121,7 +127,7 @@ func TestNetflowProtocol_OnPacket(t *testing.T) {
 }
 
 func TestNetflowProtocol_BadPacket(t *testing.T) {
-	proto := New(config.Defaults())
+	proto := New(config.Defaults(logp.L()))
 
 	rawS := "00060002000000015bf689f605"
 	raw, err := hex.DecodeString(rawS)

diff --git a/x-pack/filebeat/input/netflow/decoder/v7/v7.go b/x-pack/filebeat/input/netflow/decoder/v7/v7.go
@@ -54,7 +54,9 @@ var v7template = template.Template{
 }
 
 func init() {
-	_ := protocol.Registry.Register(ProtocolName, New)
+	if err := protocol.Registry.Register(ProtocolName, New); err != nil {
+		panic(err)
+	}
 }
 
 func New(config config.Config) protocol.Protocol {

diff --git a/x-pack/filebeat/input/netflow/decoder/v7/v7_test.go b/x-pack/filebeat/input/netflow/decoder/v7/v7_test.go
@@ -13,22 +13,24 @@ import (
 
 	"github.com/stretchr/testify/assert"
 
+	"github.com/elastic/elastic-agent-libs/logp"
+
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/config"
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/record"
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/template"
 	"github.com/elastic/beats/v7/x-pack/filebeat/input/netflow/decoder/test"
 )
 
 func TestNetflowProtocol_New(t *testing.T) {
-	proto := New(config.Defaults())
+	proto := New(config.Defaults(logp.L()))
 
 	assert.Nil(t, proto.Start())
 	assert.Equal(t, uint16(7), proto.Version())
 	assert.Nil(t, proto.Stop())
 }
 
 func TestNetflowProtocol_OnPacket(t *testing.T) {
-	proto := New(config.Defaults())
+	proto := New(config.Defaults(logp.L()))
 
 	rawS := "00070002000000015bf68d8b35fcb9780000000000000000" +
 		"acd910e5c0a8017b00000000000000000000000e00002cfa" +
@@ -119,7 +121,7 @@ func TestNetflowProtocol_OnPacket(t *testing.T) {
 }
 
 func TestNetflowProtocol_BadPacket(t *testing.T) {
-	proto := New(config.Defaults())
+	proto := New(config.Defaults(logp.L()))
 
 	rawS := "00060002000000015bf689f605"
 	raw, err := hex.DecodeString(rawS)

diff --git a/x-pack/filebeat/input/netflow/decoder/v8/v8.go b/x-pack/filebeat/input/netflow/decoder/v8/v8.go
@@ -304,12 +304,14 @@ type NetflowV8Protocol struct {
 }
 
 func init() {
-	_ := protocol.Registry.Register(ProtocolName, New)
+	if err := protocol.Registry.Register(ProtocolName, New); err != nil {
+		panic(err)
+	}
 }
 
 func New(config config.Config) protocol.Protocol {
 	return &NetflowV8Protocol{
-		logger: logp.L().Named(LogPrefix),
+		logger: config.LogOutput().Named(LogPrefix),
 	}
 }