io.opentracing.contrib.api

Interface SpanObserver

public interface SpanObserver

This interface represents an observer used to receive notifications related to a Span.

Note: All of these callback functions are called after the associated operation has been performed on the Span, i.e. they are post-change notifications.

Method Summary

Modifier and Type	Method and Description
void	onFinish(SpanData spanData, long finishMicros) Notifies the observer that a span associated with the supplied data has finished.
void	onLog(SpanData spanData, long timestampMicroseconds, Map<String,?> fields) Notifies the observer that a log event has been recorded.
void	onLog(SpanData spanData, long timestampMicroseconds, String event) Notifies the observer that a log event has been recorded.
void	onSetBaggageItem(SpanData spanData, String key, String value) Notifies the observer that the named baggage item has been set/changed.
void	onSetOperationName(SpanData spanData, String operationName) Notifies the observer that the operation name has been changed.
void	onSetTag(SpanData spanData, String key, Object value) Notifies the observer that the tag with the supplied key has been set or updated on a Span.

Method Detail

onSetOperationName

void onSetOperationName(SpanData spanData,
                        String operationName)

Notifies the observer that the operation name has been changed.

Parameters:

spanData - The data for the span

operationName - The new operation name

onSetTag

void onSetTag(SpanData spanData,
              String key,
              Object value)

Notifies the observer that the tag with the supplied key has been set or updated on a Span.

Parameters:

spanData - The data for the span

key - The tag key

value - The tag value

onSetBaggageItem

void onSetBaggageItem(SpanData spanData,
                      String key,
                      String value)

Notifies the observer that the named baggage item has been set/changed.

Parameters:

spanData - The data for the span

key - The baggage key

value - The baggage value

onLog

void onLog(SpanData spanData,
           long timestampMicroseconds,
           Map<String,?> fields)

Notifies the observer that a log event has been recorded.

Parameters:

spanData - The data for the span

timestampMicroseconds - The explicit timestamp for the log record. Must be greater than or equal to the Span's start timestamp.

fields - key:value log fields. Tracer implementations should support String, numeric, and boolean values; some may also support arbitrary Objects.

onLog

void onLog(SpanData spanData,
           long timestampMicroseconds,
           String event)

Notifies the observer that a log event has been recorded.

Parameters:

spanData - The data for the span

timestampMicroseconds - The explicit timestamp for the log record. Must be greater than or equal to the Span's start timestamp.

event - the event value; often a stable identifier for a moment in the Span lifecycle

onFinish

void onFinish(SpanData spanData,
              long finishMicros)

Notifies the observer that a span associated with the supplied data has finished.

Parameters:

spanData - The data for the span

finishMicros - The finish time in microseconds