Support OTEL_PROPAGATORS to configure tracing propagation
Co-authored-by: Romain <rtribotte@users.noreply.github.com>
This commit is contained in:
Baptiste Mayelle
GitHub
parent
5a2e233a15
commit
baf687218c
6 changed files with 288 additions and 45 deletions
|
|
@ -16,7 +16,6 @@ import (
|
|||
"go.opentelemetry.io/otel/exporters/otlp/otlptrace"
|
||||
"go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc"
|
||||
"go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp"
|
||||
"go.opentelemetry.io/otel/propagation"
|
||||
"go.opentelemetry.io/otel/sdk/resource"
|
||||
sdktrace "go.opentelemetry.io/otel/sdk/trace"
|
||||
semconv "go.opentelemetry.io/otel/semconv/v1.21.0"
|
||||
|
|
@ -82,7 +81,6 @@ func (c *Config) Setup(serviceName string, sampleRate float64, globalAttributes
|
|||
)
|
||||
|
||||
otel.SetTracerProvider(tracerProvider)
|
||||
otel.SetTextMapPropagator(propagation.TraceContext{})
|
||||
|
||||
log.Debug().Msg("OpenTelemetry tracer configured")
|
||||
|
||||
|
|
|
|||
|
|
@ -23,9 +23,11 @@ import (
|
|||
|
||||
func TestTracing(t *testing.T) {
|
||||
tests := []struct {
|
||||
desc string
|
||||
headers map[string]string
|
||||
assertFn func(*testing.T, string)
|
||||
desc string
|
||||
propagators string
|
||||
headers map[string]string
|
||||
wantServiceHeadersFn func(t *testing.T, headers http.Header)
|
||||
assertFn func(*testing.T, string)
|
||||
}{
|
||||
{
|
||||
desc: "service name and version",
|
||||
|
|
@ -37,11 +39,18 @@ func TestTracing(t *testing.T) {
|
|||
},
|
||||
},
|
||||
{
|
||||
desc: "context propagation",
|
||||
desc: "TraceContext propagation",
|
||||
propagators: "tracecontext",
|
||||
headers: map[string]string{
|
||||
"traceparent": "00-00000000000000000000000000000001-0000000000000001-01",
|
||||
"tracestate": "foo=bar",
|
||||
},
|
||||
wantServiceHeadersFn: func(t *testing.T, headers http.Header) {
|
||||
t.Helper()
|
||||
|
||||
assert.Regexp(t, `(00-00000000000000000000000000000001-\w{16}-01)`, headers["Traceparent"][0])
|
||||
assert.Equal(t, []string{"foo=bar"}, headers["Tracestate"])
|
||||
},
|
||||
assertFn: func(t *testing.T, trace string) {
|
||||
t.Helper()
|
||||
|
||||
|
|
@ -50,6 +59,188 @@ func TestTracing(t *testing.T) {
|
|||
assert.Regexp(t, `("traceState":"foo=bar")`, trace)
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "root span TraceContext propagation",
|
||||
propagators: "tracecontext",
|
||||
wantServiceHeadersFn: func(t *testing.T, headers http.Header) {
|
||||
t.Helper()
|
||||
|
||||
assert.Regexp(t, `(00-\w{32}-\w{16}-01)`, headers["Traceparent"][0])
|
||||
},
|
||||
assertFn: func(t *testing.T, trace string) {
|
||||
t.Helper()
|
||||
|
||||
assert.Regexp(t, `("traceId":"\w{32}")`, trace)
|
||||
assert.Regexp(t, `("parentSpanId":"\w{16}")`, trace)
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "B3 propagation",
|
||||
propagators: "b3",
|
||||
headers: map[string]string{
|
||||
"b3": "00000000000000000000000000000001-0000000000000002-1-0000000000000001",
|
||||
},
|
||||
wantServiceHeadersFn: func(t *testing.T, headers http.Header) {
|
||||
t.Helper()
|
||||
|
||||
assert.Regexp(t, `(00000000000000000000000000000001-\w{16}-1)`, headers["B3"][0])
|
||||
},
|
||||
assertFn: func(t *testing.T, trace string) {
|
||||
t.Helper()
|
||||
|
||||
assert.Regexp(t, `("traceId":"00000000000000000000000000000001")`, trace)
|
||||
assert.Regexp(t, `("parentSpanId":"0000000000000002")`, trace)
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "root span B3 propagation",
|
||||
propagators: "b3",
|
||||
wantServiceHeadersFn: func(t *testing.T, headers http.Header) {
|
||||
t.Helper()
|
||||
|
||||
assert.Regexp(t, `(\w{32}-\w{16}-1)`, headers["B3"][0])
|
||||
},
|
||||
assertFn: func(t *testing.T, trace string) {
|
||||
t.Helper()
|
||||
|
||||
assert.Regexp(t, `("traceId":"\w{32}")`, trace)
|
||||
assert.Regexp(t, `("parentSpanId":"\w{16}")`, trace)
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "B3 propagation Multiple Headers",
|
||||
propagators: "b3multi",
|
||||
headers: map[string]string{
|
||||
"x-b3-traceid": "00000000000000000000000000000001",
|
||||
"x-b3-parentspanid": "0000000000000001",
|
||||
"x-b3-spanid": "0000000000000002",
|
||||
"x-b3-sampled": "1",
|
||||
},
|
||||
wantServiceHeadersFn: func(t *testing.T, headers http.Header) {
|
||||
t.Helper()
|
||||
|
||||
assert.Equal(t, "00000000000000000000000000000001", headers["X-B3-Traceid"][0])
|
||||
assert.Equal(t, "0000000000000001", headers["X-B3-Parentspanid"][0])
|
||||
assert.Equal(t, "1", headers["X-B3-Sampled"][0])
|
||||
assert.Len(t, headers["X-B3-Spanid"][0], 16)
|
||||
},
|
||||
assertFn: func(t *testing.T, trace string) {
|
||||
t.Helper()
|
||||
|
||||
assert.Regexp(t, `("traceId":"00000000000000000000000000000001")`, trace)
|
||||
assert.Regexp(t, `("parentSpanId":"0000000000000002")`, trace)
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "root span B3 propagation Multiple Headers",
|
||||
propagators: "b3multi",
|
||||
wantServiceHeadersFn: func(t *testing.T, headers http.Header) {
|
||||
t.Helper()
|
||||
|
||||
assert.Regexp(t, `(\w{32})`, headers["X-B3-Traceid"][0])
|
||||
assert.Equal(t, "1", headers["X-B3-Sampled"][0])
|
||||
assert.Regexp(t, `(\w{16})`, headers["X-B3-Spanid"][0])
|
||||
},
|
||||
assertFn: func(t *testing.T, trace string) {
|
||||
t.Helper()
|
||||
|
||||
assert.Regexp(t, `("traceId":"\w{32}")`, trace)
|
||||
assert.Regexp(t, `("parentSpanId":"")`, trace)
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "Baggage propagation",
|
||||
propagators: "baggage",
|
||||
headers: map[string]string{
|
||||
"baggage": "userId=id",
|
||||
},
|
||||
wantServiceHeadersFn: func(t *testing.T, headers http.Header) {
|
||||
t.Helper()
|
||||
|
||||
assert.Equal(t, []string{"userId=id"}, headers["Baggage"])
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "Jaeger propagation",
|
||||
propagators: "jaeger",
|
||||
headers: map[string]string{
|
||||
"uber-trace-id": "00000000000000000000000000000001:0000000000000002:0000000000000001:1",
|
||||
},
|
||||
wantServiceHeadersFn: func(t *testing.T, headers http.Header) {
|
||||
t.Helper()
|
||||
|
||||
assert.Regexp(t, `(00000000000000000000000000000001:\w{16}:0:1)`, headers["Uber-Trace-Id"][0])
|
||||
},
|
||||
assertFn: func(t *testing.T, trace string) {
|
||||
t.Helper()
|
||||
|
||||
assert.Regexp(t, `("traceId":"00000000000000000000000000000001")`, trace)
|
||||
assert.Regexp(t, `("parentSpanId":"\w{16}")`, trace)
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "root span Jaeger propagation",
|
||||
propagators: "jaeger",
|
||||
wantServiceHeadersFn: func(t *testing.T, headers http.Header) {
|
||||
t.Helper()
|
||||
|
||||
assert.Regexp(t, `(\w{32}:\w{16}:0:1)`, headers["Uber-Trace-Id"][0])
|
||||
},
|
||||
assertFn: func(t *testing.T, trace string) {
|
||||
t.Helper()
|
||||
|
||||
assert.Regexp(t, `("traceId":"\w{32}")`, trace)
|
||||
assert.Regexp(t, `("parentSpanId":"\w{16}")`, trace)
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "XRay propagation",
|
||||
propagators: "xray",
|
||||
headers: map[string]string{
|
||||
"X-Amzn-Trace-Id": "Root=1-5759e988-bd862e3fe1be46a994272793;Parent=53995c3f42cd8ad8;Sampled=1",
|
||||
},
|
||||
wantServiceHeadersFn: func(t *testing.T, headers http.Header) {
|
||||
t.Helper()
|
||||
|
||||
assert.Regexp(t, `(Root=1-5759e988-bd862e3fe1be46a994272793;Parent=\w{16};Sampled=1)`, headers["X-Amzn-Trace-Id"][0])
|
||||
},
|
||||
assertFn: func(t *testing.T, trace string) {
|
||||
t.Helper()
|
||||
|
||||
assert.Regexp(t, `("traceId":"5759e988bd862e3fe1be46a994272793")`, trace)
|
||||
assert.Regexp(t, `("parentSpanId":"\w{16}")`, trace)
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "root span XRay propagation",
|
||||
propagators: "xray",
|
||||
wantServiceHeadersFn: func(t *testing.T, headers http.Header) {
|
||||
t.Helper()
|
||||
|
||||
assert.Regexp(t, `(Root=1-\w{8}-\w{24};Parent=\w{16};Sampled=1)`, headers["X-Amzn-Trace-Id"][0])
|
||||
},
|
||||
assertFn: func(t *testing.T, trace string) {
|
||||
t.Helper()
|
||||
|
||||
assert.Regexp(t, `("traceId":"\w{32}")`, trace)
|
||||
assert.Regexp(t, `("parentSpanId":"\w{16}")`, trace)
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "no propagation",
|
||||
propagators: "none",
|
||||
wantServiceHeadersFn: func(t *testing.T, headers http.Header) {
|
||||
t.Helper()
|
||||
|
||||
assert.Empty(t, headers)
|
||||
},
|
||||
assertFn: func(t *testing.T, trace string) {
|
||||
t.Helper()
|
||||
|
||||
assert.Regexp(t, `("traceId":"\w{32}")`, trace)
|
||||
assert.Regexp(t, `("parentSpanId":"\w{16}")`, trace)
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
traceCh := make(chan string)
|
||||
|
|
@ -71,28 +262,44 @@ func TestTracing(t *testing.T) {
|
|||
}))
|
||||
t.Cleanup(collector.Close)
|
||||
|
||||
tracingConfig := &static.Tracing{
|
||||
ServiceName: "traefik",
|
||||
SampleRate: 1.0,
|
||||
OTLP: &opentelemetry.Config{
|
||||
HTTP: &types.OtelHTTP{
|
||||
Endpoint: collector.URL,
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
newTracing, closer, err := tracing.NewTracing(tracingConfig)
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() {
|
||||
_ = closer.Close()
|
||||
})
|
||||
|
||||
chain := alice.New(tracingMiddle.WrapEntryPointHandler(context.Background(), newTracing, "test"))
|
||||
epHandler, err := chain.Then(http.NotFoundHandler())
|
||||
require.NoError(t, err)
|
||||
|
||||
for _, test := range tests {
|
||||
t.Run(test.desc, func(t *testing.T) {
|
||||
t.Setenv("OTEL_PROPAGATORS", test.propagators)
|
||||
|
||||
service := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
tracer := tracing.TracerFromContext(r.Context())
|
||||
ctx, span := tracer.Start(r.Context(), "service")
|
||||
defer span.End()
|
||||
|
||||
r = r.WithContext(ctx)
|
||||
|
||||
tracing.InjectContextIntoCarrier(r)
|
||||
|
||||
if test.wantServiceHeadersFn != nil {
|
||||
test.wantServiceHeadersFn(t, r.Header)
|
||||
}
|
||||
})
|
||||
|
||||
tracingConfig := &static.Tracing{
|
||||
ServiceName: "traefik",
|
||||
SampleRate: 1.0,
|
||||
OTLP: &opentelemetry.Config{
|
||||
HTTP: &types.OtelHTTP{
|
||||
Endpoint: collector.URL,
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
newTracing, closer, err := tracing.NewTracing(tracingConfig)
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() {
|
||||
_ = closer.Close()
|
||||
})
|
||||
|
||||
chain := alice.New(tracingMiddle.WrapEntryPointHandler(context.Background(), newTracing, "test"))
|
||||
epHandler, err := chain.Then(service)
|
||||
require.NoError(t, err)
|
||||
|
||||
req := httptest.NewRequest(http.MethodGet, "http://www.test.com", nil)
|
||||
for k, v := range test.headers {
|
||||
req.Header.Set(k, v)
|
||||
|
|
@ -107,8 +314,10 @@ func TestTracing(t *testing.T) {
|
|||
t.Error("Trace not exported")
|
||||
|
||||
case trace := <-traceCh:
|
||||
assert.Equal(t, http.StatusNotFound, rw.Code)
|
||||
test.assertFn(t, trace)
|
||||
assert.Equal(t, http.StatusOK, rw.Code)
|
||||
if test.assertFn != nil {
|
||||
test.assertFn(t, trace)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
|
|
|
|||
|
|
@ -11,6 +11,8 @@ import (
|
|||
"github.com/rs/zerolog/log"
|
||||
"github.com/traefik/traefik/v3/pkg/config/static"
|
||||
"github.com/traefik/traefik/v3/pkg/tracing/opentelemetry"
|
||||
"go.opentelemetry.io/contrib/propagators/autoprop"
|
||||
"go.opentelemetry.io/otel"
|
||||
"go.opentelemetry.io/otel/attribute"
|
||||
"go.opentelemetry.io/otel/codes"
|
||||
"go.opentelemetry.io/otel/propagation"
|
||||
|
|
@ -37,6 +39,8 @@ func NewTracing(conf *static.Tracing) (trace.Tracer, io.Closer, error) {
|
|||
backend = defaultBackend
|
||||
}
|
||||
|
||||
otel.SetTextMapPropagator(autoprop.NewTextMapPropagator())
|
||||
|
||||
return backend.Setup(conf.ServiceName, conf.SampleRate, conf.GlobalAttributes)
|
||||
}
|
||||
|
||||
|
|
@ -57,13 +61,13 @@ func TracerFromContext(ctx context.Context) trace.Tracer {
|
|||
|
||||
// ExtractCarrierIntoContext reads cross-cutting concerns from the carrier into a Context.
|
||||
func ExtractCarrierIntoContext(ctx context.Context, headers http.Header) context.Context {
|
||||
propagator := propagation.NewCompositeTextMapPropagator(propagation.TraceContext{}, propagation.Baggage{})
|
||||
propagator := otel.GetTextMapPropagator()
|
||||
return propagator.Extract(ctx, propagation.HeaderCarrier(headers))
|
||||
}
|
||||
|
||||
// InjectContextIntoCarrier sets cross-cutting concerns from the request context into the request headers.
|
||||
func InjectContextIntoCarrier(req *http.Request) {
|
||||
propagator := propagation.NewCompositeTextMapPropagator(propagation.TraceContext{}, propagation.Baggage{})
|
||||
propagator := otel.GetTextMapPropagator()
|
||||
propagator.Inject(req.Context(), propagation.HeaderCarrier(req.Header))
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue