Interface ExtendedSpanBuilder
-
- All Superinterfaces:
SpanBuilder
- All Known Implementing Classes:
ExtendedDefaultTracer.NoopSpanBuilder
,SdkSpanBuilder
public interface ExtendedSpanBuilder extends SpanBuilder
ExtendedSpanBuilder
with experimental APIs.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description ExtendedSpanBuilder
addLink(SpanContext spanContext)
Adds a link to the newly createdSpan
.ExtendedSpanBuilder
addLink(SpanContext spanContext, Attributes attributes)
Adds a link to the newly createdSpan
.default ExtendedSpanBuilder
setAllAttributes(Attributes attributes)
Sets attributes to theSpanBuilder
.<T> ExtendedSpanBuilder
setAttribute(AttributeKey<T> key, T value)
Sets an attribute to the newly createdSpan
.ExtendedSpanBuilder
setAttribute(java.lang.String key, boolean value)
Sets an attribute to the newly createdSpan
.ExtendedSpanBuilder
setAttribute(java.lang.String key, double value)
Sets an attribute to the newly createdSpan
.ExtendedSpanBuilder
setAttribute(java.lang.String key, long value)
Sets an attribute to the newly createdSpan
.ExtendedSpanBuilder
setAttribute(java.lang.String key, java.lang.String value)
Sets an attribute to the newly createdSpan
.ExtendedSpanBuilder
setNoParent()
Sets the option to become a rootSpan
for a new trace.ExtendedSpanBuilder
setParent(Context context)
Sets the parent to use from the specifiedContext
.ExtendedSpanBuilder
setParentFrom(ContextPropagators propagators, java.util.Map<java.lang.String,java.lang.String> carrier)
Extract a span context from the given carrier and set it as parent of the span forstartAndCall(SpanCallable)
andstartAndRun(SpanRunnable)
.ExtendedSpanBuilder
setSpanKind(SpanKind spanKind)
Sets theSpanKind
for the newly createdSpan
.ExtendedSpanBuilder
setStartTimestamp(long startTimestamp, java.util.concurrent.TimeUnit unit)
Sets an explicit start timestamp for the newly createdSpan
.default ExtendedSpanBuilder
setStartTimestamp(java.time.Instant startTimestamp)
Sets an explicit start timestamp for the newly createdSpan
.<T,E extends java.lang.Throwable>
TstartAndCall(SpanCallable<T,E> spanCallable)
Runs the givenSpanCallable
inside of the span created by the givenSpanBuilder
.<T,E extends java.lang.Throwable>
TstartAndCall(SpanCallable<T,E> spanCallable, java.util.function.BiConsumer<Span,java.lang.Throwable> handleException)
Runs the givenSpanCallable
inside of the span created by the givenSpanBuilder
.<E extends java.lang.Throwable>
voidstartAndRun(SpanRunnable<E> runnable)
Runs the givenSpanRunnable
inside of the span created by the givenSpanBuilder
.<E extends java.lang.Throwable>
voidstartAndRun(SpanRunnable<E> runnable, java.util.function.BiConsumer<Span,java.lang.Throwable> handleException)
Runs the givenSpanRunnable
inside of the span created by the givenSpanBuilder
.-
Methods inherited from interface io.opentelemetry.api.trace.SpanBuilder
startSpan
-
-
-
-
Method Detail
-
setParentFrom
ExtendedSpanBuilder setParentFrom(ContextPropagators propagators, java.util.Map<java.lang.String,java.lang.String> carrier)
Extract a span context from the given carrier and set it as parent of the span forstartAndCall(SpanCallable)
andstartAndRun(SpanRunnable)
.The span context will be extracted from the
carrier
, which you usually get from HTTP headers of the metadata of a message you're processing.- Parameters:
propagators
- provide the propagators fromOpenTelemetry.getPropagators()
carrier
- the string map where to extract the span context from
-
startAndCall
<T,E extends java.lang.Throwable> T startAndCall(SpanCallable<T,E> spanCallable) throws E extends java.lang.Throwable
Runs the givenSpanCallable
inside of the span created by the givenSpanBuilder
. The span will be ended at the end of theSpanCallable
.If an exception is thrown by the
SpanCallable
, the span will be marked as error, and the exception will be recorded.- Type Parameters:
T
- the type of the resultE
- the type of the exception- Parameters:
spanCallable
- theSpanCallable
to call- Returns:
- the result of the
SpanCallable
- Throws:
E extends java.lang.Throwable
-
startAndCall
<T,E extends java.lang.Throwable> T startAndCall(SpanCallable<T,E> spanCallable, java.util.function.BiConsumer<Span,java.lang.Throwable> handleException) throws E extends java.lang.Throwable
Runs the givenSpanCallable
inside of the span created by the givenSpanBuilder
. The span will be ended at the end of theSpanCallable
.If an exception is thrown by the
SpanCallable
, thehandleException
consumer will be called, giving you the opportunity to handle the exception and span in a custom way, e.g. not marking the span as error.- Type Parameters:
T
- the type of the resultE
- the type of the exception- Parameters:
spanCallable
- theSpanCallable
to callhandleException
- the consumer to call when an exception is thrown- Returns:
- the result of the
SpanCallable
- Throws:
E extends java.lang.Throwable
-
startAndRun
<E extends java.lang.Throwable> void startAndRun(SpanRunnable<E> runnable) throws E extends java.lang.Throwable
Runs the givenSpanRunnable
inside of the span created by the givenSpanBuilder
. The span will be ended at the end of theSpanRunnable
.If an exception is thrown by the
SpanRunnable
, the span will be marked as error, and the exception will be recorded.- Type Parameters:
E
- the type of the exception- Parameters:
runnable
- theSpanRunnable
to run- Throws:
E extends java.lang.Throwable
-
startAndRun
<E extends java.lang.Throwable> void startAndRun(SpanRunnable<E> runnable, java.util.function.BiConsumer<Span,java.lang.Throwable> handleException) throws E extends java.lang.Throwable
Runs the givenSpanRunnable
inside of the span created by the givenSpanBuilder
. The span will be ended at the end of theSpanRunnable
.If an exception is thrown by the
SpanRunnable
, thehandleException
consumer will be called, giving you the opportunity to handle the exception and span in a custom way, e.g. not marking the span as error.- Type Parameters:
E
- the type of the exception- Parameters:
runnable
- theSpanRunnable
to run- Throws:
E extends java.lang.Throwable
-
setParent
ExtendedSpanBuilder setParent(Context context)
Sets the parent to use from the specifiedContext
. If not set, the value ofSpan.current()
atSpanBuilder.startSpan()
time will be used as parent.If no
Span
is available in the specifiedContext
, the resultingSpan
will become a root instance, as ifSpanBuilder.setNoParent()
had been called.If called multiple times, only the last specified value will be used. Observe that the state defined by a previous call to
SpanBuilder.setNoParent()
will be discarded.- Specified by:
setParent
in interfaceSpanBuilder
- Parameters:
context
- theContext
.- Returns:
- this.
-
setNoParent
ExtendedSpanBuilder setNoParent()
Sets the option to become a rootSpan
for a new trace. If not set, the value ofSpan.current()
atSpanBuilder.startSpan()
time will be used as parent.Observe that any previously set parent will be discarded.
- Specified by:
setNoParent
in interfaceSpanBuilder
- Returns:
- this.
-
addLink
ExtendedSpanBuilder addLink(SpanContext spanContext)
Adds a link to the newly createdSpan
.Links are used to link
Span
s in different traces. Used (for example) in batching operations, where a single batch handler processes multiple requests from different traces or the same trace.Implementations may ignore calls with an invalid span context.
- Specified by:
addLink
in interfaceSpanBuilder
- Parameters:
spanContext
- the context of the linkedSpan
.- Returns:
- this.
-
addLink
ExtendedSpanBuilder addLink(SpanContext spanContext, Attributes attributes)
Adds a link to the newly createdSpan
.Links are used to link
Span
s in different traces. Used (for example) in batching operations, where a single batch handler processes multiple requests from different traces or the same trace.Implementations may ignore calls with an invalid span context.
- Specified by:
addLink
in interfaceSpanBuilder
- Parameters:
spanContext
- the context of the linkedSpan
.attributes
- the attributes of theLink
.- Returns:
- this.
-
setAttribute
ExtendedSpanBuilder setAttribute(java.lang.String key, java.lang.String value)
Sets an attribute to the newly createdSpan
. IfSpanBuilder
previously contained a mapping for the key, the old value is replaced by the specified value.If a null or empty String
value
is passed in, the behavior is undefined, and hence strongly discouraged.Note: It is strongly recommended to use
SpanBuilder.setAttribute(AttributeKey, Object)
, and pre-allocate your keys, if possible.- Specified by:
setAttribute
in interfaceSpanBuilder
- Parameters:
key
- the key for this attribute.value
- the value for this attribute.- Returns:
- this.
-
setAttribute
ExtendedSpanBuilder setAttribute(java.lang.String key, long value)
Sets an attribute to the newly createdSpan
. IfSpanBuilder
previously contained a mapping for the key, the old value is replaced by the specified value.Note: It is strongly recommended to use
SpanBuilder.setAttribute(AttributeKey, Object)
, and pre-allocate your keys, if possible.- Specified by:
setAttribute
in interfaceSpanBuilder
- Parameters:
key
- the key for this attribute.value
- the value for this attribute.- Returns:
- this.
-
setAttribute
ExtendedSpanBuilder setAttribute(java.lang.String key, double value)
Sets an attribute to the newly createdSpan
. IfSpanBuilder
previously contained a mapping for the key, the old value is replaced by the specified value.Note: It is strongly recommended to use
SpanBuilder.setAttribute(AttributeKey, Object)
, and pre-allocate your keys, if possible.- Specified by:
setAttribute
in interfaceSpanBuilder
- Parameters:
key
- the key for this attribute.value
- the value for this attribute.- Returns:
- this.
-
setAttribute
ExtendedSpanBuilder setAttribute(java.lang.String key, boolean value)
Sets an attribute to the newly createdSpan
. IfSpanBuilder
previously contained a mapping for the key, the old value is replaced by the specified value.Note: It is strongly recommended to use
SpanBuilder.setAttribute(AttributeKey, Object)
, and pre-allocate your keys, if possible.- Specified by:
setAttribute
in interfaceSpanBuilder
- Parameters:
key
- the key for this attribute.value
- the value for this attribute.- Returns:
- this.
-
setAttribute
<T> ExtendedSpanBuilder setAttribute(AttributeKey<T> key, T value)
Sets an attribute to the newly createdSpan
. IfSpanBuilder
previously contained a mapping for the key, the old value is replaced by the specified value.Note: the behavior of null values is undefined, and hence strongly discouraged.
- Specified by:
setAttribute
in interfaceSpanBuilder
- Parameters:
key
- the key for this attribute.value
- the value for this attribute.- Returns:
- this.
-
setAllAttributes
default ExtendedSpanBuilder setAllAttributes(Attributes attributes)
Sets attributes to theSpanBuilder
. If theSpanBuilder
previously contained a mapping for any of the keys, the old values are replaced by the specified values.- Specified by:
setAllAttributes
in interfaceSpanBuilder
- Parameters:
attributes
- the attributes- Returns:
- this.
-
setSpanKind
ExtendedSpanBuilder setSpanKind(SpanKind spanKind)
Sets theSpanKind
for the newly createdSpan
. If not called, the implementation will provide a default valueSpanKind.INTERNAL
.- Specified by:
setSpanKind
in interfaceSpanBuilder
- Parameters:
spanKind
- the kind of the newly createdSpan
.- Returns:
- this.
-
setStartTimestamp
ExtendedSpanBuilder setStartTimestamp(long startTimestamp, java.util.concurrent.TimeUnit unit)
Sets an explicit start timestamp for the newly createdSpan
.LIRInstruction.Use this method to specify an explicit start timestamp. If not called, the implementation will use the timestamp value at
SpanBuilder.startSpan()
time, which should be the default case.Important this is NOT equivalent with System.nanoTime().
- Specified by:
setStartTimestamp
in interfaceSpanBuilder
- Parameters:
startTimestamp
- the explicit start timestamp from the epoch of the newly createdSpan
.unit
- the unit of the timestamp.- Returns:
- this.
-
setStartTimestamp
default ExtendedSpanBuilder setStartTimestamp(java.time.Instant startTimestamp)
Sets an explicit start timestamp for the newly createdSpan
.Use this method to specify an explicit start timestamp. If not called, the implementation will use the timestamp value at
SpanBuilder.startSpan()
time, which should be the default case.Important this is NOT equivalent with System.nanoTime().
- Specified by:
setStartTimestamp
in interfaceSpanBuilder
- Parameters:
startTimestamp
- the explicit start timestamp from the epoch of the newly createdSpan
.- Returns:
- this.
-
-