[chore] Remove internal duplicate definition of QueueBatchSettings

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

Author: bogdandrutu

exporter/exporterhelper/internal/base_exporter.go

@@ -46,7 +46,7 @@ type BaseExporter struct {
 	timeoutCfg TimeoutConfig
 	retryCfg   configretry.BackOffConfig
 
-	queueBatchSettings QueueBatchSettings[request.Request]
+	queueBatchSettings queuebatch.Settings[request.Request]
 	queueCfg           queuebatch.Config
 }
 
@@ -88,15 +88,11 @@ func NewBaseExporter(set exporter.Settings, signal pipeline.Signal, pusher sende
 	}
 
 	if be.queueCfg.Enabled {
-		qSet := queuebatch.Settings[request.Request]{
-			Signal:           signal,
-			ID:               set.ID,
-			Telemetry:        set.TelemetrySettings,
-			ReferenceCounter: be.queueBatchSettings.ReferenceCounter,
-			Encoding:         be.queueBatchSettings.Encoding,
-			ItemsSizer:       be.queueBatchSettings.ItemsSizer,
-			BytesSizer:       be.queueBatchSettings.BytesSizer,
-			Partitioner:      be.queueBatchSettings.Partitioner,
+		qSet := queuebatch.AllSettings[request.Request]{
+			Settings:  be.queueBatchSettings,
+			Signal:    signal,
+			ID:        set.ID,
+			Telemetry: set.TelemetrySettings,
 		}
 		be.QueueSender, err = NewQueueSender(qSet, be.queueCfg, be.ExportFailureMessage, be.firstSender)
 		if err != nil {
@@ -208,14 +204,14 @@ func WithQueue(cfg queuebatch.Config) Option {
 // This option should be used with the new exporter helpers New[Traces|Metrics|Logs]RequestExporter.
 // 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.
-func WithQueueBatch(cfg queuebatch.Config, set QueueBatchSettings[request.Request]) Option {
+func WithQueueBatch(cfg queuebatch.Config, set queuebatch.Settings[request.Request]) Option {
 	return func(o *BaseExporter) error {
 		if !cfg.Enabled {
 			o.ExportFailureMessage += " Try enabling sending_queue to survive temporary failures."
 			return nil
 		}
 		if cfg.StorageID != nil && set.Encoding == nil {
-			return errors.New("`QueueBatchSettings.Encoding` must not be nil when persistent queue is enabled")
+			return errors.New("`Settings.Encoding` must not be nil when persistent queue is enabled")
 		}
 		o.queueBatchSettings = set
 		o.queueCfg = cfg
@@ -233,9 +229,9 @@ func WithCapabilities(capabilities consumer.Capabilities) Option {
 	}
 }
 
-// WithQueueBatchSettings is used to set the QueueBatchSettings for the new request based exporter helper.
+// WithQueueBatchSettings is used to set the queuebatch.Settings for the new request based exporter helper.
 // It must be provided as the first option when creating a new exporter helper.
-func WithQueueBatchSettings(set QueueBatchSettings[request.Request]) Option {
+func WithQueueBatchSettings(set queuebatch.Settings[request.Request]) Option {
 	return func(o *BaseExporter) error {
 		o.queueBatchSettings = set
 		return nil

exporter/exporterhelper/internal/base_exporter_test.go

@@ -16,6 +16,7 @@ import (
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/component/componenttest"
 	"go.opentelemetry.io/collector/config/configretry"
+	"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"
@@ -57,7 +58,7 @@ func TestQueueOptionsWithRequestExporter(t *testing.T) {
 	_, err = NewBaseExporter(exportertest.NewNopSettings(exportertest.NopType), pipeline.SignalMetrics, noopExport,
 		WithQueueBatchSettings(newFakeQueueBatch()),
 		WithRetry(configretry.NewDefaultBackOffConfig()),
-		WithQueueBatch(qCfg, QueueBatchSettings[request.Request]{}))
+		WithQueueBatch(qCfg, queuebatch.Settings[request.Request]{}))
 	require.Error(t, err)
 }
 
@@ -140,8 +141,8 @@ func noopExport(context.Context, request.Request) error {
 	return nil
 }
 
-func newFakeQueueBatch() QueueBatchSettings[request.Request] {
-	return QueueBatchSettings[request.Request]{
+func newFakeQueueBatch() queuebatch.Settings[request.Request] {
+	return queuebatch.Settings[request.Request]{
 		Encoding:   fakeEncoding{},
 		ItemsSizer: request.NewItemsSizer(),
 		BytesSizer: requesttest.NewBytesSizer(),

exporter/exporterhelper/internal/queue_sender.go

@@ -8,21 +8,11 @@ import (
 
 	"go.uber.org/zap"
 
-	"go.opentelemetry.io/collector/exporter/exporterhelper/internal/queue"
 	"go.opentelemetry.io/collector/exporter/exporterhelper/internal/queuebatch"
 	"go.opentelemetry.io/collector/exporter/exporterhelper/internal/request"
 	"go.opentelemetry.io/collector/exporter/exporterhelper/internal/sender"
 )
 
-// QueueBatchSettings is a subset of the queuebatch.Settings that are needed when used within an Exporter.
-type QueueBatchSettings[T any] struct {
-	ReferenceCounter queue.ReferenceCounter[T]
-	Encoding         queue.Encoding[T]
-	ItemsSizer       request.Sizer[T]
-	BytesSizer       request.Sizer[T]
-	Partitioner      queuebatch.Partitioner[T]
-}
-
 // NewDefaultQueueConfig returns the default config for queuebatch.Config.
 // By default, the queue stores 1000 requests of telemetry and is non-blocking when full.
 func NewDefaultQueueConfig() queuebatch.Config {
@@ -39,7 +29,7 @@ func NewDefaultQueueConfig() queuebatch.Config {
 }
 
 func NewQueueSender(
-	qSet queuebatch.Settings[request.Request],
+	qSet queuebatch.AllSettings[request.Request],
 	qCfg queuebatch.Config,
 	exportFailureMessage string,
 	next sender.Sender[request.Request],

exporter/exporterhelper/internal/queue_sender_test.go

@@ -24,7 +24,7 @@ import (
 )
 
 func TestNewQueueSenderFailedRequestDropped(t *testing.T) {
-	qSet := queuebatch.Settings[request.Request]{
+	qSet := queuebatch.AllSettings[request.Request]{
 		Signal:    pipeline.SignalMetrics,
 		ID:        component.NewID(exportertest.NopType),
 		Telemetry: componenttest.NewNopTelemetrySettings(),

exporter/exporterhelper/internal/queuebatch/queue_batch.go

@@ -14,17 +14,22 @@ import (
 	"go.opentelemetry.io/collector/pipeline"
 )
 
-// Settings defines settings for creating a QueueBatch.
+// Settings is a subset of the queuebatch.Settings that are needed when used within an Exporter.
 type Settings[T any] struct {
-	Signal           pipeline.Signal
-	ID               component.ID
-	Telemetry        component.TelemetrySettings
 	ReferenceCounter queue.ReferenceCounter[T]
 	Encoding         queue.Encoding[T]
 	ItemsSizer       request.Sizer[T]
 	BytesSizer       request.Sizer[T]
 	Partitioner      Partitioner[T]
-	MergeCtx         func(context.Context, context.Context) context.Context
+}
+
+// AllSettings defines settings for creating a QueueBatch.
+type AllSettings[T any] struct {
+	Settings[T]
+	Signal    pipeline.Signal
+	ID        component.ID
+	Telemetry component.TelemetrySettings
+	MergeCtx  func(context.Context, context.Context) context.Context
 }
 
 type QueueBatch struct {
@@ -33,7 +38,7 @@ type QueueBatch struct {
 }
 
 func NewQueueBatch(
-	set Settings[request.Request],
+	set AllSettings[request.Request],
 	cfg Config,
 	next sender.SendFunc[request.Request],
 ) (*QueueBatch, error) {

exporter/exporterhelper/internal/queuebatch/queue_batch_test.go

@@ -29,14 +29,16 @@ import (
 	"go.opentelemetry.io/collector/pipeline"
 )
 
-func newFakeRequestSettings() Settings[request.Request] {
-	return Settings[request.Request]{
-		Signal:     pipeline.SignalMetrics,
-		ID:         component.NewID(exportertest.NopType),
-		Telemetry:  componenttest.NewNopTelemetrySettings(),
-		Encoding:   newFakeEncoding(&requesttest.FakeRequest{}),
-		ItemsSizer: request.NewItemsSizer(),
-		BytesSizer: requesttest.NewBytesSizer(),
+func newFakeRequestSettings() AllSettings[request.Request] {
+	return AllSettings[request.Request]{
+		Signal:    pipeline.SignalMetrics,
+		ID:        component.NewID(exportertest.NopType),
+		Telemetry: componenttest.NewNopTelemetrySettings(),
+		Settings: Settings[request.Request]{
+			Encoding:   newFakeEncoding(&requesttest.FakeRequest{}),
+			ItemsSizer: request.NewItemsSizer(),
+			BytesSizer: requesttest.NewBytesSizer(),
+		},
 	}
 }
 

exporter/exporterhelper/queue_batch.go

@@ -38,7 +38,7 @@ var ErrQueueIsFull = queue.ErrQueueIsFull
 
 // QueueBatchSettings are settings for the QueueBatch component.
 // They include things line Encoding to be used with persistent queue, or the available Sizers, etc.
-type QueueBatchSettings = internal.QueueBatchSettings[Request]
+type QueueBatchSettings = queuebatch.Settings[Request]
 
 // WithQueueBatch enables queueing and batching for an exporter.
 // This option should be used with the new exporter helpers New[Traces|Metrics|Logs]RequestExporter.