mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2024-12-12 10:04:29 +02:00

History

Tyler Yahn 1f5b159161 Use already enabled revive linter and add depguard (#2883 ) * Refactor golangci-lint conf Order settings alphabetically. * Add revive settings to golangci conf * Check blank imports * Check bool-literal-in-expr * Check constant-logical-expr * Check context-as-argument * Check context-key-type * Check deep-exit * Check defer * Check dot-imports * Check duplicated-imports * Check early-return * Check empty-block * Check empty-lines * Check error-naming * Check error-return * Check error-strings * Check errorf * Stop ignoring context first arg in tests * Check exported comments * Check flag-parameter * Check identical branches * Check if-return * Check increment-decrement * Check indent-error-flow * Check deny list of go imports * Check import shadowing * Check package comments * Check range * Check range val in closure * Check range val address * Check redefines builtin id * Check string-format * Check struct tag * Check superfluous else * Check time equal * Check var naming * Check var declaration * Check unconditional recursion * Check unexported return * Check unhandled errors * Check unnecessary stmt * Check unnecessary break * Check waitgroup by value * Exclude deep-exit check in example*_test.go files		2022-05-19 15:15:07 -05:00
..
internal	Use already enabled revive linter and add depguard (#2883 )	2022-05-19 15:15:07 -05:00
migration	Fix golint error of package comment form (#1487 )	2021-02-04 09:55:44 -08:00
bridge.go	Use already enabled revive linter and add depguard (#2883 )	2022-05-19 15:15:07 -05:00
doc.go	Update doc.go (#2030 )	2021-06-25 07:56:12 -07:00
go.mod	Integrate go-build-tools crosslink (#2886 )	2022-05-06 07:40:59 -07:00
go.sum	Bump github.com/google/go-cmp from 0.5.7 to 0.5.8 (#2875 )	2022-05-02 08:19:09 -07:00
mix_test.go	Replace use of old term label with attribute (#2790 )	2022-04-18 07:31:31 -07: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	Use already enabled revive linter and add depguard (#2883 )	2022-05-19 15:15:07 -05:00

README.md

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.