1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2024-12-10 09:50:58 +02:00
opentelemetry-go/bridge/opentracing
Yuri Shkuro 68975917e5
[bridge/ot] Fall-back to TextMap carrier when it's not ot.HttpHeaders (#3679)
* [bridge/ot] Fall-back to TextMap carrier when it's not ot.HttpHeaders

Signed-off-by: Yuri Shkuro <github@ysh.us>

* changelog

* go mod tidy

* format

* fix deps

* delint

* simplify

* undo

* Fix changelog

* Move new tests under test/

* go fmt

* delint

Signed-off-by: Yuri Shkuro <github@ysh.us>

---------

Signed-off-by: Yuri Shkuro <github@ysh.us>
Co-authored-by: Chester Cheung <cheung.zhy.csu@gmail.com>
2023-02-14 08:01:55 -08:00
..
internal Use semconv creation functions (#3683) 2023-02-07 13:42:47 -08:00
migration Fix golint error of package comment form (#1487) 2021-02-04 09:55:44 -08:00
test [bridge/ot] Fall-back to TextMap carrier when it's not ot.HttpHeaders (#3679) 2023-02-14 08:01:55 -08:00
bridge_test.go [bridge/ot] Fall-back to TextMap carrier when it's not ot.HttpHeaders (#3679) 2023-02-14 08:01:55 -08:00
bridge.go [bridge/ot] Fall-back to TextMap carrier when it's not ot.HttpHeaders (#3679) 2023-02-14 08:01:55 -08:00
doc.go Update doc.go (#2030) 2021-06-25 07:56:12 -07:00
go.mod [bridge/ot] Fall-back to TextMap carrier when it's not ot.HttpHeaders (#3679) 2023-02-14 08:01:55 -08:00
go.sum dependabot updates Mon Oct 31 15:24:02 UTC 2022 (#3433) 2022-10-31 08:54:41 -07: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 Create README.md for the ot bridge (#2896) 2022-05-17 05:13:49 -04:00
util.go Use already enabled revive linter and add depguard (#2883) 2022-05-19 15:15:07 -05: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.