Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define the instrumentation library name for the OT Shim. #2227

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions specification/compatibility/opentracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,9 @@ This operation is used to create a new OpenTracing `Tracer`:

This operation MUST accept the following parameters:

- An OpenTelemetry `Tracer`, used to create `Span`s.
- An OpenTelemetry `TracerProvider`. This operation MUST use this `TracerProvider`
to obtain a `Tracer` with the name `opentracing-shim` along with the current
shim library version.
- OpenTelemetry `Propagator`s to be used to perform injection and extraction
for the the OpenTracing `TextMap` and `HTTPHeaders` formats.
If not specified, no `Propagator` values will be stored in the Shim, and
Expand All @@ -70,12 +72,12 @@ The API MUST return an OpenTracing `Tracer`.

```java
// Create a Tracer Shim relying on the global propagators.
createTracerShim(tracer);
createTracerShim(tracerProvider);

// Create a Tracer Shim using:
// 1) TraceContext propagator for TextMap
// 2) Jaeger propagator for HttPHeaders.
createTracerShim(tracer, OTPropagatorsBuilder()
createTracerShim(tracerProvider, OTPropagatorsBuilder()
.setTextMap(W3CTraceContextPropagator.getInstance())
.setHttpHeaders(JaegerPropagator.getInstance())
.build());
Expand Down