Package io.opentelemetry.sdk.trace

Class SdkTracerProvider

java.lang.Object

io.opentelemetry.sdk.trace.SdkTracerProvider

All Implemented Interfaces:

io.opentelemetry.api.trace.TracerProvider, SdkTracerManagement

public final class SdkTracerProvider
extends Object
implements io.opentelemetry.api.trace.TracerProvider, SdkTracerManagement

Tracer provider implementation for TracerProvider.

This class is not intended to be used in application code and it is used only by OpenTelemetry. However, if you need a custom implementation of the factory, you can create one as needed.

Method Summary

Modifier and Type	Method	Description
void	addSpanProcessor(SpanProcessor spanProcessor)	Adds a new SpanProcessor to this Tracer.
static SdkTracerProviderBuilder	builder()	Returns a new SdkTracerProviderBuilder for SdkTracerProvider.
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.
io.opentelemetry.api.trace.Tracer	get(String instrumentationName)
io.opentelemetry.api.trace.Tracer	get(String instrumentationName, String instrumentationVersion)
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.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SdkTracerProviderBuilder builder()

Returns a new SdkTracerProviderBuilder for SdkTracerProvider.

Returns:

a new SdkTracerProviderBuilder for SdkTracerProvider.

get

public io.opentelemetry.api.trace.Tracer get(String instrumentationName)

Specified by:

get in interface io.opentelemetry.api.trace.TracerProvider

get

public io.opentelemetry.api.trace.Tracer get(String instrumentationName,
                                             @Nullable
                                             String instrumentationVersion)

Specified by:

get in interface io.opentelemetry.api.trace.TracerProvider

getActiveTraceConfig

public TraceConfig getActiveTraceConfig()

Description copied from interface: SdkTracerManagement

Returns the active TraceConfig.

Specified by:

getActiveTraceConfig in interface SdkTracerManagement

Returns:

the active TraceConfig.

updateActiveTraceConfig

public void updateActiveTraceConfig(TraceConfig traceConfig)

Description copied from interface: SdkTracerManagement

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 SdkTracerManagement.getActiveTraceConfig(), make the changes desired to the TraceConfigBuilder instance, then use this method with the resulting TraceConfig instance.

Specified by:

updateActiveTraceConfig in interface SdkTracerManagement

Parameters:

traceConfig - the new active TraceConfig.

See Also:

TraceConfig

addSpanProcessor

public void addSpanProcessor(SpanProcessor spanProcessor)

Description copied from interface: SdkTracerManagement

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

Specified by:

addSpanProcessor in interface SdkTracerManagement

Parameters:

spanProcessor - the new SpanProcessor to be added.

shutdown

public void shutdown()

Description copied from interface: SdkTracerManagement

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.

Specified by:

shutdown in interface SdkTracerManagement

forceFlush

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

Description copied from interface: SdkTracerManagement

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.

Specified by:

forceFlush in interface SdkTracerManagement

See Also:

SpanProcessor.forceFlush()