Package io.opentelemetry.sdk.trace

Interface SdkTracerManagement

All Known Implementing Classes:

SdkTracerProvider

public interface SdkTracerManagement

"Management" interface for the Tracing SDK. This interface exposes methods for configuring the Tracing SDK, as well as several lifecycle methods.

Method Summary

Modifier and Type	Method	Description
void	addSpanProcessor(SpanProcessor spanProcessor)	Adds a new SpanProcessor to this Tracer.
io.opentelemetry.sdk.common.CompletableResultCode	forceFlush()	Requests the active span processor to process all span events that have not yet been processed and returns a CompletableResultCode which is completed when the flush is finished.
TraceConfig	getActiveTraceConfig()	Returns the active TraceConfig.
void	shutdown()	Attempts to stop all the activity for this Tracer.
void	updateActiveTraceConfig(TraceConfig traceConfig)	Updates the active TraceConfig.

Method Detail

getActiveTraceConfig

TraceConfig getActiveTraceConfig()

Returns the active TraceConfig.

Returns:

the active TraceConfig.

updateActiveTraceConfig

void updateActiveTraceConfig(TraceConfig traceConfig)

Updates the active TraceConfig.

Note: To update the TraceConfig associated with this instance you should use the TraceConfig.toBuilder() method on the TraceConfig returned from getActiveTraceConfig(), make the changes desired to the TraceConfigBuilder instance, then use this method with the resulting TraceConfig instance.

Parameters:

traceConfig - the new active TraceConfig.

See Also:

TraceConfig

addSpanProcessor

void addSpanProcessor(SpanProcessor spanProcessor)

Adds a new SpanProcessor to this Tracer.

Any registered processor cause overhead, consider to use an async/batch processor especially for span exporting, and export to multiple backends using the SpanExporter.composite(SpanExporter...).

Parameters:

spanProcessor - the new SpanProcessor to be added.

shutdown

void shutdown()

Attempts to stop all the activity for this Tracer. Calls SpanProcessor.shutdown() for all registered SpanProcessors.

This operation may block until all the Spans are processed. Must be called before turning off the main application to ensure all data are processed and exported.

After this is called, newly created Spans will be no-ops.

After this is called, further attempts at re-using or reconfiguring this instance will result in undefined behavior. It should be considered a terminal operation for the SDK implementation.

forceFlush

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

Requests the active span processor to process all span events that have not yet been processed and returns a CompletableResultCode which is completed when the flush is finished.

See Also:

SpanProcessor.forceFlush()