Deprecated everything in exporterbatcher, alias from exporterhelper (open-telemetry#12707)

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

Author: bogdandrutu

.chloggen/deprecate-exporterbatcher.yaml

@@ -0,0 +1,26 @@
+# 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. otlpreceiver)
+component: exporterbatcher
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Deprecated Config, SizeConfig, SizerType, SizerType[Requests|Items|Bytes], NewDefaultConfig. Use alias from exporterhelper.
+
+
+# One or more tracking issues or pull requests related to the change
+issues: [12707]
+
+# (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:
+
+# 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: [api]

exporter/exporterbatcher/config.go

@@ -4,66 +4,26 @@
 package exporterbatcher // import "go.opentelemetry.io/collector/exporter/exporterbatcher"
 
 import (
-	"errors"
-	"fmt"
-	"time"
+	"go.opentelemetry.io/collector/exporter/exporterhelper"
 )
 
-// Config defines a configuration for batching requests based on a timeout and a minimum number of items.
-// Experimental: This API 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.
-type Config struct {
-	// Enabled indicates whether to not enqueue batches before sending to the consumerSender.
-	Enabled bool `mapstructure:"enabled"`
+// Deprecated: [v0.123.0] use exporterhelper.BatcherConfig
+type Config = exporterhelper.BatcherConfig
 
-	// FlushTimeout sets the time after which a batch will be sent regardless of its size.
-	FlushTimeout time.Duration `mapstructure:"flush_timeout"`
+// Deprecated: [v0.123.0] use exporterhelper.SizeConfig
+type SizeConfig = exporterhelper.SizeConfig
 
-	// SizeConfig sets the size limits for a batch.
-	SizeConfig `mapstructure:",squash"`
-}
+// Deprecated: [v0.123.0] use exporterhelper.RequestSizerType
+type SizerType = exporterhelper.RequestSizerType
 
-// SizeConfig sets the size limits for a batch.
-type SizeConfig struct {
-	Sizer SizerType `mapstructure:"sizer"`
+// Deprecated: [v0.123.0] use exporterhelper.RequestSizerTypeRequests
+var SizerTypeRequests = exporterhelper.RequestSizerTypeRequests
 
-	// MinSize defines the configuration for the minimum size of a batch.
-	MinSize int `mapstructure:"min_size"`
-	// MaxSize defines the configuration for the maximum size of a batch.
-	MaxSize int `mapstructure:"max_size"`
-}
+// Deprecated: [v0.123.0] use exporterhelper.RequestSizerTypeItems
+var SizerTypeItems = exporterhelper.RequestSizerTypeItems
 
-func (c *Config) Validate() error {
-	if c.FlushTimeout <= 0 {
-		return errors.New("`flush_timeout` must be greater than zero")
-	}
+// Deprecated: [v0.123.0] use exporterhelper.RequestSizerTypeRequests
+var SizerTypeBytes = exporterhelper.RequestSizerTypeBytes
 
-	return nil
-}
-
-func (c SizeConfig) Validate() error {
-	if c.Sizer != SizerTypeItems {
-		return fmt.Errorf("unsupported sizer type: %q", c.Sizer)
-	}
-	if c.MinSize < 0 {
-		return errors.New("`min_size` must be greater than or equal to zero")
-	}
-	if c.MaxSize < 0 {
-		return errors.New("`max_size` must be greater than or equal to zero")
-	}
-	if c.MaxSize != 0 && c.MaxSize < c.MinSize {
-		return errors.New("`max_size` must be greater than or equal to mix_size")
-	}
-	return nil
-}
-
-func NewDefaultConfig() Config {
-	return Config{
-		Enabled:      true,
-		FlushTimeout: 200 * time.Millisecond,
-		SizeConfig: SizeConfig{
-			Sizer:   SizerTypeItems,
-			MinSize: 8192,
-		},
-	}
-}
+// Deprecated: [v0.123.0] use exporterhelper.NewDefaultBatcherConfig
+var NewDefaultConfig = exporterhelper.NewDefaultBatcherConfig

exporter/exporterbatcher/config_test.go

@@ -14,7 +14,6 @@ import (
 	"go.opentelemetry.io/collector/config/configretry"
 	"go.opentelemetry.io/collector/consumer"
 	"go.opentelemetry.io/collector/exporter"
-	"go.opentelemetry.io/collector/exporter/exporterbatcher"
 	"go.opentelemetry.io/collector/exporter/exporterhelper/internal/queuebatch"
 	"go.opentelemetry.io/collector/exporter/exporterhelper/internal/request"
 	"go.opentelemetry.io/collector/exporter/exporterhelper/internal/sender"
@@ -49,7 +48,7 @@ type BaseExporter struct {
 
 	queueBatchSettings QueueBatchSettings[request.Request]
 	queueCfg           QueueConfig
-	batcherCfg         exporterbatcher.Config
+	batcherCfg         BatcherConfig
 }
 
 func NewBaseExporter(set exporter.Settings, signal pipeline.Signal, pusher sender.SendFunc[request.Request], options ...Option) (*BaseExporter, error) {
@@ -237,7 +236,7 @@ func WithCapabilities(capabilities consumer.Capabilities) Option {
 // WithRequestBatchFuncs provided.
 // This API 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.
-func WithBatcher(cfg exporterbatcher.Config) Option {
+func WithBatcher(cfg BatcherConfig) Option {
 	return func(o *BaseExporter) error {
 		o.batcherCfg = cfg
 		return nil

exporter/exporterhelper/internal/base_exporter.go

@@ -16,8 +16,6 @@ import (
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/component/componenttest"
 	"go.opentelemetry.io/collector/config/configretry"
-	"go.opentelemetry.io/collector/exporter/exporterbatcher"
-	"go.opentelemetry.io/collector/exporter/exporterhelper/internal/queuebatch"
 	"go.opentelemetry.io/collector/exporter/exporterhelper/internal/request"
 	"go.opentelemetry.io/collector/exporter/exporterhelper/internal/requesttest"
 	"go.opentelemetry.io/collector/exporter/exportertest"
@@ -74,7 +72,7 @@ func TestBaseExporterLogging(t *testing.T) {
 	bs, err := NewBaseExporter(set, pipeline.SignalMetrics, errExport,
 		WithQueueBatchSettings(newFakeQueueBatch()),
 		WithQueue(qCfg),
-		WithBatcher(exporterbatcher.NewDefaultConfig()),
+		WithBatcher(NewDefaultBatcherConfig()),
 		WithRetry(rCfg))
 	require.NoError(t, err)
 	require.NoError(t, bs.Start(context.Background(), componenttest.NewNopHost()))
@@ -104,7 +102,7 @@ func TestQueueRetryWithDisabledQueue(t *testing.T) {
 					return WithQueue(qs)
 				}(),
 				func() Option {
-					bs := exporterbatcher.NewDefaultConfig()
+					bs := NewDefaultBatcherConfig()
 					bs.Enabled = false
 					return WithBatcher(bs)
 				}(),
@@ -119,7 +117,7 @@ func TestQueueRetryWithDisabledQueue(t *testing.T) {
 					return WithQueueBatch(qs, newFakeQueueBatch())
 				}(),
 				func() Option {
-					bs := exporterbatcher.NewDefaultConfig()
+					bs := NewDefaultBatcherConfig()
 					bs.Enabled = false
 					return WithBatcher(bs)
 				}(),
@@ -155,8 +153,8 @@ func noopExport(context.Context, request.Request) error {
 func newFakeQueueBatch() QueueBatchSettings[request.Request] {
 	return QueueBatchSettings[request.Request]{
 		Encoding: fakeEncoding{},
-		Sizers: map[exporterbatcher.SizerType]queuebatch.Sizer[request.Request]{
-			exporterbatcher.SizerTypeRequests: queuebatch.RequestsSizer[request.Request]{},
+		Sizers: map[request.SizerType]request.Sizer[request.Request]{
+			request.SizerTypeRequests: request.RequestsSizer[request.Request]{},
 		},
 	}
 }

exporter/exporterhelper/internal/base_exporter_test.go

@@ -6,11 +6,12 @@ package internal // import "go.opentelemetry.io/collector/exporter/exporterhelpe
 import (
 	"context"
 	"errors"
+	"fmt"
+	"time"
 
 	"go.uber.org/zap"
 
 	"go.opentelemetry.io/collector/component"
-	"go.opentelemetry.io/collector/exporter/exporterbatcher"
 	"go.opentelemetry.io/collector/exporter/exporterhelper/internal/queuebatch"
 	"go.opentelemetry.io/collector/exporter/exporterhelper/internal/request"
 	"go.opentelemetry.io/collector/exporter/exporterhelper/internal/sender"
@@ -19,7 +20,7 @@ import (
 // QueueBatchSettings is a subset of the queuebatch.Settings that are needed when used within an Exporter.
 type QueueBatchSettings[K any] struct {
 	Encoding queuebatch.Encoding[K]
-	Sizers   map[exporterbatcher.SizerType]queuebatch.Sizer[K]
+	Sizers   map[request.SizerType]request.Sizer[K]
 }
 
 // NewDefaultQueueConfig returns the default config for QueueConfig.
@@ -72,7 +73,7 @@ func (qCfg *QueueConfig) Validate() error {
 func NewQueueSender(
 	qSet queuebatch.Settings[request.Request],
 	qCfg QueueConfig,
-	bCfg exporterbatcher.Config,
+	bCfg BatcherConfig,
 	exportFailureMessage string,
 	next sender.Sender[request.Request],
 ) (sender.Sender[request.Request], error) {
@@ -91,11 +92,11 @@ func NewQueueSender(
 	return queuebatch.NewQueueBatch(qSet, newQueueBatchConfig(qCfg, bCfg), exportFunc)
 }
 
-func newQueueBatchConfig(qCfg QueueConfig, bCfg exporterbatcher.Config) queuebatch.Config {
+func newQueueBatchConfig(qCfg QueueConfig, bCfg BatcherConfig) queuebatch.Config {
 	qbCfg := queuebatch.Config{
 		Enabled:         true,
 		WaitForResult:   !qCfg.Enabled,
-		Sizer:           exporterbatcher.SizerTypeRequests,
+		Sizer:           request.SizerTypeRequests,
 		QueueSize:       qCfg.QueueSize,
 		NumConsumers:    qCfg.NumConsumers,
 		BlockOnOverflow: qCfg.Blocking,
@@ -110,3 +111,62 @@ func newQueueBatchConfig(qCfg QueueConfig, bCfg exporterbatcher.Config) queuebat
 	}
 	return qbCfg
 }
+
+// BatcherConfig defines a configuration for batching requests based on a timeout and a minimum number of items.
+// Experimental: This API 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.
+type BatcherConfig struct {
+	// Enabled indicates whether to not enqueue batches before sending to the consumerSender.
+	Enabled bool `mapstructure:"enabled"`
+
+	// 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.
+	SizeConfig `mapstructure:",squash"`
+}
+
+// SizeConfig sets the size limits for a batch.
+type SizeConfig struct {
+	Sizer request.SizerType `mapstructure:"sizer"`
+
+	// MinSize defines the configuration for the minimum size of a batch.
+	MinSize int `mapstructure:"min_size"`
+	// MaxSize defines the configuration for the maximum size of a batch.
+	MaxSize int `mapstructure:"max_size"`
+}
+
+func (c *BatcherConfig) Validate() error {
+	if c.FlushTimeout <= 0 {
+		return errors.New("`flush_timeout` must be greater than zero")
+	}
+
+	return nil
+}
+
+func (c SizeConfig) Validate() error {
+	if c.Sizer != request.SizerTypeItems {
+		return fmt.Errorf("unsupported sizer type: %q", c.Sizer)
+	}
+	if c.MinSize < 0 {
+		return errors.New("`min_size` must be greater than or equal to zero")
+	}
+	if c.MaxSize < 0 {
+		return errors.New("`max_size` must be greater than or equal to zero")
+	}
+	if c.MaxSize != 0 && c.MaxSize < c.MinSize {
+		return errors.New("`max_size` must be greater than or equal to mix_size")
+	}
+	return nil
+}
+
+func NewDefaultBatcherConfig() BatcherConfig {
+	return BatcherConfig{
+		Enabled:      true,
+		FlushTimeout: 200 * time.Millisecond,
+		SizeConfig: SizeConfig{
+			Sizer:   request.SizerTypeItems,
+			MinSize: 8192,
+		},
+	}
+}