| 1 |
// Copyright The OpenTelemetry Authors |
| 2 |
// SPDX-License-Identifier: Apache-2.0 |
| 3 |
|
| 4 |
package opentracing // import "go.opentelemetry.io/otel/bridge/opentracing" |
| 5 |
|
| 6 |
import ( |
| 7 |
"context" |
| 8 |
|
| 9 |
"go.opentelemetry.io/otel/bridge/opentracing/migration" |
| 10 |
"go.opentelemetry.io/otel/trace" |
| 11 |
"go.opentelemetry.io/otel/trace/embedded" |
| 12 |
) |
| 13 |
|
| 14 |
// WrapperTracerProvider is an OpenTelemetry TracerProvider that wraps an |
| 15 |
// OpenTracing Tracer, created by the deprecated NewWrappedTracerProvider. |
| 16 |
// |
| 17 |
// Deprecated: Use the TracerProvider from NewTracerProvider(...) instead. |
| 18 |
type WrapperTracerProvider struct { |
| 19 |
embedded.TracerProvider |
| 20 |
|
| 21 |
wTracer *WrapperTracer |
| 22 |
} |
| 23 |
|
| 24 |
var _ trace.TracerProvider = (*WrapperTracerProvider)(nil) |
| 25 |
|
| 26 |
// Tracer returns the WrapperTracer associated with the WrapperTracerProvider. |
| 27 |
func (p *WrapperTracerProvider) Tracer(string, ...trace.TracerOption) trace.Tracer { |
| 28 |
return p.wTracer |
| 29 |
} |
| 30 |
|
| 31 |
// NewWrappedTracerProvider creates a new trace provider that creates a single |
| 32 |
// instance of WrapperTracer that wraps OpenTelemetry tracer, and always returns |
| 33 |
// it unmodified from Tracer(). |
| 34 |
// |
| 35 |
// Deprecated: Use NewTracerProvider(...) instead. |
| 36 |
func NewWrappedTracerProvider(bridge *BridgeTracer, tracer trace.Tracer) *WrapperTracerProvider { |
| 37 |
return &WrapperTracerProvider{ |
| 38 |
wTracer: NewWrapperTracer(bridge, tracer), |
| 39 |
} |
| 40 |
} |
| 41 |
|
| 42 |
// WrapperTracer is a wrapper around an OpenTelemetry tracer. It |
| 43 |
// mostly forwards the calls to the wrapped tracer, but also does some |
| 44 |
// extra steps like setting up a context with the active OpenTracing |
| 45 |
// span. |
| 46 |
// |
| 47 |
// It does not need to be used when the OpenTelemetry tracer is also |
| 48 |
// aware how to operate in environment where OpenTracing API is also |
| 49 |
// used. |
| 50 |
type WrapperTracer struct { |
| 51 |
embedded.Tracer |
| 52 |
|
| 53 |
bridge *BridgeTracer |
| 54 |
tracer trace.Tracer |
| 55 |
} |
| 56 |
|
| 57 |
var ( |
| 58 |
_ trace.Tracer = &WrapperTracer{} |
| 59 |
_ migration.DeferredContextSetupTracerExtension = &WrapperTracer{} |
| 60 |
) |
| 61 |
|
| 62 |
// NewWrapperTracer wraps the passed tracer and also talks to the |
| 63 |
// passed bridge tracer when setting up the context with the new |
| 64 |
// active OpenTracing span. |
| 65 |
func NewWrapperTracer(bridge *BridgeTracer, tracer trace.Tracer) *WrapperTracer { |
| 66 |
return &WrapperTracer{ |
| 67 |
bridge: bridge, |
| 68 |
tracer: tracer, |
| 69 |
} |
| 70 |
} |
| 71 |
|
| 72 |
func (t *WrapperTracer) otelTracer() trace.Tracer { |
| 73 |
return t.tracer |
| 74 |
} |
| 75 |
|
| 76 |
// Start forwards the call to the wrapped tracer. It also tries to |
| 77 |
// override the tracer of the returned span if the span implements the |
| 78 |
// OverrideTracerSpanExtension interface. |
| 79 |
func (t *WrapperTracer) Start( |
| 80 |
ctx context.Context, |
| 81 |
name string, |
| 82 |
opts ...trace.SpanStartOption, |
| 83 |
) (context.Context, trace.Span) { |
| 84 |
ctx, span := t.otelTracer().Start(ctx, name, opts...) |
| 85 |
if spanWithExtension, ok := span.(migration.OverrideTracerSpanExtension); ok { |
| 86 |
spanWithExtension.OverrideTracer(t) |
| 87 |
} |
| 88 |
if !migration.SkipContextSetup(ctx) { |
| 89 |
ctx = t.bridge.ContextWithBridgeSpan(ctx, span) |
| 90 |
} |
| 91 |
return ctx, span |
| 92 |
} |
| 93 |
|
| 94 |
// DeferredContextSetupHook is a part of the implementation of the |
| 95 |
// DeferredContextSetupTracerExtension interface. It will try to |
| 96 |
// forward the call to the wrapped tracer if it implements the |
| 97 |
// interface. |
| 98 |
func (t *WrapperTracer) DeferredContextSetupHook(ctx context.Context, span trace.Span) context.Context { |
| 99 |
if tracerWithExtension, ok := t.otelTracer().(migration.DeferredContextSetupTracerExtension); ok { |
| 100 |
ctx = tracerWithExtension.DeferredContextSetupHook(ctx, span) |
| 101 |
} |
| 102 |
ctx = trace.ContextWithSpan(ctx, span) |
| 103 |
return ctx |
| 104 |
} |