1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2024-12-22 20:06:07 +02:00
opentelemetry-go/bridge/opentracing
Kaushal Shah 86f325839c
Added methods for SpanID and TraceID on bridgeSpanContext (#3966)
* Added methods for SpanID and TraceID on bridgeSpanContext

* changed test name

* Added entry in changelog, updated readme, added comments on methods and fixed test case

* updated CHANGELOG.md

* promoted all methods from SpanContext to bridgeSpanContext

* fixed readme and removed redudant IsSampled() from bridgeContext

* fixed readme lint

* Apply suggestions from code review

Co-authored-by: Robert Pająk <pellared@hotmail.com>

* addressed code review comment

---------

Co-authored-by: Robert Pająk <pellared@hotmail.com>
2023-04-25 10:11:03 -07:00
..
internal Implement IsSampled for OpenTelemetry bridgeSpanContext (#3570) 2023-02-23 13:11:48 -08:00
migration Avoid creating new references on WithDeferredSetup for every span (#3833) 2023-03-07 07:40:31 -06:00
test Move global metric back to otel/metric/global for minor release (#3986) 2023-04-13 07:39:39 -07:00
bridge_test.go Added methods for SpanID and TraceID on bridgeSpanContext (#3966) 2023-04-25 10:11:03 -07:00
bridge.go Added methods for SpanID and TraceID on bridgeSpanContext (#3966) 2023-04-25 10:11:03 -07:00
doc.go Update doc.go (#2030) 2021-06-25 07:56:12 -07:00
go.mod Move global metric back to otel/metric/global for minor release (#3986) 2023-04-13 07:39:39 -07:00
go.sum dependabot updates Sun Apr 2 15:32:08 UTC 2023 (#3963) 2023-04-02 12:10:19 -04:00
mix_test.go Replace use of old term label with attribute (#2790) 2022-04-18 07:31:31 -07:00
provider_test.go bridge/opentracing: introduce NewTracerProvider that wraps TracerProvider instead of Tracer (#3116) 2023-01-11 16:59:06 -08:00
provider.go bridge/opentracing: introduce NewTracerProvider that wraps TracerProvider instead of Tracer (#3116) 2023-01-11 16:59:06 -08:00
README.md Added methods for SpanID and TraceID on bridgeSpanContext (#3966) 2023-04-25 10:11:03 -07:00
util.go docs(typos): Run codespell to fix typos (#3980) 2023-04-11 17:28:13 -07:00
wrapper.go bridge/opentracing: introduce NewTracerProvider that wraps TracerProvider instead of Tracer (#3116) 2023-01-11 16:59:06 -08:00

OpenTelemetry/OpenTracing Bridge

Getting started

go get go.opentelemetry.io/otel/bridge/opentracing

Assuming you have configured an OpenTelemetry TracerProvider, these will be the steps to follow to wire up the bridge:

import (
	"go.opentelemetry.io/otel"
	otelBridge "go.opentelemetry.io/otel/bridge/opentracing"
)

func main() {
	/* Create tracerProvider and configure OpenTelemetry ... */
	
	otelTracer := tracerProvider.Tracer("tracer_name")
	// Use the bridgeTracer as your OpenTracing tracer.
	bridgeTracer, wrapperTracerProvider := otelBridge.NewTracerPair(otelTracer)
	// Set the wrapperTracerProvider as the global OpenTelemetry
	// TracerProvider so instrumentation will use it by default.
	otel.SetTracerProvider(wrapperTracerProvider)

	/* ... */
}

Interop from trace context from OpenTracing to OpenTelemetry

In order to get OpenTracing spans properly into the OpenTelemetry context, so they can be propagated (both internally, and externally), you will need to explicitly use the BridgeTracer for creating your OpenTracing spans, rather than a bare OpenTracing Tracer instance.

When you have started an OpenTracing Span, make sure the OpenTelemetry knows about it like this:

	ctxWithOTSpan := opentracing.ContextWithSpan(ctx, otSpan)
	ctxWithOTAndOTelSpan := bridgeTracer.ContextWithSpanHook(ctxWithOTSpan, otSpan)
	// Propagate the otSpan to both OpenTracing and OpenTelemetry
	// instrumentation by using the ctxWithOTAndOTelSpan context.

Extended Functionality

The bridge functionality can be extended beyond the OpenTracing API.

Any trace.SpanContext method can be accessed as following:

type spanContextProvider interface {
	IsSampled() bool
	TraceID() trace.TraceID
	SpanID() trace.SpanID
	TraceFlags() trace.TraceFlags
	... // any other available method can be added here to access it
}

var sc opentracing.SpanContext = ...
if s, ok := sc.(spanContextProvider); ok {
	// Use TraceID by s.TraceID()
	// Use SpanID by s.SpanID()
	// Use TraceFlags by s.TraceFlags()
	...
}