public final class SimpleSpanProcessor extends Object implements SpanProcessor
SpanProcessor
that converts the ReadableSpan
to SpanData
and passes it to the configured exporter.
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.
Modifier and Type | Class and Description |
---|---|
static class |
SimpleSpanProcessor.Builder
Builder class for
SimpleSpanProcessor . |
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. |
static SimpleSpanProcessor.Builder |
newBuilder(SpanExporter spanExporter)
Returns a new Builder for
SimpleSpanProcessor . |
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. |
public void onStart(ReadableSpan span)
SpanProcessor
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.
onStart
in interface SpanProcessor
span
- the ReadableSpan
that just started.public boolean isStartRequired()
SpanProcessor
true
if this SpanProcessor
requires start events.isStartRequired
in interface SpanProcessor
true
if this SpanProcessor
requires start events.public void onEnd(ReadableSpan span)
SpanProcessor
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.
onEnd
in interface SpanProcessor
span
- the ReadableSpan
that just ended.public boolean isEndRequired()
SpanProcessor
true
if this SpanProcessor
requires end events.isEndRequired
in interface SpanProcessor
true
if this SpanProcessor
requires end events.public void shutdown()
SpanProcessor
TracerSdkProvider.shutdown()
is called.
Implementations must ensure that all span events are processed before returning.
shutdown
in interface SpanProcessor
public void forceFlush()
SpanProcessor
This method is executed synchronously on the calling thread, and should not throw exceptions.
forceFlush
in interface SpanProcessor
public static SimpleSpanProcessor.Builder newBuilder(SpanExporter spanExporter)
SimpleSpanProcessor
.spanExporter
- the SpanExporter
to where the Spans are pushed.SimpleSpanProcessor
.NullPointerException
- if the spanExporter
is null
.