Package io.opentelemetry.sdk.trace

Class SdkTracerProvider

java.lang.Object

io.opentelemetry.sdk.trace.SdkTracerProvider

All Implemented Interfaces:

io.opentelemetry.api.trace.TracerProvider, SdkTracerManagement, Closeable, AutoCloseable

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

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
static SdkTracerProviderBuilder	builder()	Returns a new SdkTracerProviderBuilder for SdkTracerProvider.
void	close()	Attempts to stop all the activity for 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.
io.opentelemetry.api.trace.Tracer	get(String instrumentationName)
io.opentelemetry.api.trace.Tracer	get(String instrumentationName, String instrumentationVersion)
TraceConfig	getActiveTraceConfig()	Returns the active TraceConfig.
Sampler	getSampler()	Returns the configured Sampler.
io.opentelemetry.sdk.common.CompletableResultCode	shutdown()	Attempts to stop all the activity for this Tracer.

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

Returns the active TraceConfig.

Specified by:

getActiveTraceConfig in interface SdkTracerManagement

Returns:

the active TraceConfig.

getSampler

public Sampler getSampler()

Returns the configured Sampler.

shutdown

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

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

The returned CompletableResultCode will be completed when all the Spans are processed.

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

Returns:

a CompletableResultCode which is completed when all the span processors have been shut down.

forceFlush

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

Specified by:

forceFlush in interface SdkTracerManagement

See Also:

SpanProcessor.forceFlush()

close

public void close()

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:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface SdkTracerManagement