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

ddtrace/opentracer: translate Datadog errors to OpenTracing errors #1009

Merged
merged 4 commits into from
Sep 17, 2021
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
20 changes: 18 additions & 2 deletions ddtrace/opentracer/tracer.go
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ func (t *opentracer) Inject(ctx opentracing.SpanContext, format interface{}, car
}
switch format {
case opentracing.TextMap, opentracing.HTTPHeaders:
return t.Tracer.Inject(sctx, carrier)
return translateError(t.Tracer.Inject(sctx, carrier))
default:
return opentracing.ErrUnsupportedFormat
}
Expand All @@ -83,7 +83,8 @@ func (t *opentracer) Inject(ctx opentracing.SpanContext, format interface{}, car
func (t *opentracer) Extract(format interface{}, carrier interface{}) (opentracing.SpanContext, error) {
switch format {
case opentracing.TextMap, opentracing.HTTPHeaders:
return t.Tracer.Extract(carrier)
sctx, err := t.Tracer.Extract(carrier)
return sctx, translateError(err)
default:
return nil, opentracing.ErrUnsupportedFormat
}
Expand All @@ -99,3 +100,18 @@ func (t *opentracer) ContextWithSpanHook(ctx context.Context, openSpan opentraci
}
return tracer.ContextWithSpan(ctx, ddSpan.Span)
}

func translateError(err error) error {
switch err {
case tracer.ErrSpanContextNotFound:
return opentracing.ErrSpanContextNotFound
case tracer.ErrInvalidCarrier:
return opentracing.ErrInvalidCarrier
case tracer.ErrInvalidSpanContext:
return opentracing.ErrInvalidSpanContext
case tracer.ErrSpanContextCorrupted:
return opentracing.ErrSpanContextCorrupted
default:
return err
}
}
74 changes: 74 additions & 0 deletions ddtrace/opentracer/tracer_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,77 @@ func TestSpanWithContext(t *testing.T) {
assert.True(ok)
assert.Equal(got, want.(*span).Span)
}

func TestInjectError(t *testing.T) {
ot := New()

for name, tt := range map[string]struct {
spanContext opentracing.SpanContext
format interface{}
carrier interface{}
want error
}{
"ErrInvalidSpanContext": {
spanContext: internal.NoopSpanContext{},
format: opentracing.TextMap,
carrier: opentracing.TextMapCarrier(map[string]string{}),
want: opentracing.ErrInvalidSpanContext,
},
"ErrInvalidCarrier": {
spanContext: ot.StartSpan("test.operation").Context(),
format: opentracing.TextMap,
carrier: "invalid-carrier",
want: opentracing.ErrInvalidCarrier,
},
"ErrUnsupportedFormat": {
format: "unsupported-format",
want: opentracing.ErrUnsupportedFormat,
},
} {
t.Run(name, func(t *testing.T) {
got := ot.Inject(tt.spanContext, tt.format, tt.carrier)
assert.Equal(t, tt.want, got)
})
}
}

func TestExtractError(t *testing.T) {
ot := New()

for name, tt := range map[string]struct {
format interface{}
carrier interface{}
want error
}{
"ErrSpanContextNotFound": {
format: opentracing.TextMap,
carrier: opentracing.TextMapCarrier(nil),
want: opentracing.ErrSpanContextNotFound,
},
"ErrInvalidCarrier": {
format: opentracing.TextMap,
carrier: "invalid-carrier",
want: opentracing.ErrInvalidCarrier,
},
"ErrSpanContextCorrupted": {
format: opentracing.TextMap,
carrier: opentracing.TextMapCarrier(
map[string]string{
tracer.DefaultTraceIDHeader: "-1",
tracer.DefaultParentIDHeader: "-1",
tracer.DefaultPriorityHeader: "not-a-number",
},
),
want: opentracing.ErrSpanContextCorrupted,
},
"ErrUnsupportedFormat": {
format: "unsupported-format",
want: opentracing.ErrUnsupportedFormat,
},
} {
t.Run(name, func(t *testing.T) {
_, got := ot.Extract(tt.format, tt.carrier)
assert.Equal(t, tt.want, got)
})
}
}