opentelemetry-collector/exporter/exporterhelper/traces_test.go

448 lines
18 KiB
Go

// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
package exporterhelper
import (
"context"
"errors"
"testing"
"time"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/attribute"
sdktrace "go.opentelemetry.io/otel/sdk/trace"
"go.opentelemetry.io/otel/sdk/trace/tracetest"
"go.opentelemetry.io/otel/trace"
nooptrace "go.opentelemetry.io/otel/trace/noop"
"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/component/componenttest"
"go.opentelemetry.io/collector/config/configretry"
"go.opentelemetry.io/collector/consumer"
"go.opentelemetry.io/collector/consumer/consumererror"
"go.opentelemetry.io/collector/consumer/consumertest"
"go.opentelemetry.io/collector/exporter"
"go.opentelemetry.io/collector/exporter/exportertest"
"go.opentelemetry.io/collector/exporter/internal/queue"
"go.opentelemetry.io/collector/internal/obsreportconfig/obsmetrics"
"go.opentelemetry.io/collector/pdata/ptrace"
"go.opentelemetry.io/collector/pdata/testdata"
)
const (
fakeTraceParentSpanName = "fake_trace_parent_span_name"
)
var (
fakeTracesExporterName = component.MustNewIDWithName("fake_traces_exporter", "with_name")
fakeTracesExporterConfig = struct{}{}
)
func TestTracesRequest(t *testing.T) {
mr := newTracesRequest(testdata.GenerateTraces(1), nil)
traceErr := consumererror.NewTraces(errors.New("some error"), ptrace.NewTraces())
assert.EqualValues(t, newTracesRequest(ptrace.NewTraces(), nil), mr.(RequestErrorHandler).OnError(traceErr))
}
func TestTracesExporter_InvalidName(t *testing.T) {
te, err := NewTracesExporter(context.Background(), exportertest.NewNopSettings(), nil, newTraceDataPusher(nil))
require.Nil(t, te)
require.Equal(t, errNilConfig, err)
}
func TestTracesExporter_NilLogger(t *testing.T) {
te, err := NewTracesExporter(context.Background(), exporter.Settings{}, &fakeTracesExporterConfig, newTraceDataPusher(nil))
require.Nil(t, te)
require.Equal(t, errNilLogger, err)
}
func TestTracesRequestExporter_NilLogger(t *testing.T) {
te, err := NewTracesRequestExporter(context.Background(), exporter.Settings{}, (&fakeRequestConverter{}).requestFromTracesFunc)
require.Nil(t, te)
require.Equal(t, errNilLogger, err)
}
func TestTracesExporter_NilPushTraceData(t *testing.T) {
te, err := NewTracesExporter(context.Background(), exportertest.NewNopSettings(), &fakeTracesExporterConfig, nil)
require.Nil(t, te)
require.Equal(t, errNilPushTraceData, err)
}
func TestTracesRequestExporter_NilTracesConverter(t *testing.T) {
te, err := NewTracesRequestExporter(context.Background(), exportertest.NewNopSettings(), nil)
require.Nil(t, te)
require.Equal(t, errNilTracesConverter, err)
}
func TestTracesExporter_Default(t *testing.T) {
td := ptrace.NewTraces()
te, err := NewTracesExporter(context.Background(), exportertest.NewNopSettings(), &fakeTracesExporterConfig, newTraceDataPusher(nil))
assert.NotNil(t, te)
assert.NoError(t, err)
assert.Equal(t, consumer.Capabilities{MutatesData: false}, te.Capabilities())
assert.NoError(t, te.Start(context.Background(), componenttest.NewNopHost()))
assert.NoError(t, te.ConsumeTraces(context.Background(), td))
assert.NoError(t, te.Shutdown(context.Background()))
}
func TestTracesRequestExporter_Default(t *testing.T) {
td := ptrace.NewTraces()
te, err := NewTracesRequestExporter(context.Background(), exportertest.NewNopSettings(),
(&fakeRequestConverter{}).requestFromTracesFunc)
assert.NotNil(t, te)
assert.NoError(t, err)
assert.Equal(t, consumer.Capabilities{MutatesData: false}, te.Capabilities())
assert.NoError(t, te.Start(context.Background(), componenttest.NewNopHost()))
assert.NoError(t, te.ConsumeTraces(context.Background(), td))
assert.NoError(t, te.Shutdown(context.Background()))
}
func TestTracesExporter_WithCapabilities(t *testing.T) {
capabilities := consumer.Capabilities{MutatesData: true}
te, err := NewTracesExporter(context.Background(), exportertest.NewNopSettings(), &fakeTracesExporterConfig, newTraceDataPusher(nil), WithCapabilities(capabilities))
assert.NotNil(t, te)
assert.NoError(t, err)
assert.Equal(t, capabilities, te.Capabilities())
}
func TestTracesRequestExporter_WithCapabilities(t *testing.T) {
capabilities := consumer.Capabilities{MutatesData: true}
te, err := NewTracesRequestExporter(context.Background(), exportertest.NewNopSettings(),
(&fakeRequestConverter{}).requestFromTracesFunc, WithCapabilities(capabilities))
assert.NotNil(t, te)
assert.NoError(t, err)
assert.Equal(t, capabilities, te.Capabilities())
}
func TestTracesExporter_Default_ReturnError(t *testing.T) {
td := ptrace.NewTraces()
want := errors.New("my_error")
te, err := NewTracesExporter(context.Background(), exportertest.NewNopSettings(), &fakeTracesExporterConfig, newTraceDataPusher(want))
require.NoError(t, err)
require.NotNil(t, te)
err = te.ConsumeTraces(context.Background(), td)
require.Equal(t, want, err)
}
func TestTracesRequestExporter_Default_ConvertError(t *testing.T) {
td := ptrace.NewTraces()
want := errors.New("convert_error")
te, err := NewTracesRequestExporter(context.Background(), exportertest.NewNopSettings(),
(&fakeRequestConverter{tracesError: want}).requestFromTracesFunc)
require.NoError(t, err)
require.NotNil(t, te)
require.Equal(t, consumererror.NewPermanent(want), te.ConsumeTraces(context.Background(), td))
}
func TestTracesRequestExporter_Default_ExportError(t *testing.T) {
td := ptrace.NewTraces()
want := errors.New("export_error")
te, err := NewTracesRequestExporter(context.Background(), exportertest.NewNopSettings(),
(&fakeRequestConverter{requestError: want}).requestFromTracesFunc)
require.NoError(t, err)
require.NotNil(t, te)
require.Equal(t, want, te.ConsumeTraces(context.Background(), td))
}
func TestTracesExporter_WithPersistentQueue(t *testing.T) {
qCfg := NewDefaultQueueConfig()
storageID := component.MustNewIDWithName("file_storage", "storage")
qCfg.StorageID = &storageID
rCfg := configretry.NewDefaultBackOffConfig()
ts := consumertest.TracesSink{}
set := exportertest.NewNopSettings()
set.ID = component.MustNewIDWithName("test_traces", "with_persistent_queue")
te, err := NewTracesExporter(context.Background(), set, &fakeTracesExporterConfig, ts.ConsumeTraces, WithRetry(rCfg), WithQueue(qCfg))
require.NoError(t, err)
host := &mockHost{ext: map[component.ID]component.Component{
storageID: queue.NewMockStorageExtension(nil),
}}
require.NoError(t, te.Start(context.Background(), host))
t.Cleanup(func() { require.NoError(t, te.Shutdown(context.Background())) })
traces := testdata.GenerateTraces(2)
require.NoError(t, te.ConsumeTraces(context.Background(), traces))
require.Eventually(t, func() bool {
return len(ts.AllTraces()) == 1 && ts.SpanCount() == 2
}, 500*time.Millisecond, 10*time.Millisecond)
}
func TestTracesExporter_WithRecordMetrics(t *testing.T) {
tt, err := componenttest.SetupTelemetry(fakeTracesExporterName)
require.NoError(t, err)
t.Cleanup(func() { require.NoError(t, tt.Shutdown(context.Background())) })
te, err := NewTracesExporter(context.Background(), exporter.Settings{ID: fakeTracesExporterName, TelemetrySettings: tt.TelemetrySettings(), BuildInfo: component.NewDefaultBuildInfo()}, &fakeTracesExporterConfig, newTraceDataPusher(nil))
require.NoError(t, err)
require.NotNil(t, te)
checkRecordedMetricsForTracesExporter(t, tt, te, nil)
}
func TestTracesExporter_pLogModifiedDownStream_WithRecordMetrics(t *testing.T) {
tt, err := componenttest.SetupTelemetry(fakeTracesExporterName)
require.NoError(t, err)
t.Cleanup(func() { require.NoError(t, tt.Shutdown(context.Background())) })
te, err := NewTracesExporter(context.Background(), exporter.Settings{ID: fakeTracesExporterName, TelemetrySettings: tt.TelemetrySettings(), BuildInfo: component.NewDefaultBuildInfo()}, &fakeTracesExporterConfig, newTraceDataPusherModifiedDownstream(nil), WithCapabilities(consumer.Capabilities{MutatesData: true}))
assert.NotNil(t, te)
assert.NoError(t, err)
td := testdata.GenerateTraces(2)
assert.NoError(t, te.ConsumeTraces(context.Background(), td))
assert.Equal(t, 0, td.SpanCount())
require.NoError(t, tt.CheckExporterTraces(int64(2), 0))
}
func TestTracesRequestExporter_WithRecordMetrics(t *testing.T) {
tt, err := componenttest.SetupTelemetry(fakeTracesExporterName)
require.NoError(t, err)
t.Cleanup(func() { require.NoError(t, tt.Shutdown(context.Background())) })
te, err := NewTracesRequestExporter(context.Background(),
exporter.Settings{ID: fakeTracesExporterName, TelemetrySettings: tt.TelemetrySettings(), BuildInfo: component.NewDefaultBuildInfo()},
(&fakeRequestConverter{}).requestFromTracesFunc)
require.NoError(t, err)
require.NotNil(t, te)
checkRecordedMetricsForTracesExporter(t, tt, te, nil)
}
func TestTracesExporter_WithRecordMetrics_ReturnError(t *testing.T) {
want := errors.New("my_error")
tt, err := componenttest.SetupTelemetry(fakeTracesExporterName)
require.NoError(t, err)
t.Cleanup(func() { require.NoError(t, tt.Shutdown(context.Background())) })
te, err := NewTracesExporter(context.Background(), exporter.Settings{ID: fakeTracesExporterName, TelemetrySettings: tt.TelemetrySettings(), BuildInfo: component.NewDefaultBuildInfo()}, &fakeTracesExporterConfig, newTraceDataPusher(want))
require.NoError(t, err)
require.NotNil(t, te)
checkRecordedMetricsForTracesExporter(t, tt, te, want)
}
func TestTracesRequestExporter_WithRecordMetrics_RequestSenderError(t *testing.T) {
want := errors.New("export_error")
tt, err := componenttest.SetupTelemetry(fakeTracesExporterName)
require.NoError(t, err)
t.Cleanup(func() { require.NoError(t, tt.Shutdown(context.Background())) })
te, err := NewTracesRequestExporter(context.Background(),
exporter.Settings{ID: fakeTracesExporterName, TelemetrySettings: tt.TelemetrySettings(), BuildInfo: component.NewDefaultBuildInfo()},
(&fakeRequestConverter{requestError: want}).requestFromTracesFunc)
require.NoError(t, err)
require.NotNil(t, te)
checkRecordedMetricsForTracesExporter(t, tt, te, want)
}
func TestTracesExporter_WithRecordEnqueueFailedMetrics(t *testing.T) {
tt, err := componenttest.SetupTelemetry(fakeTracesExporterName)
require.NoError(t, err)
t.Cleanup(func() { require.NoError(t, tt.Shutdown(context.Background())) })
rCfg := configretry.NewDefaultBackOffConfig()
qCfg := NewDefaultQueueConfig()
qCfg.NumConsumers = 1
qCfg.QueueSize = 2
wantErr := errors.New("some-error")
te, err := NewTracesExporter(context.Background(), exporter.Settings{ID: fakeTracesExporterName, TelemetrySettings: tt.TelemetrySettings(), BuildInfo: component.NewDefaultBuildInfo()}, &fakeTracesExporterConfig, newTraceDataPusher(wantErr), WithRetry(rCfg), WithQueue(qCfg))
require.NoError(t, err)
require.NotNil(t, te)
td := testdata.GenerateTraces(2)
const numBatches = 7
for i := 0; i < numBatches; i++ {
// errors are checked in the checkExporterEnqueueFailedTracesStats function below.
_ = te.ConsumeTraces(context.Background(), td)
}
// 2 batched must be in queue, and 5 batches (10 spans) rejected due to queue overflow
require.NoError(t, tt.CheckExporterEnqueueFailedTraces(int64(10)))
}
func TestTracesExporter_WithSpan(t *testing.T) {
set := exportertest.NewNopSettings()
sr := new(tracetest.SpanRecorder)
set.TracerProvider = sdktrace.NewTracerProvider(sdktrace.WithSpanProcessor(sr))
otel.SetTracerProvider(set.TracerProvider)
defer otel.SetTracerProvider(nooptrace.NewTracerProvider())
te, err := NewTracesExporter(context.Background(), set, &fakeTracesExporterConfig, newTraceDataPusher(nil))
require.NoError(t, err)
require.NotNil(t, te)
checkWrapSpanForTracesExporter(t, sr, set.TracerProvider.Tracer("test"), te, nil, 1)
}
func TestTracesRequestExporter_WithSpan(t *testing.T) {
set := exportertest.NewNopSettings()
sr := new(tracetest.SpanRecorder)
set.TracerProvider = sdktrace.NewTracerProvider(sdktrace.WithSpanProcessor(sr))
otel.SetTracerProvider(set.TracerProvider)
defer otel.SetTracerProvider(nooptrace.NewTracerProvider())
te, err := NewTracesRequestExporter(context.Background(), set, (&fakeRequestConverter{}).requestFromTracesFunc)
require.NoError(t, err)
require.NotNil(t, te)
checkWrapSpanForTracesExporter(t, sr, set.TracerProvider.Tracer("test"), te, nil, 1)
}
func TestTracesExporter_WithSpan_ReturnError(t *testing.T) {
set := exportertest.NewNopSettings()
sr := new(tracetest.SpanRecorder)
set.TracerProvider = sdktrace.NewTracerProvider(sdktrace.WithSpanProcessor(sr))
otel.SetTracerProvider(set.TracerProvider)
defer otel.SetTracerProvider(nooptrace.NewTracerProvider())
want := errors.New("my_error")
te, err := NewTracesExporter(context.Background(), set, &fakeTracesExporterConfig, newTraceDataPusher(want))
require.NoError(t, err)
require.NotNil(t, te)
checkWrapSpanForTracesExporter(t, sr, set.TracerProvider.Tracer("test"), te, want, 1)
}
func TestTracesRequestExporter_WithSpan_ExportError(t *testing.T) {
set := exportertest.NewNopSettings()
sr := new(tracetest.SpanRecorder)
set.TracerProvider = sdktrace.NewTracerProvider(sdktrace.WithSpanProcessor(sr))
otel.SetTracerProvider(set.TracerProvider)
defer otel.SetTracerProvider(nooptrace.NewTracerProvider())
want := errors.New("export_error")
te, err := NewTracesRequestExporter(context.Background(), set, (&fakeRequestConverter{requestError: want}).requestFromTracesFunc)
require.NoError(t, err)
require.NotNil(t, te)
checkWrapSpanForTracesExporter(t, sr, set.TracerProvider.Tracer("test"), te, want, 1)
}
func TestTracesExporter_WithShutdown(t *testing.T) {
shutdownCalled := false
shutdown := func(context.Context) error { shutdownCalled = true; return nil }
te, err := NewTracesExporter(context.Background(), exportertest.NewNopSettings(), &fakeTracesExporterConfig, newTraceDataPusher(nil), WithShutdown(shutdown))
assert.NotNil(t, te)
assert.NoError(t, err)
assert.NoError(t, te.Start(context.Background(), componenttest.NewNopHost()))
assert.NoError(t, te.Shutdown(context.Background()))
assert.True(t, shutdownCalled)
}
func TestTracesRequestExporter_WithShutdown(t *testing.T) {
shutdownCalled := false
shutdown := func(context.Context) error { shutdownCalled = true; return nil }
te, err := NewTracesRequestExporter(context.Background(), exportertest.NewNopSettings(),
(&fakeRequestConverter{}).requestFromTracesFunc, WithShutdown(shutdown))
assert.NotNil(t, te)
assert.NoError(t, err)
assert.NoError(t, te.Start(context.Background(), componenttest.NewNopHost()))
assert.NoError(t, te.Shutdown(context.Background()))
assert.True(t, shutdownCalled)
}
func TestTracesExporter_WithShutdown_ReturnError(t *testing.T) {
want := errors.New("my_error")
shutdownErr := func(context.Context) error { return want }
te, err := NewTracesExporter(context.Background(), exportertest.NewNopSettings(), &fakeTracesExporterConfig, newTraceDataPusher(nil), WithShutdown(shutdownErr))
assert.NotNil(t, te)
assert.NoError(t, err)
assert.NoError(t, te.Start(context.Background(), componenttest.NewNopHost()))
assert.Equal(t, te.Shutdown(context.Background()), want)
}
func TestTracesRequestExporter_WithShutdown_ReturnError(t *testing.T) {
want := errors.New("my_error")
shutdownErr := func(context.Context) error { return want }
te, err := NewTracesRequestExporter(context.Background(), exportertest.NewNopSettings(),
(&fakeRequestConverter{}).requestFromTracesFunc, WithShutdown(shutdownErr))
assert.NotNil(t, te)
assert.NoError(t, err)
assert.NoError(t, te.Start(context.Background(), componenttest.NewNopHost()))
assert.Equal(t, te.Shutdown(context.Background()), want)
}
func newTraceDataPusher(retError error) consumer.ConsumeTracesFunc {
return func(context.Context, ptrace.Traces) error {
return retError
}
}
func newTraceDataPusherModifiedDownstream(retError error) consumer.ConsumeTracesFunc {
return func(_ context.Context, trace ptrace.Traces) error {
trace.ResourceSpans().MoveAndAppendTo(ptrace.NewResourceSpansSlice())
return retError
}
}
func checkRecordedMetricsForTracesExporter(t *testing.T, tt componenttest.TestTelemetry, te exporter.Traces, wantError error) {
td := testdata.GenerateTraces(2)
const numBatches = 7
for i := 0; i < numBatches; i++ {
require.Equal(t, wantError, te.ConsumeTraces(context.Background(), td))
}
// TODO: When the new metrics correctly count partial dropped fix this.
if wantError != nil {
require.NoError(t, tt.CheckExporterTraces(0, int64(numBatches*td.SpanCount())))
} else {
require.NoError(t, tt.CheckExporterTraces(int64(numBatches*td.SpanCount()), 0))
}
}
func generateTraceTraffic(t *testing.T, tracer trace.Tracer, te exporter.Traces, numRequests int, wantError error) {
td := ptrace.NewTraces()
td.ResourceSpans().AppendEmpty().ScopeSpans().AppendEmpty().Spans().AppendEmpty()
ctx, span := tracer.Start(context.Background(), fakeTraceParentSpanName)
defer span.End()
for i := 0; i < numRequests; i++ {
require.Equal(t, wantError, te.ConsumeTraces(ctx, td))
}
}
func checkWrapSpanForTracesExporter(t *testing.T, sr *tracetest.SpanRecorder, tracer trace.Tracer,
te exporter.Traces, wantError error, numSpans int64) { // nolint: unparam
const numRequests = 5
generateTraceTraffic(t, tracer, te, numRequests, wantError)
// Inspection time!
gotSpanData := sr.Ended()
require.Len(t, gotSpanData, numRequests+1)
parentSpan := gotSpanData[numRequests]
require.Equalf(t, fakeTraceParentSpanName, parentSpan.Name(), "SpanData %v", parentSpan)
for _, sd := range gotSpanData[:numRequests] {
require.Equalf(t, parentSpan.SpanContext(), sd.Parent(), "Exporter span not a child\nSpanData %v", sd)
checkStatus(t, sd, wantError)
sentSpans := numSpans
var failedToSendSpans int64
if wantError != nil {
sentSpans = 0
failedToSendSpans = numSpans
}
require.Containsf(t, sd.Attributes(), attribute.KeyValue{Key: obsmetrics.SentSpansKey, Value: attribute.Int64Value(sentSpans)}, "SpanData %v", sd)
require.Containsf(t, sd.Attributes(), attribute.KeyValue{Key: obsmetrics.FailedToSendSpansKey, Value: attribute.Int64Value(failedToSendSpans)}, "SpanData %v", sd)
}
}