Package io.opentelemetry.sdk.trace

Class MultiSpanProcessor

java.lang.Object

io.opentelemetry.sdk.trace.MultiSpanProcessor

All Implemented Interfaces:

SpanProcessor

public final class MultiSpanProcessor
extends Object
implements SpanProcessor

Implementation of the SpanProcessor that simply forwards all received events to a list of SpanProcessors.

Method Summary

Modifier and Type	Method	Description
static SpanProcessor	create(List<SpanProcessor> spanProcessorList)	Creates a new MultiSpanProcessor.
io.opentelemetry.sdk.common.CompletableResultCode	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 readableSpan)	Called when a Span is ended, if the Span.isRecording() returns true.
void	onStart(io.opentelemetry.context.Context parentContext, ReadWriteSpan readableSpan)	Called when a Span is started, if the Span.isRecording() returns true.
io.opentelemetry.sdk.common.CompletableResultCode	shutdown()	Processes all span events that have not yet been processed and closes used resources.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static SpanProcessor create(List<SpanProcessor> spanProcessorList)

Creates a new MultiSpanProcessor.

Parameters:

spanProcessorList - the List of SpanProcessors.

Returns:

a new MultiSpanProcessor.

Throws:

NullPointerException - if the spanProcessorList is null.

onStart

public void onStart(io.opentelemetry.context.Context parentContext,
                    ReadWriteSpan readableSpan)

Description copied from interface: SpanProcessor

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.

Specified by:

onStart in interface SpanProcessor

Parameters:

parentContext - the parent Context of the span that just started.

readableSpan - the ReadableSpan that just started.

isStartRequired

public boolean isStartRequired()

Description copied from interface: SpanProcessor

Returns true if this SpanProcessor requires start events.

Specified by:

isStartRequired in interface SpanProcessor

Returns:

true if this SpanProcessor requires start events.

onEnd

public void onEnd(ReadableSpan readableSpan)

Description copied from interface: SpanProcessor

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.

Specified by:

onEnd in interface SpanProcessor

Parameters:

readableSpan - the ReadableSpan that just ended.

isEndRequired

public boolean isEndRequired()

Description copied from interface: SpanProcessor

Returns true if this SpanProcessor requires end events.

Specified by:

isEndRequired in interface SpanProcessor

Returns:

true if this SpanProcessor requires end events.

shutdown

public io.opentelemetry.sdk.common.CompletableResultCode shutdown()

Description copied from interface: SpanProcessor

Processes all span events that have not yet been processed and closes used resources.

Specified by:

shutdown in interface SpanProcessor

Returns:

a CompletableResultCode which completes when shutdown is finished.

forceFlush

public io.opentelemetry.sdk.common.CompletableResultCode forceFlush()

Description copied from interface: SpanProcessor

Processes all span events that have not yet been processed.

Specified by:

forceFlush in interface SpanProcessor

Returns:

a CompletableResultCode which completes when currently queued spans are finished processing.