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.

Sign up for GitHub

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

fix(otel): Fix Dynamic Sampling context propagation for nested spans #559

Merged
merged 6 commits into from
Feb 1, 2023
Merged

fix(otel): Fix Dynamic Sampling context propagation for nested spans #559

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c29a05f
Refactor Inject test
tonyo Jan 31, 2023
6a0adca
Split into two tests
tonyo Jan 31, 2023
31ccc17
Move the logic to ToBaggage()
tonyo Feb 1, 2023
8cfeb42
Test for Span.ToBaggage()
tonyo Feb 1, 2023
c74fe8d
Generate/freeze baggage in Inject
tonyo Feb 1, 2023
356712c
Use ToBaggage()
tonyo Feb 1, 2023
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
11 changes: 8 additions & 3 deletions otel/helpers_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ package sentryotel
import (
"encoding/hex"
"fmt"
"log"
"reflect"
"sort"
"sync"
Expand Down Expand Up @@ -139,17 +138,23 @@ func stringPtr(s string) *string {
}

func otelTraceIDFromHex(s string) trace.TraceID {
if s == "" {
return trace.TraceID{}
}
traceID, err := trace.TraceIDFromHex(s)
if err != nil {
log.Fatalf("Cannot make a TraceID from the hex string: '%s'", s)
panic(err)
}
return traceID
}

func otelSpanIDFromHex(s string) trace.SpanID {
if s == "" {
return trace.SpanID{}
}
spanID, err := trace.SpanIDFromHex(s)
if err != nil {
log.Fatalf("Cannot make a SPanID from the hex string: '%s'", s)
panic(err)
}
return spanID
}
Expand Down
4 changes: 1 addition & 3 deletions otel/propagator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,7 @@ func (p sentryPropagator) Inject(ctx context.Context, carrier propagation.TextMa

// Propagate baggage header
sentryBaggageStr := ""
if sentrySpan != nil && sentrySpan.IsTransaction() {
// TODO(anton): Normally, this should return the DSC baggage from the transaction
// (not necessarily the current span). So this might break things in some cases.
if sentrySpan != nil {
sentryBaggageStr = sentrySpan.ToBaggage()
}
// FIXME: We're basically reparsing the header again, because internally in sentry-go
Expand Down
105 changes: 40 additions & 65 deletions otel/propagator_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,37 +28,33 @@ type transactionTestContext struct {
sampled sentry.Sampled
}

type otelTestContext struct {
traceId string
spanId string
traceFlags trace.TraceFlags
}

func createTransactionAndMaybeSpan(transactionContext transactionTestContext, withSpan bool) {
client, _ := sentry.NewClient(sentry.ClientOptions{
Dsn: "https://abc@example.com/123",
Environment: "testing",
Release: "1.2.3",
EnableTracing: true,
})
hub := sentry.NewHub(client, sentry.NewScope())
ctx := sentry.SetHubOnContext(context.Background(), hub)

func createTransactionAndMaybeSpan(transactionContext transactionTestContext, withSpan bool) trace.SpanContextConfig {
transaction := sentry.StartTransaction(
ctx,
emptyContextWithSentry(),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
emptyContextWithSentry(),
emptyCtxWithSentry(),

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a helper function that's used in multiple places already, do we really want this?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Up to you, no strong feelings.

transactionContext.name,
sentry.SpanSampled(transactionContext.sampled),
)

transaction.TraceID = TraceIDFromHex(transactionContext.traceID)
transaction.SpanID = SpanIDFromHex(transactionContext.spanID)
transaction.SetDynamicSamplingContext(sentry.DynamicSamplingContextFromTransaction(transaction))

sentrySpanMap.Set(trace.SpanID(transaction.SpanID), transaction)
if withSpan {
span := transaction.StartChild("op")
// We want the child to have the SpanID from transactionContext, so
// we "swap" span IDs from the transaction and the child span.
transaction.SpanID = span.SpanID
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure I fully understand this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When withSpan is passed, we want to create a transation and a child span. We also want the child span to have the predefined SpanID (passed via transactionContext). It means that we have to update the SpanID for the transaction. We can generate a new random one, or we can just take the already-generated one from the child span (span), that will be replaced with SpanIDFromHex(transactionContext.spanID) in the next line anyway.

span.SpanID = SpanIDFromHex(transactionContext.spanID)
sentrySpanMap.Set(trace.SpanID(span.SpanID), span)
}

transaction.SetDynamicSamplingContext(sentry.DynamicSamplingContextFromTransaction(transaction))
sentrySpanMap.Set(trace.SpanID(transaction.SpanID), transaction)

otelContext := trace.SpanContextConfig{
TraceID: otelTraceIDFromHex(transactionContext.traceID),
SpanID: otelSpanIDFromHex(transactionContext.spanID),
TraceFlags: trace.FlagsSampled,
}
return otelContext
}

func TestNewSentryPropagator(t *testing.T) {
Expand Down Expand Up @@ -122,107 +118,86 @@ func TestInjectUsesBaggageOnEmptySpan(t *testing.T) {
)
}

func TestInjectUsesSetsValidTraceFromTransaction(t *testing.T) {
func testInjectUsesSetsValidTrace(t *testing.T, withChildSpan bool) {
tests := []struct {
name string
otelSpanContext otelTestContext
sentryTransactionContext transactionTestContext
baggage *string
sentryTrace *string
wantBaggage *string
wantSentryTrace *string
}{
{
name: "should set baggage and sentry-trace when sampled",
otelSpanContext: otelTestContext{
traceId: "d4cda95b652f4a1592b449d5929fda1b",
spanId: "6e0c63257de34c92",
traceFlags: trace.FlagsSampled,
},
sentryTransactionContext: transactionTestContext{
name: "sampled-transaction",
traceID: "d4cda95b652f4a1592b449d5929fda1b",
spanID: "6e0c63257de34c92",
sampled: sentry.SampledTrue,
},
baggage: stringPtr("sentry-environment=testing,sentry-release=1.2.3,sentry-transaction=sampled-transaction,sentry-public_key=abc,sentry-trace_id=d4cda95b652f4a1592b449d5929fda1b,sentry-sample_rate=1"),
sentryTrace: stringPtr("d4cda95b652f4a1592b449d5929fda1b-6e0c63257de34c92-1"),
wantBaggage: stringPtr("sentry-environment=testing,sentry-release=1.2.3,sentry-transaction=sampled-transaction,sentry-public_key=abc,sentry-trace_id=d4cda95b652f4a1592b449d5929fda1b,sentry-sample_rate=1"),
wantSentryTrace: stringPtr("d4cda95b652f4a1592b449d5929fda1b-6e0c63257de34c92-1"),
},
{
name: "should set proper baggage and sentry-trace when not sampled",
otelSpanContext: otelTestContext{
traceId: "d4cda95b652f4a1592b449d5929fda1b",
spanId: "6e0c63257de34c92",
traceFlags: trace.FlagsSampled,
},
sentryTransactionContext: transactionTestContext{
name: "not-sampled-transaction",
traceID: "d4cda95b652f4a1592b449d5929fda1b",
spanID: "6e0c63257de34c92",
sampled: sentry.SampledFalse,
},
baggage: stringPtr("sentry-environment=testing,sentry-release=1.2.3,sentry-transaction=not-sampled-transaction,sentry-public_key=abc,sentry-trace_id=d4cda95b652f4a1592b449d5929fda1b"),
sentryTrace: stringPtr("d4cda95b652f4a1592b449d5929fda1b-6e0c63257de34c92-0"),
wantBaggage: stringPtr("sentry-environment=testing,sentry-release=1.2.3,sentry-transaction=not-sampled-transaction,sentry-public_key=abc,sentry-trace_id=d4cda95b652f4a1592b449d5929fda1b"),
wantSentryTrace: stringPtr("d4cda95b652f4a1592b449d5929fda1b-6e0c63257de34c92-0"),
},
{
name: "should NOT set headers when traceId is empty",
otelSpanContext: otelTestContext{
traceId: "",
spanId: "6e0c63257de34c92",
traceFlags: trace.FlagsSampled,
},
sentryTransactionContext: transactionTestContext{
name: "transaction-name",
traceID: "",
spanID: "6e0c63257de34c92",
sampled: sentry.SampledTrue,
},
baggage: nil,
sentryTrace: nil,
wantBaggage: nil,
wantSentryTrace: nil,
},
{
name: "should NOT set headers when spanId is empty",
otelSpanContext: otelTestContext{
traceId: "d4cda95b652f4a1592b449d5929fda1b",
spanId: "",
traceFlags: trace.FlagsSampled,
},
sentryTransactionContext: transactionTestContext{
name: "transaction-name",
traceID: "d4cda95b652f4a1592b449d5929fda1b",
spanID: "",
sampled: sentry.SampledTrue,
},
baggage: nil,
sentryTrace: nil,
wantBaggage: nil,
wantSentryTrace: nil,
},
}

for _, tt := range tests {
tt := tt
t.Run(tt.name, func(t *testing.T) {
propagator, carrier := setupPropagatorTest()
traceId, _ := trace.TraceIDFromHex(tt.otelSpanContext.traceId)
spanId, _ := trace.SpanIDFromHex(tt.otelSpanContext.spanId)
otelSpanContext := trace.NewSpanContext(trace.SpanContextConfig{
TraceID: traceId,
SpanID: spanId,
TraceFlags: tt.otelSpanContext.traceFlags,
})
testContextConfig := createTransactionAndMaybeSpan(tt.sentryTransactionContext, withChildSpan)
otelSpanContext := trace.NewSpanContext(testContextConfig)
ctx := trace.ContextWithSpanContext(context.Background(), otelSpanContext)
createTransactionAndMaybeSpan(tt.sentryTransactionContext, false)

propagator.Inject(ctx, carrier)

expectedCarrier := propagation.MapCarrier{}
if tt.baggage != nil {
expectedCarrier["baggage"] = *tt.baggage
if tt.wantBaggage != nil {
expectedCarrier["baggage"] = *tt.wantBaggage
}
if tt.sentryTrace != nil {
expectedCarrier["sentry-trace"] = *tt.sentryTrace
if tt.wantSentryTrace != nil {
expectedCarrier["sentry-trace"] = *tt.wantSentryTrace
}
assertMapCarrierEqual(t, carrier, expectedCarrier)
})
}
}

func TestInjectUsesSetsValidTraceFromTransaction(t *testing.T) {
testInjectUsesSetsValidTrace(t, false)
}

func TestInjectUsesSetsValidTraceFromChildSpan(t *testing.T) {
testInjectUsesSetsValidTrace(t, true)
}

/// Extract
Expand Down
5 changes: 4 additions & 1 deletion tracing.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,10 @@ func (s *Span) ToSentryTrace() string {

// ToBaggage returns the serialized dynamic sampling context in the baggage format.
func (s *Span) ToBaggage() string {
return s.dynamicSamplingContext.String()
if containingTransaction := s.GetTransaction(); containingTransaction != nil {
return containingTransaction.dynamicSamplingContext.String()
}
return ""
tonyo marked this conversation as resolved.
Show resolved Hide resolved
}

// SetDynamicSamplingContext sets the given dynamic sampling context on the
Expand Down