Remove deprecated batcher config for splunkhecexporter, use sending_queue (open-telemetry#39961)

Signed-off-by: Bogdan Drutu <[email protected]>

Author: bogdandrutu

.chloggen/rm-batcher-splunk.yaml

@@ -0,0 +1,27 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: breaking
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: splunkhecexporter
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Remove deprecated batcher config for splunkhecexporter, use sending_queue::batch
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [39961]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: [user]

exporter/splunkhecexporter/config.go

@@ -68,10 +68,6 @@ type Config struct {
 	QueueSettings             exporterhelper.QueueBatchConfig `mapstructure:"sending_queue"`
 	configretry.BackOffConfig `mapstructure:"retry_on_failure"`
 
-	// Experimental: This configuration is at the early stage of development and may change without backward compatibility
-	// until https://github.com/open-telemetry/opentelemetry-collector/issues/8122 is resolved.
-	BatcherConfig exporterhelper.BatcherConfig `mapstructure:"batcher"` //nolint:staticcheck
-
 	// LogDataEnabled can be used to disable sending logs by the exporter.
 	LogDataEnabled bool `mapstructure:"log_data_enabled"`
 

exporter/splunkhecexporter/config_test.go

@@ -90,16 +90,12 @@ func TestLoadConfig(t *testing.T) {
 				QueueSettings: exporterhelper.QueueBatchConfig{
 					Enabled:      true,
 					NumConsumers: 2,
-					QueueSize:    10,
-					Sizer:        exporterhelper.RequestSizerTypeRequests,
-				},
-				BatcherConfig: exporterhelper.BatcherConfig{ //nolint:staticcheck
-					Enabled:      true,
-					FlushTimeout: time.Second,
-					SizeConfig: exporterhelper.SizeConfig{ //nolint:staticcheck
-						Sizer:   exporterhelper.RequestSizerTypeItems,
-						MinSize: 1,
-						MaxSize: 10,
+					QueueSize:    1000,
+					Sizer:        exporterhelper.RequestSizerTypeItems,
+					Batch: &exporterhelper.BatchConfig{
+						FlushTimeout: time.Second,
+						MinSize:      10,
+						MaxSize:      100,
 					},
 				},
 				OtelAttrsToHec: splunk.HecToOtelAttrs{
@@ -144,9 +140,9 @@ func TestLoadConfig(t *testing.T) {
 
 			sub, err := cm.Sub(tt.id.String())
 			require.NoError(t, err)
-			require.NoError(t, sub.Unmarshal(cfg))
 
-			assert.NoError(t, xconfmap.Validate(cfg))
+			require.NoError(t, sub.Unmarshal(cfg))
+			require.NoError(t, xconfmap.Validate(cfg))
 			assert.Equal(t, tt.expected, cfg)
 		})
 	}

exporter/splunkhecexporter/factory.go

@@ -58,9 +58,6 @@ func NewFactory() exporter.Factory {
 }
 
 func createDefaultConfig() component.Config {
-	batcherCfg := exporterhelper.NewDefaultBatcherConfig() //nolint:staticcheck
-	batcherCfg.Enabled = false
-
 	defaultMaxConns := defaultMaxIdleCons
 	defaultIdleConnTimeout := defaultIdleConnTimeout
 
@@ -79,7 +76,6 @@ func createDefaultConfig() component.Config {
 		SplunkAppName:           defaultSplunkAppName,
 		BackOffConfig:           configretry.NewDefaultBackOffConfig(),
 		QueueSettings:           exporterhelper.NewDefaultQueueConfig(),
-		BatcherConfig:           batcherCfg,
 		DisableCompression:      false,
 		MaxContentLengthLogs:    defaultContentLengthLogsLimit,
 		MaxContentLengthMetrics: defaultContentLengthMetricsLimit,
@@ -132,7 +128,6 @@ func createTracesExporter(
 		exporterhelper.WithQueue(cfg.QueueSettings),
 		exporterhelper.WithStart(c.start),
 		exporterhelper.WithShutdown(c.stop),
-		exporterhelper.WithBatcher(cfg.BatcherConfig), //nolint:staticcheck
 	)
 	if err != nil {
 		return nil, err
@@ -166,7 +161,6 @@ func createMetricsExporter(
 		exporterhelper.WithQueue(cfg.QueueSettings),
 		exporterhelper.WithStart(c.start),
 		exporterhelper.WithShutdown(c.stop),
-		exporterhelper.WithBatcher(cfg.BatcherConfig), //nolint:staticcheck
 	)
 	if err != nil {
 		return nil, err
@@ -200,7 +194,6 @@ func createLogsExporter(
 		exporterhelper.WithQueue(cfg.QueueSettings),
 		exporterhelper.WithStart(c.start),
 		exporterhelper.WithShutdown(c.stop),
-		exporterhelper.WithBatcher(cfg.BatcherConfig), //nolint:staticcheck
 	)
 	if err != nil {
 		return nil, err

exporter/splunkhecexporter/factory_test.go

@@ -6,6 +6,7 @@ package splunkhecexporter
 import (
 	"context"
 	"testing"
+	"time"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -111,7 +112,12 @@ func TestFactory_EnabledBatchingMakesExporterMutable(t *testing.T) {
 	require.NoError(t, err)
 	assert.False(t, le.Capabilities().MutatesData)
 
-	config.BatcherConfig = exporterhelper.NewDefaultBatcherConfig() //nolint:staticcheck
+	config.QueueSettings = exporterhelper.NewDefaultQueueConfig()
+	config.QueueSettings.Sizer = exporterhelper.RequestSizerTypeItems
+	config.QueueSettings.Batch = &exporterhelper.BatchConfig{
+		FlushTimeout: 200 * time.Millisecond,
+		MinSize:      8192,
+	}
 
 	me, err = createMetricsExporter(context.Background(), exportertest.NewNopSettings(metadata.Type), config)
 	require.NoError(t, err)

exporter/splunkhecexporter/testdata/config.yaml

@@ -20,17 +20,17 @@ splunk_hec/allsettings:
   sending_queue:
     enabled: true
     num_consumers: 2
-    queue_size: 10
+    queue_size: 1000
+    sizer: "items"
+    batch:
+      flush_timeout: 1s
+      min_size: 10
+      max_size: 100
   retry_on_failure:
     enabled: true
     initial_interval: 10s
     max_interval: 60s
     max_elapsed_time: 10m
-  batcher:
-    enabled: true
-    flush_timeout: 1s
-    min_size: 1
-    max_size: 10
   splunk_app_name: "OpenTelemetry-Collector Splunk Exporter"
   splunk_app_version: "v0.0.1"
   otel_attrs_to_hec_metadata: