com.azure.core.util.tracing

Class StartSpanOptions

java.lang.Object

com.azure.core.util.tracing.StartSpanOptions

public final class StartSpanOptions
extends Object

Represents span options that are available before span starts and describe it.

Constructor Summary

Constructors

Constructor and Description
StartSpanOptions(SpanKind kind) Describes span with given name and kind

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getAttributes() Gets all attributes on span that should be set before span is started.
SpanKind	getSpanKind() Gets span kind.
StartSpanOptions	setAttribute(String key, Object value) Sets attribute on span before its started.

Methods inherited from class java.lang.Object

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

Constructor Detail

StartSpanOptions

public StartSpanOptions(SpanKind kind)

Describes span with given name and kind

Parameters:

kind - The kind of the span to be created.

Method Detail

setAttribute

public StartSpanOptions setAttribute(String key,
                                     Object value)

Sets attribute on span before its started. Such attributes may affect sampling decision.

Parameters:

key - attribute key.

value - attribute value. Note that underlying tracer implementations limit supported value types:

• String
• int
• double
• boolean
• long
• Arrays of the above

Returns:

this instance for chaining.

getSpanKind

public SpanKind getSpanKind()

Gets span kind.

Returns:

span kind.

getAttributes

public Map<String,Object> getAttributes()

Gets all attributes on span that should be set before span is started.

Returns:

attributes to be set on span and used for sampling.