Package io.opentelemetry.sdk.trace.export

Class SimpleSpanProcessor

java.lang.Object

io.opentelemetry.sdk.trace.export.SimpleSpanProcessor

All Implemented Interfaces:

SpanProcessor, Closeable, AutoCloseable

public final class SimpleSpanProcessor
extends Object
implements SpanProcessor

An implementation of the SpanProcessor that converts the ReadableSpan to SpanData and passes it directly to the configured exporter. This processor should only be used where the exporter(s) are able to handle multiple exports simultaneously, as there is no back pressure consideration here.

Configuration options for SimpleSpanProcessor can be read from system properties, environment variables, or Properties objects.

For system properties and Properties objects, SimpleSpanProcessor will look for the following names:

• otel.ssp.export.sampled: sets whether only sampled spans should be exported.

For environment variables, SimpleSpanProcessor will look for the following names:

• OTEL_SSP_EXPORT_SAMPLED: sets whether only sampled spans should be exported.

Method Summary

Modifier and Type	Method	Description
static SimpleSpanProcessorBuilder	builder(SpanExporter spanExporter)	Deprecated. Use create(SpanExporter)
static SpanProcessor	create(SpanExporter exporter)	Returns a new SimpleSpanProcessor which exports spans to the SpanExporter synchronously.
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(io.opentelemetry.context.Context parentContext, ReadWriteSpan span)	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

Methods inherited from interface io.opentelemetry.sdk.trace.SpanProcessor

close, forceFlush

Method Detail

create

public static SpanProcessor create(SpanExporter exporter)

Returns a new SimpleSpanProcessor which exports spans to the SpanExporter synchronously.

builder

@Deprecated
public static SimpleSpanProcessorBuilder builder(SpanExporter spanExporter)

Deprecated.

Use create(SpanExporter)

Returns a new Builder for SimpleSpanProcessor.

Parameters:

spanExporter - the SpanExporter to where the Spans are pushed.

Returns:

a new SimpleSpanProcessor.

Throws:

NullPointerException - if the spanExporter is null.

onStart

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

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.

span - 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 span)

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:

span - 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.