refactor: restore parameterless NewFactory functions for Beat receivers (#49571)

To keep them compatible with OpenTelemetry Collector Builder.

Author: andrzej-stencel

changelog/fragments/1773087971-change-beat-receiver-factory-to-have-default-home-and-path-directories.yaml

@@ -13,18 +13,7 @@ kind: feature
 
 # REQUIRED for all kinds
 # Change summary; a 80ish characters long description of the change.
-summary: Change beat receiver factory to require default home and path directory
-
-# REQUIRED for breaking-change, deprecation, known-issue
-# Long description; in case the summary is not enough to describe the change
-# this field accommodate a description without length limits.
-# description:
-
-# REQUIRED for breaking-change, deprecation, known-issue
-# impact:
-
-# REQUIRED for breaking-change, deprecation, known-issue
-# action:
+summary: Add NewFactoryWithSettings for Beat receivers to provide default home and path directories
 
 # REQUIRED for all kinds
 # Affected component; usually one of "elastic-agent", "fleet-server", "filebeat", "metricbeat", "auditbeat", "all", etc.

x-pack/filebeat/fbreceiver/factory.go

@@ -54,14 +54,21 @@ func createReceiver(ctx context.Context, set receiver.Settings, baseCfg componen
 	return &filebeatReceiver{BeatReceiver: br}, nil
 }
 
-// NewFactory creates a new receiver Factory.  The supplied
+// NewFactory creates a new receiver Factory with empty default paths.
+// It is compatible with the OpenTelemetry Collector Builder, which expects
+// parameterless NewFactory functions.
+func NewFactory() receiver.Factory {
+	return NewFactoryWithSettings(Settings{})
+}
+
+// NewFactoryWithSettings creates a new receiver Factory.  The supplied
 // Settings.Home should be the path that contains the "module"
 // directory so modules can be found and loaded.  The supplied
 // Settings.Data should point to the directory where state information
 // will be kept.  Both can be overridden by passing in path
 // information in the configuration when the receiver in instantiated.
 // This just provides defaults.
-func NewFactory(s Settings) receiver.Factory {
+func NewFactoryWithSettings(s Settings) receiver.Factory {
 	return receiver.NewFactory(
 		component.MustNewType(Name),
 		func() component.Config {

x-pack/filebeat/fbreceiver/receiver_leak_test.go

@@ -61,7 +61,7 @@ func TestLeak(t *testing.T) {
 		},
 	}
 
-	factory := NewFactory(Settings{Home: t.TempDir()})
+	factory := NewFactoryWithSettings(Settings{Home: t.TempDir()})
 
 	t.Run("healthy consumer", func(t *testing.T) {
 		defer oteltest.VerifyNoLeaks(t)

x-pack/filebeat/fbreceiver/receiver_test.go

@@ -83,7 +83,7 @@ func TestNewReceiver(t *testing.T) {
 				Name:    "r1",
 				Beat:    "filebeat",
 				Config:  &config,
-				Factory: NewFactory(Settings{Home: t.TempDir()}),
+				Factory: NewFactoryWithSettings(Settings{Home: t.TempDir()}),
 			},
 		},
 		AssertFunc: func(c *assert.CollectT, logs map[string][]mapstr.M, zapLogs *observer.ObservedLogs) {
@@ -150,7 +150,7 @@ func benchmarkFactoryWithLogLevel(b *testing.B, level zapcore.Level) {
 		zapcore.Lock(zapcore.AddSync(&zapLogs)),
 		level)
 
-	factory := NewFactory(Settings{Home: tmpDir})
+	factory := NewFactoryWithSettings(Settings{Home: tmpDir})
 
 	receiverSettings := receiver.Settings{}
 	receiverSettings.Logger = zap.New(core)
@@ -243,7 +243,7 @@ func newMultiReceiverHelper(t *testing.T, number int) multiReceiverHelper {
 func TestMultipleReceivers(t *testing.T) {
 	const nReceivers = 2
 
-	factory := NewFactory(Settings{Home: t.TempDir()})
+	factory := NewFactoryWithSettings(Settings{Home: t.TempDir()})
 
 	helpers := make([]multiReceiverHelper, nReceivers)
 	configs := make([]oteltest.ReceiverConfig, nReceivers)
@@ -403,7 +403,7 @@ func TestReceiverStatus(t *testing.T) {
 						Name:    "r1",
 						Beat:    "filebeat",
 						Config:  &config,
-						Factory: NewFactory(Settings{Home: t.TempDir()}),
+						Factory: NewFactoryWithSettings(Settings{Home: t.TempDir()}),
 					},
 				},
 				Status: test.status,
@@ -686,7 +686,7 @@ func TestConsumeContract(t *testing.T) {
 	// Run the contract checker. This will trigger test failures if any problems are found.
 	receivertest.CheckConsumeContract(receivertest.CheckConsumeContractParams{
 		T:             t,
-		Factory:       NewFactory(Settings{Home: t.TempDir()}),
+		Factory:       NewFactoryWithSettings(Settings{Home: t.TempDir()}),
 		Signal:        pipeline.SignalLogs,
 		Config:        cfg,
 		Generator:     gen,
@@ -719,7 +719,7 @@ func TestReceiverHook(t *testing.T) {
 	}
 	// For filebeatreceiver, we expect 3 hooks to be registered:
 	// 	one for beat metrics, one for input metrics and one for getting the registry.
-	oteltest.TestReceiverHook(t, &cfg, NewFactory(Settings{Home: t.TempDir()}), receiverSettings, 3)
+	oteltest.TestReceiverHook(t, &cfg, NewFactoryWithSettings(Settings{Home: t.TempDir()}), receiverSettings, 3)
 }
 
 func hostFromSocket(socket string) string {

x-pack/metricbeat/mbreceiver/factory.go

@@ -59,14 +59,21 @@ func createReceiver(ctx context.Context, set receiver.Settings, baseCfg componen
 	return &metricbeatReceiver{BeatReceiver: br}, nil
 }
 
-// NewFactory creates a new receiver Factory.  The supplied
+// NewFactory creates a new receiver Factory with empty default paths.
+// It is compatible with the OpenTelemetry Collector Builder, which expects
+// parameterless NewFactory functions.
+func NewFactory() receiver.Factory {
+	return NewFactoryWithSettings(Settings{})
+}
+
+// NewFactoryWithSettings creates a new receiver Factory.  The supplied
 // Settings.Home should be the path that contains the "module"
 // directory so modules can be found and loaded.  The supplied
 // Settings.Data should point to the directory where state information
 // will be kept.  Both can be overridden by passing in path
 // information in the configuration when the receiver in instantiated.
 // This just provides defaults.
-func NewFactory(s Settings) receiver.Factory {
+func NewFactoryWithSettings(s Settings) receiver.Factory {
 	return receiver.NewFactory(
 		component.MustNewType(Name),
 		func() component.Config {

x-pack/metricbeat/mbreceiver/receiver_leak_test.go

@@ -63,7 +63,7 @@ func TestLeak(t *testing.T) {
 			},
 		},
 	}
-	factory := NewFactory(Settings{Home: t.TempDir()})
+	factory := NewFactoryWithSettings(Settings{Home: t.TempDir()})
 
 	t.Run("healthy consumer", func(t *testing.T) {
 		defer oteltest.VerifyNoLeaks(t)

x-pack/metricbeat/mbreceiver/receiver_test.go

@@ -78,7 +78,7 @@ func TestNewReceiver(t *testing.T) {
 				Name:    "r1",
 				Beat:    "metricbeat",
 				Config:  &config,
-				Factory: NewFactory(Settings{Home: t.TempDir()}),
+				Factory: NewFactoryWithSettings(Settings{Home: t.TempDir()}),
 			},
 		},
 		AssertFunc: func(c *assert.CollectT, logs map[string][]mapstr.M, zapLogs *observer.ObservedLogs) {
@@ -174,7 +174,7 @@ func TestMultipleReceivers(t *testing.T) {
 		},
 	}
 
-	factory := NewFactory(Settings{Home: t.TempDir()})
+	factory := NewFactoryWithSettings(Settings{Home: t.TempDir()})
 	oteltest.CheckReceivers(oteltest.CheckReceiversParams{
 		T: t,
 		Receivers: []oteltest.ReceiverConfig{
@@ -347,7 +347,7 @@ func BenchmarkFactory(b *testing.B) {
 		zapcore.Lock(zapcore.AddSync(&zapLogs)),
 		zapcore.InfoLevel)
 
-	factory := NewFactory(Settings{Home: tmpDir})
+	factory := NewFactoryWithSettings(Settings{Home: tmpDir})
 
 	receiverSettings := receiver.Settings{}
 	receiverSettings.Logger = zap.New(core)
@@ -421,7 +421,7 @@ func TestReceiverStatus(t *testing.T) {
 						Name:    "r1",
 						Beat:    "metricbeat",
 						Config:  &config,
-						Factory: NewFactory(Settings{Home: t.TempDir()}),
+						Factory: NewFactoryWithSettings(Settings{Home: t.TempDir()}),
 					},
 				},
 				Status: test.status,
@@ -457,5 +457,5 @@ func TestReceiverHook(t *testing.T) {
 
 	// For metricbeatreceiver, we expect 2 hooks to be registered:
 	// 	one for beat metrics and one for input metrics.
-	oteltest.TestReceiverHook(t, &cfg, NewFactory(Settings{Home: t.TempDir()}), receiverSettings, 2)
+	oteltest.TestReceiverHook(t, &cfg, NewFactoryWithSettings(Settings{Home: t.TempDir()}), receiverSettings, 2)
 }

x-pack/otel/oteltestcol/collector.go

@@ -102,8 +102,8 @@ func (c *Collector) Shutdown() {
 
 func getComponent() (otelcol.Factories, error) {
 	receivers, err := otelcol.MakeFactoryMap(
-		fbreceiver.NewFactory(fbreceiver.Settings{}),
-		mbreceiver.NewFactory(mbreceiver.Settings{}),
+		fbreceiver.NewFactory(),
+		mbreceiver.NewFactory(),
 	)
 	if err != nil {
 		return otelcol.Factories{}, nil //nolint:nilerr //ignoring this error