Tracer Interface

@Deprecated
public static final String AZ_TRACING_NAMESPACE_KEY

Deprecated

Key for Context which indicates that the context contains the Azure resource provider namespace.

@Deprecated
public static final String DIAGNOSTIC_ID_KEY

Deprecated

Key for Context which indicates that the context contains a "Diagnostic Id" for the service call.

public static final String DISABLE_TRACING_KEY

Key for Context which disables tracing for the request associated with the current context.

public static final String ENTITY_PATH_KEY

Key for Context which indicates that the context contains an entity path.

public static final String HOST_NAME_KEY

Key for Context which indicates that the context contains the hostname.

@Deprecated
public static final String MESSAGE_ENQUEUED_TIME

Deprecated

Key for Context which indicates the time of the last enqueued message in the partition's stream.

@Deprecated
public static final String PARENT_SPAN_KEY

Deprecated

Key for Context which indicates that the context contains parent span data. This span will be used as the parent span for all spans the SDK creates.

If no span data is listed when the span is created it will default to using this span key as the parent span.

public static final String PARENT_TRACE_CONTEXT_KEY

Context key to store trace context. This context will be used as a parent context for new spans and propagated in outgoing HTTP calls.

@Deprecated
public static final String SCOPE_KEY

Deprecated

Key for Context the scope of code where the given Span is in the current Context.

@Deprecated
public static final String SPAN_BUILDER_KEY

Deprecated

Key for Context which indicates the shared span builder that is in the current Context.

public static final String SPAN_CONTEXT_KEY

Key for Context which indicates that the context contains a message span context.

@Deprecated
public static final String USER_SPAN_NAME_KEY

Deprecated

Key for Context which indicates that the context contains the name for the user spans that are created.

If no span name is listed when the span is created it will default to using the calling method's name.

@Deprecated
public default void addEvent(String name, Map attributes, OffsetDateTime timestamp)

Deprecated

Adds an event to the current span with the provided timestamp and attributes.

This API does not provide any normalization if provided timestamps are out of range of the current span timeline

Supported attribute values include String, double, boolean, long, String [], double [], long []. Any other Object value type and null values will be silently ignored.

Parameters:

public default void addEvent(String name, Map attributes, OffsetDateTime timestamp, Context context)

Adds an event to the span present in the Context with the provided timestamp and attributes.

This API does not provide any normalization if provided timestamps are out of range of the current span timeline

Supported attribute values include String, double, boolean, long, String [], double [], long []. Any other Object value type and null values will be silently ignored.

Context span = tracer.start("Cosmos.getItem", Context.NONE);
 tracer.addEvent("trying another endpoint", Collections.singletonMap("endpoint", "westus3"), OffsetDateTime.now(), span);

Parameters:

@Deprecated
public default void addLink(Context context)

Deprecated

Provides a way to link multiple tracing spans. Used in batching operations to relate multiple requests under a single batch.

Code samples

Link multiple spans using their span context information

Parameters:

@Deprecated
public default void end(int responseCode, Throwable error, Context context)

Deprecated

Completes the current tracing span.

Code samples

Completes the tracing span present in the context, with the corresponding OpenTelemetry status for the given response status code

Parameters:

public abstract void end(String errorMessage, Throwable throwable, Context context)

Completes span on the context.

Code samples

Completes the tracing span with unset status

Context messageSpan = tracer.start("ServiceBus.message", new StartSpanOptions(SpanKind.PRODUCER), Context.NONE);
 tracer.end(null, null, messageSpan);

Completes the tracing span with provided error message

Context span = tracer.start("ServiceBus.send", new StartSpanOptions(SpanKind.CLIENT), Context.NONE);
 tracer.end("amqp:not-found", null, span);

Completes the tracing span with provided exception

Context sendSpan = tracer.start("ServiceBus.send", new StartSpanOptions(SpanKind.CLIENT), Context.NONE);
 try (AutoCloseable scope = tracer.makeSpanCurrent(sendSpan)) {
     doWork();
 } catch (Throwable ex) {
     throwable = ex;
 } finally {
     tracer.end(null, throwable, sendSpan);
 }

Parameters:

@Deprecated
public default Context extractContext(String diagnosticId, Context context)

Deprecated

Extracts the span's context as Context from upstream.

Code samples

Extracts the corresponding span context information from a valid diagnostic id

Parameters:

Returns:

public default Context extractContext(Function headerGetter)

Extracts the span's context as Context from upstream.

Code samples

Extracts the corresponding span context information from a valid diagnostic id

Context parentContext = tracer.extractContext(name -> {
     Object value = messageProperties.get(name);
     return value instanceof String ? (String) value : null;
 });

 StartSpanOptions remoteParentOptions = new StartSpanOptions(SpanKind.CONSUMER)
     .setRemoteParent(parentContext);

 Context spanWithRemoteParent = tracer.start("EventHubs.process", remoteParentOptions, Context.NONE);

 try (AutoCloseable scope = tracer.makeSpanCurrent(spanWithRemoteParent)) {
     doWork();
 } catch (Throwable ex) {
     throwable = ex;
 } finally {
     tracer.end(null, throwable, spanWithRemoteParent);
 }

