Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[chore] Extract last export sender from timeout sender #12358

Merged
merged 1 commit into from
Feb 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions exporter/exporterhelper/internal/base_exporter.go
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,17 @@ func NewBaseExporter(set exporter.Settings, signal pipeline.Signal, options ...O
}
}

// TimeoutSender is always initialized.
be.firstSender = &TimeoutSender{cfg: be.timeoutCfg}
// Consumer Sender is always initialized.
be.firstSender = newSender(func(ctx context.Context, req request.Request) error {
return req.Export(ctx)
})

// Next setup the timeout Sender since we want the timeout to control only the export functionality.
// Only initialize if not explicitly disabled.
if be.timeoutCfg.Timeout != 0 {
be.firstSender = newTimeoutSender(be.timeoutCfg, be.firstSender)
}

if be.retryCfg.Enabled {
be.RetrySender = newRetrySender(be.retryCfg, set, be.firstSender)
be.firstSender = be.RetrySender
Expand Down
10 changes: 2 additions & 8 deletions exporter/exporterhelper/internal/base_exporter_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,21 +36,15 @@ var (
}()
)

type noopSender struct {
component.StartFunc
component.ShutdownFunc
SendFunc[request.Request]
}

func newNoopExportSender() Sender[request.Request] {
return &noopSender{SendFunc: func(ctx context.Context, req request.Request) error {
return newSender(func(ctx context.Context, req request.Request) error {
select {
case <-ctx.Done():
return ctx.Err() // Returns the cancellation error
default:
return req.Export(ctx)
}
}}
})
}

func TestBaseExporter(t *testing.T) {
Expand Down
24 changes: 0 additions & 24 deletions exporter/exporterhelper/internal/request_sender.go

This file was deleted.

32 changes: 32 additions & 0 deletions exporter/exporterhelper/internal/sender.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

package internal // import "go.opentelemetry.io/collector/exporter/exporterhelper/internal"

import (
"context"

"go.opentelemetry.io/collector/component"
)

type Sender[K any] interface {
component.Component
Send(context.Context, K) error
}

type SendFunc[K any] func(ctx context.Context, data K) error

// sender is a Sender that emits the incoming request to the exporter consumer func.
type sender[K any] struct {
component.StartFunc
component.ShutdownFunc
consFunc SendFunc[K]
}

func newSender[K any](consFunc SendFunc[K]) Sender[K] {
return &sender[K]{consFunc: consFunc}
}

func (es *sender[K]) Send(ctx context.Context, req K) error {
return es.consFunc(ctx, req)
}
30 changes: 30 additions & 0 deletions exporter/exporterhelper/internal/sender_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

package internal

import (
"context"
"errors"
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func TestExportSenderRightArguments(t *testing.T) {
es := newSender[int64](func(_ context.Context, data int64) error {
assert.Equal(t, int64(1), data)
return nil
})
require.NoError(t, es.Send(context.Background(), int64(1)))
}

func TestExportSenderReturnsError(t *testing.T) {
err := errors.New("test error")
es := newSender[int64](func(_ context.Context, data int64) error {
assert.Equal(t, int64(1), data)
return err
})
require.ErrorIs(t, es.Send(context.Background(), int64(1)), err)
}
20 changes: 10 additions & 10 deletions exporter/exporterhelper/internal/timeout_sender.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import (
"time"

"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/exporter/exporterhelper/internal/request"
)

// TimeoutConfig for timeout. The timeout applies to individual attempts to send data to the backend.
Expand All @@ -34,21 +33,22 @@ func NewDefaultTimeoutConfig() TimeoutConfig {
}
}

// TimeoutSender is a requestSender that adds a `timeout` to every request that passes this sender.
type TimeoutSender struct {
// timeoutSender is a requestSender that adds a `timeout` to every request that passes this sender.
type timeoutSender[K any] struct {
component.StartFunc
component.ShutdownFunc
cfg TimeoutConfig
cfg TimeoutConfig
next Sender[K]
}

func (ts *TimeoutSender) Send(ctx context.Context, req request.Request) error {
// TODO: Remove this by avoiding to create the timeout sender if timeout is 0.
if ts.cfg.Timeout == 0 {
return req.Export(ctx)
}
func newTimeoutSender[K any](cfg TimeoutConfig, next Sender[K]) Sender[K] {
return &timeoutSender[K]{cfg: cfg, next: next}
}

func (ts *timeoutSender[K]) Send(ctx context.Context, req K) error {
// Intentionally don't overwrite the context inside the request, because in case of retries deadline will not be
// updated because this deadline most likely is before the next one.
tCtx, cancelFunc := context.WithTimeout(ctx, ts.cfg.Timeout)
defer cancelFunc()
return req.Export(tCtx)
return ts.next.Send(tCtx, req)
}
19 changes: 19 additions & 0 deletions exporter/exporterhelper/internal/timeout_sender_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,14 @@
package internal

import (
"context"
"testing"
"time"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

"go.opentelemetry.io/collector/component/componenttest"
)

func TestNewDefaultTimeoutConfig(t *testing.T) {
Expand All @@ -23,3 +26,19 @@ func TestInvalidTimeout(t *testing.T) {
cfg.Timeout = -1
assert.Error(t, cfg.Validate())
}

func TestNewTimeoutSender(t *testing.T) {
cfg := TimeoutConfig{Timeout: 5 * time.Second}
ts := newTimeoutSender(cfg, newSender(func(ctx context.Context, data int64) error {
deadline, ok := ctx.Deadline()
assert.True(t, ok)
timeout := time.Since(deadline)
assert.LessOrEqual(t, timeout, 5*time.Second)
assert.GreaterOrEqual(t, 4*time.Second, timeout)
assert.Equal(t, int64(7), data)
return nil
}))
require.NoError(t, ts.Start(context.Background(), componenttest.NewNopHost()))
require.NoError(t, ts.Send(context.Background(), 7))
require.NoError(t, ts.Shutdown(context.Background()))
}
Loading