Deprecate exporterhelper.RetrySettings in favor of configretry.BackOffSettings

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

Author: bogdandrutu

.chloggen/deprecateretry.yaml

@@ -0,0 +1,13 @@
+# 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: "exporterhelper"
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: "Deprecate exporterhelper.RetrySettings in favor of configretry.BackOffSettings"
+
+# One or more tracking issues or pull requests related to the change
+issues: [9091]

cmd/otelcorecol/builder-config.yaml

@@ -31,6 +31,7 @@ replaces:
   - go.opentelemetry.io/collector/config/confighttp => ../../config/confighttp
   - go.opentelemetry.io/collector/config/confignet => ../../config/confignet
   - go.opentelemetry.io/collector/config/configopaque => ../../config/configopaque
+  - go.opentelemetry.io/collector/config/configretry => ../config/configretry
   - go.opentelemetry.io/collector/config/configtelemetry => ../../config/configtelemetry
   - go.opentelemetry.io/collector/config/configtls => ../../config/configtls
   - go.opentelemetry.io/collector/config/internal => ../../config/internal

cmd/otelcorecol/go.mod

@@ -84,6 +84,7 @@ require (
 	go.opentelemetry.io/collector/config/confighttp v0.91.0 // indirect
 	go.opentelemetry.io/collector/config/confignet v0.91.0 // indirect
 	go.opentelemetry.io/collector/config/configopaque v0.91.0 // indirect
+	go.opentelemetry.io/collector/config/configretry v0.91.0 // indirect
 	go.opentelemetry.io/collector/config/configtelemetry v0.91.0 // indirect
 	go.opentelemetry.io/collector/config/configtls v0.91.0 // indirect
 	go.opentelemetry.io/collector/config/internal v0.91.0 // indirect
@@ -146,6 +147,8 @@ replace go.opentelemetry.io/collector/config/confignet => ../../config/confignet
 
 replace go.opentelemetry.io/collector/config/configopaque => ../../config/configopaque
 
+replace go.opentelemetry.io/collector/config/configretry => ../../config/configretry
+
 replace go.opentelemetry.io/collector/config/configtelemetry => ../../config/configtelemetry
 
 replace go.opentelemetry.io/collector/config/configtls => ../../config/configtls

component/host.go

@@ -50,7 +50,7 @@ type Host interface {
 	// GetExporters can be called by the component anytime after Component.Start() begins and
 	// until Component.Shutdown() ends.
 	//
-	// Deprecated: [0.79.0] This function will be removed in the future.
+	// Deprecated: `[0.79.0]` This function will be removed in the future.
 	// Several components in the contrib repository use this function so it cannot be removed
 	// before those cases are removed. In most cases, use of this function can be replaced by a
 	// connector. See https://github.com/open-telemetry/opentelemetry-collector/issues/7370 and

config/configgrpc/go.mod

@@ -86,6 +86,8 @@ replace go.opentelemetry.io/collector/config/configopaque => ../configopaque
 
 replace go.opentelemetry.io/collector/config/configtls => ../configtls
 
+replace go.opentelemetry.io/collector/config/configretry => ../../config/configretry
+
 replace go.opentelemetry.io/collector/config/configtelemetry => ../configtelemetry
 
 replace go.opentelemetry.io/collector/config/internal => ../internal
@@ -102,12 +104,12 @@ replace go.opentelemetry.io/collector/exporter => ../../exporter
 
 replace go.opentelemetry.io/collector/receiver => ../../receiver
 
-replace go.opentelemetry.io/collector/connector => ../../connector
-
 replace go.opentelemetry.io/collector/featuregate => ../../featuregate
 
 replace go.opentelemetry.io/collector/pdata => ../../pdata
 
 replace go.opentelemetry.io/collector/component => ../../component
 
 replace go.opentelemetry.io/collector/consumer => ../../consumer
+
+replace go.opentelemetry.io/collector/connector => ../../connector

config/confighttp/go.mod

@@ -88,3 +88,5 @@ replace go.opentelemetry.io/collector/pdata => ../../pdata
 replace go.opentelemetry.io/collector/component => ../../component
 
 replace go.opentelemetry.io/collector/consumer => ../../consumer
+
+replace go.opentelemetry.io/collector/config/configretry => ../configretry

config/configretry/Makefile

@@ -0,0 +1 @@
+include ../../Makefile.Common

config/configretry/backoff.go

@@ -0,0 +1,65 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package configretry
+
+import (
+	"errors"
+	"time"
+
+	"github.com/cenkalti/backoff/v4"
+)
+
+// NewDefaultBackOffSettings returns the default settings for RetrySettings.
+func NewDefaultBackOffSettings() BackOffSettings {
+	return BackOffSettings{
+		Enabled:             true,
+		InitialInterval:     5 * time.Second,
+		RandomizationFactor: backoff.DefaultRandomizationFactor,
+		Multiplier:          backoff.DefaultMultiplier,
+		MaxInterval:         30 * time.Second,
+		MaxElapsedTime:      5 * time.Minute,
+	}
+}
+
+// BackOffSettings defines configuration for retrying batches in case of export failure.
+// The current supported strategy is exponential backoff.
+type BackOffSettings struct {
+	// Enabled indicates whether to not retry sending batches in case of export failure.
+	Enabled bool `mapstructure:"enabled"`
+	// InitialInterval the time to wait after the first failure before retrying.
+	InitialInterval time.Duration `mapstructure:"initial_interval"`
+	// RandomizationFactor is a random factor used to calculate next backoffs
+	// Randomized interval = RetryInterval * (1 ± RandomizationFactor)
+	RandomizationFactor float64 `mapstructure:"randomization_factor"`
+	// Multiplier is the value multiplied by the backoff interval bounds
+	Multiplier float64 `mapstructure:"multiplier"`
+	// MaxInterval is the upper bound on backoff interval. Once this value is reached the delay between
+	// consecutive retries will always be `MaxInterval`.
+	MaxInterval time.Duration `mapstructure:"max_interval"`
+	// MaxElapsedTime is the maximum amount of time (including retries) spent trying to send a request/batch.
+	// Once this value is reached, the data is discarded.
+	MaxElapsedTime time.Duration `mapstructure:"max_elapsed_time"`
+}
+
+func (bs *BackOffSettings) Validate() error {
+	if !bs.Enabled {
+		return nil
+	}
+	if bs.InitialInterval < 0 {
+		return errors.New("initial interval must be non-negative")
+	}
+	if bs.RandomizationFactor < 0 || bs.RandomizationFactor > 1 {
+		return errors.New("randomization factor must be within [0, 1]")
+	}
+	if bs.Multiplier <= 0 {
+		return errors.New("multiplier must be positive")
+	}
+	if bs.MaxInterval < 0 {
+		return errors.New("max interval must be non-negative")
+	}
+	if bs.MaxElapsedTime < 0 {
+		return errors.New("max elapsed time must be non-negative")
+	}
+	return nil
+}

config/configretry/backoff_test.go

@@ -0,0 +1,70 @@
+package configretry
+
+import (
+	"github.com/stretchr/testify/assert"
+	"testing"
+	"time"
+)
+
+func TestNewDefaultBackOffSettings(t *testing.T) {
+	cfg := NewDefaultBackOffSettings()
+	assert.NoError(t, cfg.Validate())
+	assert.Equal(t,
+		BackOffSettings{
+			Enabled:             true,
+			InitialInterval:     5 * time.Second,
+			RandomizationFactor: 0.5,
+			Multiplier:          1.5,
+			MaxInterval:         30 * time.Second,
+			MaxElapsedTime:      5 * time.Minute,
+		}, cfg)
+}
+
+func TestInvalidInitialInterval(t *testing.T) {
+	cfg := NewDefaultBackOffSettings()
+	assert.NoError(t, cfg.Validate())
+	cfg.InitialInterval = -1
+	assert.Error(t, cfg.Validate())
+}
+
+func TestInvalidRandomizationFactor(t *testing.T) {
+	cfg := NewDefaultBackOffSettings()
+	assert.NoError(t, cfg.Validate())
+	cfg.RandomizationFactor = -1
+	assert.Error(t, cfg.Validate())
+	cfg.RandomizationFactor = 2
+	assert.Error(t, cfg.Validate())
+}
+
+func TestInvalidMultiplier(t *testing.T) {
+	cfg := NewDefaultBackOffSettings()
+	assert.NoError(t, cfg.Validate())
+	cfg.Multiplier = 0
+	assert.Error(t, cfg.Validate())
+}
+
+func TestInvalidMaxInterval(t *testing.T) {
+	cfg := NewDefaultBackOffSettings()
+	assert.NoError(t, cfg.Validate())
+	cfg.MaxInterval = -1
+	assert.Error(t, cfg.Validate())
+}
+
+func TestInvalidMaxElapsedTime(t *testing.T) {
+	cfg := NewDefaultBackOffSettings()
+	assert.NoError(t, cfg.Validate())
+	cfg.MaxElapsedTime = -1
+	assert.Error(t, cfg.Validate())
+}
+
+func TestDisabledWithInvalidValues(t *testing.T) {
+	cfg := BackOffSettings{
+		Enabled:             false,
+		InitialInterval:     -1,
+		RandomizationFactor: -1,
+		Multiplier:          0,
+		MaxInterval:         -1,
+		MaxElapsedTime:      -1,
+	}
+	assert.NoError(t, cfg.Validate())
+}

config/configretry/go.mod

@@ -0,0 +1,17 @@
+module go.opentelemetry.io/collector/config/configretry
+
+go 1.20
+
+require (
+	github.com/cenkalti/backoff/v4 v4.2.1
+	github.com/stretchr/testify v1.8.4
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/kr/pretty v0.3.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/rogpeppe/go-internal v1.10.0 // indirect
+	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)