io.opentelemetry.sdk.trace

Interface SpanProcessor

All Known Implementing Classes:

BatchSpanProcessor, MultiSpanProcessor, SimpleSpanProcessor

public interface SpanProcessor

SpanProcessor is the interface TracerSdk uses to allow synchronous hooks for when a Span is started or when a Span is ended.

Method Summary

Modifier and Type	Method and Description
void	forceFlush() Processes all span events that have not yet been processed.
boolean	isEndRequired() Returns true if this SpanProcessor requires end events.
boolean	isStartRequired() Returns true if this SpanProcessor requires start events.
void	onEnd(ReadableSpan span) Called when a Span is ended, if the Span.isRecording() returns true.
void	onStart(ReadableSpan span) Called when a Span is started, if the Span.isRecording() returns true.
void	shutdown() Called when TracerSdkProvider.shutdown() is called.

Method Detail

onStart

void onStart(ReadableSpan span)

Called when a Span is started, if the Span.isRecording() returns true.

This method is called synchronously on the execution thread, should not throw or block the execution thread.

Parameters:

span - the ReadableSpan that just started.

isStartRequired

boolean isStartRequired()

Returns true if this SpanProcessor requires start events.

Returns:

true if this SpanProcessor requires start events.

onEnd

void onEnd(ReadableSpan span)

Called when a Span is ended, if the Span.isRecording() returns true.

This method is called synchronously on the execution thread, should not throw or block the execution thread.

Parameters:

span - the ReadableSpan that just ended.

isEndRequired

boolean isEndRequired()

Returns true if this SpanProcessor requires end events.

Returns:

true if this SpanProcessor requires end events.

shutdown

void shutdown()

Called when TracerSdkProvider.shutdown() is called.

Implementations must ensure that all span events are processed before returning.

forceFlush

void forceFlush()

Processes all span events that have not yet been processed.

This method is executed synchronously on the calling thread, and should not throw exceptions.