Parameters:

Returns:

@Deprecated
public default Context getSharedSpanBuilder(String spanName, Context context)

Deprecated

Returns a span builder with the provided name in Context.

Code samples

Returns a builder with the provided span name.

Parameters:

Returns:

public default void injectContext(BiConsumer headerSetter, Context context)

Injects tracing context.

Context httpSpan = tracer.start("HTTP GET", new StartSpanOptions(SpanKind.CLIENT), methodSpan);
 tracer.injectContext((headerName, headerValue) -> request.setHeader(headerName, headerValue), httpSpan);

 try (AutoCloseable scope = tracer.makeSpanCurrent(httpSpan)) {
     HttpResponse response = getResponse(request);
     httpResponseCode = response.getStatusCode();
 } catch (Throwable ex) {
     throwable = ex;
 } finally {
     tracer.end(httpResponseCode, throwable, httpSpan);
 }

Parameters:

public default boolean isEnabled()

Checks if tracer is enabled.

if (!tracer.isEnabled()) {
     doWork();
 } else {
     Context span = tracer.start("span", Context.NONE);
     try {
         doWork();
     } catch (Throwable ex) {
         throwable = ex;
     } finally {
         tracer.end(null, throwable, span);
     }
 }

Returns:

public default boolean isRecording(Context span)

Checks if span is sampled in.

Parameters:

Returns:

public default AutoCloseable makeSpanCurrent(Context context)

Makes span current. Implementations may put it on ThreadLocal. Make sure to always use try-with-resource statement with makeSpanCurrent

Parameters:

 Context span = tracer.start("EventHubs.process", new StartSpanOptions(SpanKind.CONSUMER), Context.NONE);
 try (AutoCloseable scope = tracer.makeSpanCurrent(span)) {
     doWork();
 } catch (Throwable ex) {
     throwable = ex;
 } finally {
     tracer.end(null, throwable, span);
 }
 

Returns:

public default void setAttribute(String key, Object value, Context context)

Sets an attribute on span. Adding duplicate attributes, update, or removal is discouraged, since underlying implementations behavior can vary.

Parameters:

public abstract void setAttribute(String key, String value, Context context)

Adds metadata to the current span. If no span information is found in the context, then no metadata is added.

span = tracer.start("EventHubs.process", Context.NONE);
 tracer.setAttribute("bar", "baz", span);

Parameters:

public default void setAttribute(String key, long value, Context context)

Sets long attribute.

Context span = tracer.start("EventHubs.process", Context.NONE);
 tracer.setAttribute("foo", 42, span);

Parameters:

@Deprecated
public default Context setSpanName(String spanName, Context context)

Deprecated

Sets the name for spans that are created.

Code samples

Retrieve the span name of the returned span

Parameters:

Returns:

public abstract Context start(String methodName, Context context)

Creates a new tracing span.

The context will be checked for information about a parent span. If a parent span is found, the new span will be added as a child. Otherwise, the parent span will be created and added to the context and any downstream start() calls will use the created span as the parent.

Code samples

Starts a tracing span with provided method name and explicit parent span

// start a new tracing span with given name and parent context implicitly propagated
 // in io.opentelemetry.context.Context.current()

 Throwable throwable = null;
 Context span = tracer.start("keyvault.setsecret", Context.NONE);
 try {
     doWork();
 } catch (Throwable ex) {
     throwable = ex;
 } finally {
     tracer.end(null, throwable, span);
 }

Parameters:

Returns:

@Deprecated
public default Context start(String spanName, Context context, ProcessKind processKind)

Deprecated

Creates a new tracing span for AMQP calls.

The context will be checked for information about a parent span. If a parent span is found, the new span will be added as a child. Otherwise, the parent span will be created and added to the context and any downstream start() calls will use the created span as the parent.

Sets additional request attributes on the created span when processKind is SEND.

Returns the diagnostic Id and span context of the returned span when processKind is MESSAGE.

Creates a new tracing span with remote parent and returns that scope when the given when processKind is PROCESS.

Code samples

Starts a tracing span with provided method name and AMQP operation SEND

Parameters:

Returns:

public default Context start(String methodName, StartSpanOptions options, Context context)

Creates a new tracing span.

The context will be checked for information about a parent span. If a parent span is found, the new span will be added as a child. Otherwise, the parent span will be created and added to the context and any downstream start() calls will use the created span as the parent.

Code samples

Starts a tracing span with provided method name and explicit parent span

// start a new CLIENT tracing span with the given start options and explicit parent context
 StartSpanOptions options = new StartSpanOptions(SpanKind.CLIENT)
     .setAttribute("key", "value");
 Context spanFromOptions = tracer.start("keyvault.setsecret", options, Context.NONE);
 try {
     doWork();
 } catch (Throwable ex) {
     throwable = ex;
 } finally {
     tracer.end(null, throwable, spanFromOptions);
 }

Parameters:

Returns: