(exporterhelper) Configuration package for timeout sender

.chloggen/timeout_config.yaml

@@ -0,0 +1,25 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
+component: Timeout sender configuration policy for how to respect short context deadlines.
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Policy choices are to "sustain" (default), "ignore", and "abort".
+
+# One or more tracking issues or pull requests related to the change
+issues: [11183]
+
+# (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]

config/configtimeout/Makefile

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

config/configtimeout/go.mod

@@ -0,0 +1,14 @@
+module go.opentelemetry.io/collector/config/configtimeout
+
+go 1.22.0
+
+require github.com/stretchr/testify v1.9.0
+
+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
+)

config/configtimeout/timeout.go

@@ -0,0 +1,72 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package configtimeout // import "go.opentelemetry.io/collector/config/configtimeout"
+
+import (
+	"errors"
+	"fmt"
+	"time"
+)
+
+// DefaultTimeout is the default timeout setting used by the
+// exporterhelper Timeout sender.
+const DefaultTimeout = 5 * time.Second
+
+// Policy represents a policy towards handling short timeouts, which
+// are cases where an exporter component is configured for a timeout
+// and the arriving context has a shorter deadline.
+type Policy string
+
+const (
+	PolicySustain Policy = "sustain"
+	PolicyIgnore  Policy = "ignore"
+	PolicyAbort   Policy = "abort"
+	policyUnset   Policy = ""
+
+	// PolicyDefault selects the original default behavior of the
+	// exporterhelper component, which is to send a request with
+	// shorter deadline than configured.
+	PolicyDefault = PolicySustain
+)
+
+// TimeoutConfig for timeout. The timeout applies to individual attempts to send data to the backend.
+type TimeoutConfig struct {
+	// Timeout is the timeout for every attempt to send data to the backend.
+	// A zero timeout means no timeout.
+	Timeout time.Duration `mapstructure:"timeout"`
+
+	// Policy indicates how the exporter will handle requests that
+	// arrive with a shorter deadline than the configured timeout.
+	// Note that because the TimeoutConfig is traditionally
+	// struct-embedded in the parent configuration, we use a
+	// relatively long descriptive tag name--"timeout" does not
+	// stutter as a result.
+	ShortTimeoutPolicy Policy `mapstructure:"short_timeout_policy"`
+}
+
+func (ts *TimeoutConfig) Validate() error {
+	// Negative timeouts are not acceptable, since all sends will fail.
+	if ts.Timeout < 0 {
+		return errors.New("'timeout' must be non-negative")
+	}
+	return nil
+}
+
+// NewDefaultConfig returns the default config for TimeoutConfig.
+func NewDefaultConfig() TimeoutConfig {
+	return TimeoutConfig{
+		Timeout:            DefaultTimeout,
+		ShortTimeoutPolicy: policyUnset,
+	}
+}
+
+func (tp *Policy) Validate() error {
+	switch *tp {
+	case PolicySustain, PolicyIgnore, PolicyAbort, policyUnset:
+		return nil
+	default:
+		return fmt.Errorf("unsupported timeout type %v", *tp)
+	}
+
+}

config/configtimeout/timeout_test.go

@@ -0,0 +1,46 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package configtimeout
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestUnmarshalTextValid(t *testing.T) {
+	for _, valid := range []string{
+		string(PolicySustain),
+		string(PolicyAbort),
+		string(PolicyIgnore),
+		string(policyUnset),
+		string(PolicyDefault),
+	} {
+		t.Run(valid, func(t *testing.T) {
+			pol := Policy(valid)
+			require.NoError(t, pol.Validate())
+			assert.Equal(t, Policy(valid), pol)
+		})
+	}
+}
+
+func TestUnmarshalTextInvalid(t *testing.T) {
+	for _, invalid := range []string{
+		"unknown",
+		"invalid",
+		"etc",
+	} {
+		t.Run(invalid, func(t *testing.T) {
+			pol := Policy(invalid)
+			require.Error(t, pol.Validate())
+			assert.Equal(t, Policy(invalid), pol)
+		})
+	}
+}
+
+func TestTimeoutDefaultPolicy(t *testing.T) {
+	// The default behavior matches the legacy exporterhelper code base.
+	require.Equal(t, PolicySustain, PolicyDefault)
+}

versions.yaml

@@ -35,6 +35,7 @@ module-sets:
       - go.opentelemetry.io/collector/config/configgrpc
       - go.opentelemetry.io/collector/config/confighttp
       - go.opentelemetry.io/collector/config/configtelemetry
+      - go.opentelemetry.io/collector/config/configtimeout
       - go.opentelemetry.io/collector/config/internal
       - go.opentelemetry.io/collector/connector
       - go.opentelemetry.io/collector/connector/connectorprofiles