mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2025-01-10 00:29:12 +02:00
f1dad21e47
* Add new propagators package * Move B3 propagator to propagators Update all `api/trace` dependencies in the propagator. Export the isDeferred and isDebug methods of the SpanContext. These are needed by the B3 propagator to track trace state. * Move W3C trace context propagator to propagators * Update package docs with supported encodings * Move unified propagators code to own file * Update b3 exported documentation * Update trace_context exported documentation * Add code examples for B3 propagator * Add TraceContext example code * Remove internal package Move common testing declarations to the propagators_test.go file. * Add changes to Changelog * Add test to check default propagators
127 lines
3.6 KiB
Go
127 lines
3.6 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package propagators_test
|
|
|
|
import (
|
|
"context"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"go.opentelemetry.io/otel/api/propagation"
|
|
"go.opentelemetry.io/otel/api/trace"
|
|
"go.opentelemetry.io/otel/propagators"
|
|
)
|
|
|
|
const (
|
|
traceIDStr = "4bf92f3577b34da6a3ce929d0e0e4736"
|
|
spanIDStr = "00f067aa0ba902b7"
|
|
)
|
|
|
|
var (
|
|
traceID = mustTraceIDFromHex(traceIDStr)
|
|
spanID = mustSpanIDFromHex(spanIDStr)
|
|
)
|
|
|
|
func mustTraceIDFromHex(s string) (t trace.ID) {
|
|
var err error
|
|
t, err = trace.IDFromHex(s)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
return
|
|
}
|
|
|
|
func mustSpanIDFromHex(s string) (t trace.SpanID) {
|
|
var err error
|
|
t, err = trace.SpanIDFromHex(s)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
return
|
|
}
|
|
|
|
type outOfThinAirPropagator struct {
|
|
t *testing.T
|
|
}
|
|
|
|
var _ propagation.HTTPPropagator = outOfThinAirPropagator{}
|
|
|
|
func (p outOfThinAirPropagator) Extract(ctx context.Context, supplier propagation.HTTPSupplier) context.Context {
|
|
sc := trace.SpanContext{
|
|
TraceID: traceID,
|
|
SpanID: spanID,
|
|
TraceFlags: 0,
|
|
}
|
|
require.True(p.t, sc.IsValid())
|
|
return trace.ContextWithRemoteSpanContext(ctx, sc)
|
|
}
|
|
|
|
func (outOfThinAirPropagator) Inject(context.Context, propagation.HTTPSupplier) {}
|
|
|
|
func (outOfThinAirPropagator) GetAllKeys() []string {
|
|
return nil
|
|
}
|
|
|
|
type nilSupplier struct{}
|
|
|
|
var _ propagation.HTTPSupplier = nilSupplier{}
|
|
|
|
func (nilSupplier) Get(key string) string {
|
|
return ""
|
|
}
|
|
|
|
func (nilSupplier) Set(key string, value string) {}
|
|
|
|
func TestMultiplePropagators(t *testing.T) {
|
|
ootaProp := outOfThinAirPropagator{t: t}
|
|
ns := nilSupplier{}
|
|
testProps := []propagation.HTTPPropagator{
|
|
propagators.TraceContext{},
|
|
propagators.B3{},
|
|
propagators.B3{InjectEncoding: propagators.B3SingleHeader},
|
|
propagators.B3{InjectEncoding: propagators.B3SingleHeader | propagators.B3MultipleHeader},
|
|
}
|
|
bg := context.Background()
|
|
// sanity check of oota propagator, ensuring that it really
|
|
// generates the valid span context out of thin air
|
|
{
|
|
props := propagation.New(propagation.WithExtractors(ootaProp))
|
|
ctx := propagation.ExtractHTTP(bg, props, ns)
|
|
sc := trace.RemoteSpanContextFromContext(ctx)
|
|
require.True(t, sc.IsValid(), "oota prop failed sanity check")
|
|
}
|
|
// sanity check for real propagators, ensuring that they
|
|
// really are not putting any valid span context into an empty
|
|
// go context in absence of the HTTP headers.
|
|
for _, prop := range testProps {
|
|
props := propagation.New(propagation.WithExtractors(prop))
|
|
ctx := propagation.ExtractHTTP(bg, props, ns)
|
|
sc := trace.RemoteSpanContextFromContext(ctx)
|
|
require.Falsef(t, sc.IsValid(), "%#v failed sanity check", prop)
|
|
}
|
|
for _, prop := range testProps {
|
|
props := propagation.New(propagation.WithExtractors(ootaProp, prop))
|
|
ctx := propagation.ExtractHTTP(bg, props, ns)
|
|
sc := trace.RemoteSpanContextFromContext(ctx)
|
|
assert.Truef(t, sc.IsValid(), "%#v clobbers span context", prop)
|
|
}
|
|
}
|
|
|
|
func TestDefaultHTTPPropagator(t *testing.T) {
|
|
assert.IsType(t, propagators.TraceContext{}, propagators.DefaultHTTPPropagator())
|
|
}
|