Merge branch 'main' into filter-bag-mem

Author: MrAlias

CHANGELOG.md

@@ -23,6 +23,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - Use `c.FullPath()` method to set `http.route` attribute in `go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin`. (#5734)
 - The double setup in `go.opentelemetry.io/contrib/instrumentation/net/http/httptrace/otelhttptrace/example` that caused duplicate traces. (#5564)
 - Out-of-bounds panic in case of invalid span ID in `go.opentelemetry.io/contrib/propagators/b3`. (#5754)
+- Do not panic if a zero-value `SpanProcessor` is used from `go.opentelemetry.io/contrib/processors/baggage/baggagetrace`. (#5811)
 
 ### Deprecated
 
@@ -47,7 +48,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - Update `go.opentelemetry.io/contrib/config` to latest released configuration schema which introduces breaking changes where `Attributes` is now a `map[string]interface{}`. (#5758)
 - Rename `BaggageKeyPredicate` to `Filter` in `go.opentelemetry.io/contrib/processors/baggage/baggagetrace`. (#5809)
 - Return `*SpanProcessor` from `"go.opentelemetry.io/contrib/processors/baggage/baggagetrace".New` instead of the `trace.SpanProcessor` interface. (#5810)
-- The `BaggageKeyPredicate` in `go.opentelemetry.io/contrib/processors/baggage/baggagetrace` now accepts a `baggage.Member` as a parameter instead of a string. (#5813)
+- The `Filter` in `go.opentelemetry.io/contrib/processors/baggage/baggagetrace` now accepts a `baggage.Member` as a parameter instead of a string. (#5813)
 
 ## [1.27.0/0.52.0/0.21.0/0.7.0/0.2.0] - 2024-05-21
 

processors/baggage/baggagetrace/processor.go

@@ -30,6 +30,8 @@ var _ trace.SpanProcessor = (*SpanProcessor)(nil)
 // The Baggage span processor duplicates onto a span the attributes found
 // in Baggage in the parent context at the moment the span is started.
 // The passed filter determines which baggage members are added to the span.
+//
+// If filter is nil, all baggage members will be added.
 func New(filter Filter) *SpanProcessor {
 	return &SpanProcessor{
 		filter: filter,
@@ -38,8 +40,13 @@ func New(filter Filter) *SpanProcessor {
 
 // OnStart is called when a span is started and adds span attributes for baggage contents.
 func (processor SpanProcessor) OnStart(ctx context.Context, span trace.ReadWriteSpan) {
+	filter := processor.filter
+	if filter == nil {
+		filter = AllowAllMembers
+	}
+
 	for _, member := range otelbaggage.FromContext(ctx).Members() {
-		if processor.filter(member) {
+		if filter(member) {
 			span.SetAttributes(attribute.String(member.Key(), member.Value()))
 		}
 	}

processors/baggage/baggagetrace/processor_test.go

@@ -9,11 +9,13 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
 	"go.opentelemetry.io/otel/attribute"
 	otelbaggage "go.opentelemetry.io/otel/baggage"
 	"go.opentelemetry.io/otel/sdk/trace"
+	"go.opentelemetry.io/otel/sdk/trace/tracetest"
 )
 
 var _ trace.SpanExporter = &testExporter{}
@@ -151,3 +153,28 @@ func addEntryToBaggage(t *testing.T, baggage otelbaggage.Baggage, key, value str
 	require.NoError(t, err)
 	return baggage
 }
+
+func TestZeroSpanProcessorNoPanic(t *testing.T) {
+	sp := new(SpanProcessor)
+
+	m, err := otelbaggage.NewMember("key", "val")
+	require.NoError(t, err)
+	b, err := otelbaggage.New(m)
+	require.NoError(t, err)
+
+	ctx := otelbaggage.ContextWithBaggage(context.Background(), b)
+	roS := (tracetest.SpanStub{}).Snapshot()
+	rwS := rwSpan{}
+	assert.NotPanics(t, func() {
+		sp.OnStart(ctx, rwS)
+		sp.OnEnd(roS)
+		_ = sp.ForceFlush(ctx)
+		_ = sp.Shutdown(ctx)
+	})
+}
+
+type rwSpan struct {
+	trace.ReadWriteSpan
+}
+
+func (s rwSpan) SetAttributes(kv ...attribute.KeyValue) {}