[chore] [receiver/splunkhec] Remove duplicate constructor (open-telem…

…etry#36083) Reduce code duplication and remove redundant check for nil next consumer which is done in the receiverhelper.
sbylica-splunk · Dec 17, 2024 · 6931a43 · 6931a43
1 parent 0119283
commit 6931a43
Show file tree

Hide file tree

Showing 4 changed files with 81 additions and 207 deletions.
diff --git a/receiver/splunkhecreceiver/factory.go b/receiver/splunkhecreceiver/factory.go
@@ -68,7 +68,7 @@ func createMetricsReceiver(
 	var recv receiver.Metrics
 	rCfg := cfg.(*Config)
 	r := receivers.GetOrAdd(cfg, func() component.Component {
-		recv, err = newMetricsReceiver(params, *rCfg, consumer)
+		recv, err = newReceiver(params, *rCfg)
 		return recv
 	})
 	if err != nil {
@@ -89,7 +89,7 @@ func createLogsReceiver(
 	var recv receiver.Logs
 	rCfg := cfg.(*Config)
 	r := receivers.GetOrAdd(cfg, func() component.Component {
-		recv, err = newLogsReceiver(params, *rCfg, consumer)
+		recv, err = newReceiver(params, *rCfg)
 		return recv
 	})
 	if err != nil {

diff --git a/receiver/splunkhecreceiver/factory_test.go b/receiver/splunkhecreceiver/factory_test.go
@@ -41,24 +41,6 @@ func TestFactoryType(t *testing.T) {
 	assert.Equal(t, metadata.Type, NewFactory().Type())
 }
 
-func TestCreateNilNextConsumerMetrics(t *testing.T) {
-	cfg := createDefaultConfig().(*Config)
-	cfg.Endpoint = "localhost:1"
-
-	mReceiver, err := createMetricsReceiver(context.Background(), receivertest.NewNopSettings(), cfg, nil)
-	assert.EqualError(t, err, "nil metricsConsumer")
-	assert.Nil(t, mReceiver, "receiver creation failed")
-}
-
-func TestCreateNilNextConsumerLogs(t *testing.T) {
-	cfg := createDefaultConfig().(*Config)
-	cfg.Endpoint = "localhost:1"
-
-	mReceiver, err := createLogsReceiver(context.Background(), receivertest.NewNopSettings(), cfg, nil)
-	assert.EqualError(t, err, "nil logsConsumer")
-	assert.Nil(t, mReceiver, "receiver creation failed")
-}
-
 func TestMultipleLogsReceivers(t *testing.T) {
 	cfg := createDefaultConfig().(*Config)
 	cfg.Endpoint = "localhost:1"

diff --git a/receiver/splunkhecreceiver/receiver.go b/receiver/splunkhecreceiver/receiver.go
@@ -61,12 +61,10 @@ const (
 )
 
 var (
-	errNilNextMetricsConsumer = errors.New("nil metricsConsumer")
-	errNilNextLogsConsumer    = errors.New("nil logsConsumer")
-	errEmptyEndpoint          = errors.New("empty endpoint")
-	errInvalidMethod          = errors.New("invalid http method")
-	errInvalidEncoding        = errors.New("invalid encoding")
-	errExtensionMissing       = errors.New("ack extension not found")
+	errEmptyEndpoint    = errors.New("empty endpoint")
+	errInvalidMethod    = errors.New("invalid http method")
+	errInvalidEncoding  = errors.New("invalid encoding")
+	errExtensionMissing = errors.New("ack extension not found")
 
 	okRespBody                    = []byte(responseOK)
 	eventRequiredRespBody         = []byte(responseErrEventRequired)
@@ -97,17 +95,10 @@ type splunkReceiver struct {
 }
 
 var _ receiver.Metrics = (*splunkReceiver)(nil)
+var _ receiver.Logs = (*splunkReceiver)(nil)
 
-// newMetricsReceiver creates the Splunk HEC receiver with the given configuration.
-func newMetricsReceiver(
-	settings receiver.Settings,
-	config Config,
-	nextConsumer consumer.Metrics,
-) (receiver.Metrics, error) {
-	if nextConsumer == nil {
-		return nil, errNilNextMetricsConsumer
-	}
-
+// newReceiver creates the Splunk HEC receiver with the given configuration.
+func newReceiver(settings receiver.Settings, config Config) (*splunkReceiver, error) {
 	if config.Endpoint == "" {
 		return nil, errEmptyEndpoint
 	}
@@ -126,9 +117,8 @@ func newMetricsReceiver(
 		return nil, err
 	}
 	r := &splunkReceiver{
-		settings:        settings,
-		config:          &config,
-		metricsConsumer: nextConsumer,
+		settings: settings,
+		config:   &config,
 		server: &http.Server{
 			Addr: config.Endpoint,
 			// TODO: Evaluate what properties should be configurable, for now
@@ -143,51 +133,6 @@ func newMetricsReceiver(
 	return r, nil
 }
 
-// newLogsReceiver creates the Splunk HEC receiver with the given configuration.
-func newLogsReceiver(
-	settings receiver.Settings,
-	config Config,
-	nextConsumer consumer.Logs,
-) (receiver.Logs, error) {
-	if nextConsumer == nil {
-		return nil, errNilNextLogsConsumer
-	}
-
-	if config.Endpoint == "" {
-		return nil, errEmptyEndpoint
-	}
-	transport := "http"
-	if config.TLSSetting != nil {
-		transport = "https"
-	}
-
-	obsrecv, err := receiverhelper.NewObsReport(receiverhelper.ObsReportSettings{
-		ReceiverID:             settings.ID,
-		Transport:              transport,
-		ReceiverCreateSettings: settings,
-	})
-	if err != nil {
-		return nil, err
-	}
-
-	r := &splunkReceiver{
-		settings:     settings,
-		config:       &config,
-		logsConsumer: nextConsumer,
-		server: &http.Server{
-			Addr: config.Endpoint,
-			// TODO: Evaluate what properties should be configurable, for now
-			//		set some hard-coded values.
-			ReadHeaderTimeout: defaultServerTimeout,
-			WriteTimeout:      defaultServerTimeout,
-		},
-		gzipReaderPool: &sync.Pool{New: func() any { return new(gzip.Reader) }},
-		obsrecv:        obsrecv,
-	}
-
-	return r, nil
-}
-
 // Start tells the receiver to start its processing.
 // By convention the consumer of the received data is set when the receiver
 // instance is created.