io.opentracing.contrib.api

Interface SpanData

public interface SpanData

This interface provides information about the current Span to the observer methods.

Method Summary

Modifier and Type	Method and Description
Object	getBaggageItem(String key) This method retrieves a baggage item associated with the supplied key.
Boolean	getBooleanTag(String key) This method returns the tag value, associated with the supplied key, if it exists and has a Boolean type.
Object	getCorrelationId() This method returns an id that can be used for correlate actions invoked on a stateful observer.
long	getDuration() The duration of the Span.
long	getFinishTime() The finish time of the Span.
Number	getNumberTag(String key) This method returns the tag value, associated with the supplied key, if it exists and has a Number type.
String	getOperationName() The operation name of the Span.
long	getStartTime() The start time of the Span.
String	getStringTag(String key) This method returns the tag value, associated with the supplied key, if it exists and has a String type.
Map<String,Object>	getTags() This method provides access to the tags associated with the span.

Method Detail

getCorrelationId

Object getCorrelationId()

This method returns an id that can be used for correlate actions invoked on a stateful observer. It should only be used within the scope of an application, to uniquely distinguish one span from another, to enable state to be maintained within observer implementation where appropriate.

Returns:

The correlation id for the span, MUST implement equals/hashCode to enable it to be used as a map key

getStartTime

long getStartTime()

The start time of the Span.

Returns:

The start time (in microseconds)

getFinishTime

long getFinishTime()

The finish time of the Span.

Returns:

The finish time (in microseconds), or 0 if not available

getDuration

long getDuration()

The duration of the Span.

Returns:

The duration (in microseconds), or 0 if the span is not finished

getOperationName

String getOperationName()

The operation name of the Span.

Returns:

The operation name

getTags

Map<String,Object> getTags()

This method provides access to the tags associated with the span. If the tracer implementation supports multiple values for a key, then only the most recent value will be returned.

Returns:

The tags

getStringTag

String getStringTag(String key)

This method returns the tag value, associated with the supplied key, if it exists and has a String type.

Parameters:

key - The tag key

Returns:

The value, if exists and is a String type, otherwise null

getNumberTag

Number getNumberTag(String key)

This method returns the tag value, associated with the supplied key, if it exists and has a Number type.

Parameters:

key - The tag key

Returns:

The value, if exists and is a Number type, otherwise null

getBooleanTag

Boolean getBooleanTag(String key)

This method returns the tag value, associated with the supplied key, if it exists and has a Boolean type.

Parameters:

key - The tag key

Returns:

The value, if exists and is a Boolean type, otherwise null

getBaggageItem

Object getBaggageItem(String key)

This method retrieves a baggage item associated with the supplied key.

Parameters:

key - The key

Returns:

The baggage item, or null if undefined