Package io.opentelemetry.instrumentation.api.tracer

Class BaseTracer

java.lang.Object

io.opentelemetry.instrumentation.api.tracer.BaseTracer

Direct Known Subclasses:

DatabaseClientTracer, HttpClientTracer, HttpServerTracer, RpcClientTracer, RpcServerTracer

public abstract class BaseTracer
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static io.opentelemetry.context.ContextKey<io.opentelemetry.api.trace.Span>	CONTEXT_CLIENT_SPAN_KEY
static io.opentelemetry.context.ContextKey<io.opentelemetry.api.trace.Span>	CONTEXT_SERVER_SPAN_KEY

Constructor Summary

Constructors

Constructor	Description
BaseTracer()
BaseTracer(io.opentelemetry.api.trace.Tracer tracer)

Method Summary

Modifier and Type	Method	Description
void	addThrowable(io.opentelemetry.api.trace.Span span, Throwable throwable)
void	end(io.opentelemetry.api.trace.Span span)
void	end(io.opentelemetry.api.trace.Span span, long endTimeNanos)
void	endExceptionally(io.opentelemetry.api.trace.Span span, Throwable throwable)
void	endExceptionally(io.opentelemetry.api.trace.Span span, Throwable throwable, long endTimeNanos)
static <C> io.opentelemetry.context.Context	extract(C carrier, io.opentelemetry.context.propagation.TextMapPropagator.Getter<C> getter)
static io.opentelemetry.api.trace.Span	getCurrentServerSpan()	Returns span of type SERVER from the current context or null if not found.
static io.opentelemetry.api.trace.Span	getCurrentServerSpan(io.opentelemetry.context.Context context)	Returns span of type SERVER from the given context or null if not found.
io.opentelemetry.api.trace.Span	getCurrentSpan()
String	spanNameForClass(Class<?> clazz)	This method is used to generate an acceptable span (operation) name based on a given class reference.
String	spanNameForMethod(Method method)	This method is used to generate an acceptable span (operation) name based on a given method reference.
io.opentelemetry.context.Scope	startScope(io.opentelemetry.api.trace.Span span)
io.opentelemetry.api.trace.Span	startSpan(Class<?> clazz)
io.opentelemetry.api.trace.Span	startSpan(Method method)
io.opentelemetry.api.trace.Span	startSpan(String spanName, io.opentelemetry.api.trace.Span.Kind kind)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONTEXT_SERVER_SPAN_KEY

public static final io.opentelemetry.context.ContextKey<io.opentelemetry.api.trace.Span> CONTEXT_SERVER_SPAN_KEY

CONTEXT_CLIENT_SPAN_KEY

public static final io.opentelemetry.context.ContextKey<io.opentelemetry.api.trace.Span> CONTEXT_CLIENT_SPAN_KEY

Constructor Detail

BaseTracer

public BaseTracer()

BaseTracer

public BaseTracer(io.opentelemetry.api.trace.Tracer tracer)

Method Detail

startSpan

public io.opentelemetry.api.trace.Span startSpan(Class<?> clazz)

startSpan

public io.opentelemetry.api.trace.Span startSpan(Method method)

startSpan

public io.opentelemetry.api.trace.Span startSpan(String spanName,
                                                 io.opentelemetry.api.trace.Span.Kind kind)

startScope

public io.opentelemetry.context.Scope startScope(io.opentelemetry.api.trace.Span span)

getCurrentSpan

public io.opentelemetry.api.trace.Span getCurrentSpan()

spanNameForMethod

public String spanNameForMethod(Method method)

This method is used to generate an acceptable span (operation) name based on a given method reference. Anonymous classes are named based on their parent.

spanNameForClass

public String spanNameForClass(Class<?> clazz)

This method is used to generate an acceptable span (operation) name based on a given class reference. Anonymous classes are named based on their parent.

end

public void end(io.opentelemetry.api.trace.Span span)

end

public void end(io.opentelemetry.api.trace.Span span,
                long endTimeNanos)

endExceptionally

public void endExceptionally(io.opentelemetry.api.trace.Span span,
                             Throwable throwable)

endExceptionally

public void endExceptionally(io.opentelemetry.api.trace.Span span,
                             Throwable throwable,
                             long endTimeNanos)

addThrowable

public void addThrowable(io.opentelemetry.api.trace.Span span,
                         Throwable throwable)

extract

public static <C> io.opentelemetry.context.Context extract(C carrier,
                                                           io.opentelemetry.context.propagation.TextMapPropagator.Getter<C> getter)

getCurrentServerSpan

public static io.opentelemetry.api.trace.Span getCurrentServerSpan()

Returns span of type SERVER from the current context or null if not found.

getCurrentServerSpan

public static io.opentelemetry.api.trace.Span getCurrentServerSpan(io.opentelemetry.context.Context context)

Returns span of type SERVER from the given context or null if not found.