Class SimpleSpanProcessor
- All Implemented Interfaces:
SpanProcessor
,Closeable
,AutoCloseable
SpanProcessor
that converts the ReadableSpan
to SpanData
and passes it directly to the configured exporter.
This processor will cause all spans to be exported directly as they finish, meaning each
export request will have a single span. Most backends will not perform well with a single span
per request so unless you know what you're doing, strongly consider using BatchSpanProcessor
instead, including in special environments such as serverless runtimes.
SimpleSpanProcessor
is generally meant to for logging exporters only.
-
Method Summary
Modifier and TypeMethodDescriptionstatic SpanProcessor
create
(SpanExporter exporter) Returns a newSimpleSpanProcessor
which exports spans to theSpanExporter
synchronously.io.opentelemetry.sdk.common.CompletableResultCode
Processes all span events that have not yet been processed.boolean
Returnstrue
if thisSpanProcessor
requires end events.boolean
Returnstrue
if thisSpanProcessor
requires start events.void
onEnd
(ReadableSpan span) Called when aSpan
is ended, if theSpan.isRecording()
returns true.void
onStart
(io.opentelemetry.context.Context parentContext, ReadWriteSpan span) Called when aSpan
is started, if theSpan.isRecording()
returns true.io.opentelemetry.sdk.common.CompletableResultCode
shutdown()
Processes all span events that have not yet been processed and closes used resources.toString()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface io.opentelemetry.sdk.trace.SpanProcessor
close
-
Method Details
-
create
Returns a newSimpleSpanProcessor
which exports spans to theSpanExporter
synchronously.This processor will cause all spans to be exported directly as they finish, meaning each export request will have a single span. Most backends will not perform well with a single span per request so unless you know what you're doing, strongly consider using
BatchSpanProcessor
instead, including in special environments such as serverless runtimes.SimpleSpanProcessor
is generally meant to for logging exporters only. -
onStart
Description copied from interface:SpanProcessor
Called when aSpan
is started, if theSpan.isRecording()
returns true.This method is called synchronously on the execution thread, should not throw or block the execution thread.
- Specified by:
onStart
in interfaceSpanProcessor
- Parameters:
parentContext
- the parentContext
of the span that just started.span
- theSpan
that just started.
-
isStartRequired
public boolean isStartRequired()Description copied from interface:SpanProcessor
Returnstrue
if thisSpanProcessor
requires start events.- Specified by:
isStartRequired
in interfaceSpanProcessor
- Returns:
true
if thisSpanProcessor
requires start events.
-
onEnd
Description copied from interface:SpanProcessor
Called when aSpan
is ended, if theSpan.isRecording()
returns true.This method is called synchronously on the execution thread, should not throw or block the execution thread.
- Specified by:
onEnd
in interfaceSpanProcessor
- Parameters:
span
- theSpan
that just ended.
-
isEndRequired
public boolean isEndRequired()Description copied from interface:SpanProcessor
Returnstrue
if thisSpanProcessor
requires end events.- Specified by:
isEndRequired
in interfaceSpanProcessor
- Returns:
true
if thisSpanProcessor
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 interfaceSpanProcessor
- 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 interfaceSpanProcessor
- Returns:
- a
CompletableResultCode
which completes when currently queued spans are finished processing.
-
toString
-