Use new exporterbatcher.SizeConfig

See open-telemetry/opentelemetry-collector#12486

Author: axw

.chloggen/elasticsearchexporter-sizeconfig.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: deprecation
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: elasticsearchexporter
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Deprecate `batcher::min_size_items` and `batcher::max_size_items` in favor of `batcher::min_size` and `batcher::max_size`.
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: []
+
+# (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/elasticsearchexporter/config.go

@@ -15,6 +15,7 @@ import (
 	"go.opentelemetry.io/collector/config/configcompression"
 	"go.opentelemetry.io/collector/config/confighttp"
 	"go.opentelemetry.io/collector/config/configopaque"
+	"go.opentelemetry.io/collector/confmap"
 	"go.opentelemetry.io/collector/exporter/exporterbatcher"
 	"go.opentelemetry.io/collector/exporter/exporterhelper"
 	"go.uber.org/zap"
@@ -96,10 +97,31 @@ type BatcherConfig struct {
 	// FlushTimeout sets the time after which a batch will be sent regardless of its size.
 	FlushTimeout time.Duration `mapstructure:"flush_timeout"`
 
+	// SizeConfig sets the size limits for a batch.
+	exporterbatcher.SizeConfig `mapstructure:",squash"`
+
+	// Deprecated: [v0.121.0] Ignored if SizeConfig is set.
 	exporterbatcher.MinSizeConfig `mapstructure:",squash"`
+	// Deprecated: [v0.121.0] Ignored if SizeConfig is set.
 	exporterbatcher.MaxSizeConfig `mapstructure:",squash"`
 }
 
+func (c *BatcherConfig) Unmarshal(conf *confmap.Conf) error {
+	if err := conf.Unmarshal(c); err != nil {
+		return err
+	}
+
+	if c.MinSizeItems != nil && !conf.IsSet("min_size") {
+		c.SizeConfig.MinSize = *c.MinSizeItems
+	}
+
+	if c.MaxSizeItems != nil && !conf.IsSet("max_size") {
+		c.SizeConfig.MaxSize = *c.MaxSizeItems
+	}
+
+	return nil
+}
+
 type TelemetrySettings struct {
 	LogRequestBody  bool `mapstructure:"log_request_body"`
 	LogResponseBody bool `mapstructure:"log_response_body"`

exporter/elasticsearchexporter/config_test.go

@@ -118,11 +118,9 @@ func TestConfig(t *testing.T) {
 				},
 				Batcher: BatcherConfig{
 					FlushTimeout: 30 * time.Second,
-					MinSizeConfig: exporterbatcher.MinSizeConfig{ //nolint:staticcheck
-						MinSizeItems: &defaultBatcherMinSizeItems,
-					},
-					MaxSizeConfig: exporterbatcher.MaxSizeConfig{ //nolint:staticcheck
-						MaxSizeItems: nil,
+					SizeConfig: exporterbatcher.SizeConfig{
+						Sizer:   exporterbatcher.SizerTypeItems,
+						MinSize: defaultBatcherMinSizeItems,
 					},
 				},
 			},
@@ -192,11 +190,9 @@ func TestConfig(t *testing.T) {
 				},
 				Batcher: BatcherConfig{
 					FlushTimeout: 30 * time.Second,
-					MinSizeConfig: exporterbatcher.MinSizeConfig{ //nolint:staticcheck
-						MinSizeItems: &defaultBatcherMinSizeItems,
-					},
-					MaxSizeConfig: exporterbatcher.MaxSizeConfig{ //nolint:staticcheck
-						MaxSizeItems: nil,
+					SizeConfig: exporterbatcher.SizeConfig{
+						Sizer:   exporterbatcher.SizerTypeItems,
+						MinSize: defaultBatcherMinSizeItems,
 					},
 				},
 			},
@@ -266,11 +262,9 @@ func TestConfig(t *testing.T) {
 				},
 				Batcher: BatcherConfig{
 					FlushTimeout: 30 * time.Second,
-					MinSizeConfig: exporterbatcher.MinSizeConfig{ //nolint:staticcheck
-						MinSizeItems: &defaultBatcherMinSizeItems,
-					},
-					MaxSizeConfig: exporterbatcher.MaxSizeConfig{ //nolint:staticcheck
-						MaxSizeItems: nil,
+					SizeConfig: exporterbatcher.SizeConfig{
+						Sizer:   exporterbatcher.SizerTypeItems,
+						MinSize: defaultBatcherMinSizeItems,
 					},
 				},
 			},
@@ -327,6 +321,33 @@ func TestConfig(t *testing.T) {
 				cfg.Compression = "gzip"
 			}),
 		},
+		{
+			id:         component.NewIDWithName(metadata.Type, "batcher_minmax_size_items"),
+			configFile: "config.yaml",
+			expected: withDefaultConfig(func(cfg *Config) {
+				cfg.Endpoint = "https://elastic.example.com:9200"
+
+				cfg.Batcher.MinSize = 100
+				cfg.Batcher.MaxSize = 200
+				cfg.Batcher.MinSizeItems = &cfg.Batcher.MinSize
+				cfg.Batcher.MaxSizeItems = &cfg.Batcher.MaxSize
+			}),
+		},
+		{
+			id:         component.NewIDWithName(metadata.Type, "batcher_minmax_size"),
+			configFile: "config.yaml",
+			expected: withDefaultConfig(func(cfg *Config) {
+				cfg.Endpoint = "https://elastic.example.com:9200"
+
+				cfg.Batcher.MinSize = 100
+				cfg.Batcher.MaxSize = 200
+
+				minSizeItems := 300
+				maxSizeItems := 400
+				cfg.Batcher.MinSizeItems = &minSizeItems
+				cfg.Batcher.MaxSizeItems = &maxSizeItems
+			}),
+		},
 	}
 
 	for _, tt := range tests {

exporter/elasticsearchexporter/factory.go

@@ -95,11 +95,9 @@ func createDefaultConfig() component.Config {
 		},
 		Batcher: BatcherConfig{
 			FlushTimeout: 30 * time.Second,
-			MinSizeConfig: exporterbatcher.MinSizeConfig{ //nolint:staticcheck
-				MinSizeItems: &defaultBatcherMinSizeItems,
-			},
-			MaxSizeConfig: exporterbatcher.MaxSizeConfig{ //nolint:staticcheck
-				MaxSizeItems: nil,
+			SizeConfig: exporterbatcher.SizeConfig{
+				Sizer:   exporterbatcher.SizerTypeItems,
+				MinSize: defaultBatcherMinSizeItems,
 			},
 		},
 		Flush: FlushSettings{

exporter/elasticsearchexporter/testdata/config.yaml

@@ -89,3 +89,15 @@ elasticsearch/compression_none:
 elasticsearch/compression_gzip:
   endpoint: https://elastic.example.com:9200
   compression: gzip
+elasticsearch/batcher_minmax_size_items:
+  endpoint: https://elastic.example.com:9200
+  batcher:
+    min_size_items: 100
+    max_size_items: 200
+elasticsearch/batcher_minmax_size:
+  endpoint: https://elastic.example.com:9200
+  batcher:
+    min_size: 100
+    max_size: 200
+    min_size_items: 300 # min_size is set, does not carry over
+    max_size_items: 400 # max_size is set, does not carry over