Package io.opentelemetry.sdk.trace

Class SdkTracerProvider

java.lang.Object

io.opentelemetry.sdk.trace.SdkTracerProvider

All Implemented Interfaces:

TracerProvider, Closeable, AutoCloseable

public final class SdkTracerProvider
extends Object
implements TracerProvider, Closeable

SDK implementation for TracerProvider.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final String	DEFAULT_TRACER_NAME
private static final Logger	logger
private final TracerSharedState	sharedState
private final ScopeConfigurator<TracerConfig>	tracerConfigurator
private final ComponentRegistry<SdkTracer>	tracerSdkComponentRegistry

Constructor Summary

Constructors

Constructor	Description
SdkTracerProvider(Clock clock, IdGenerator idsGenerator, Resource resource, Supplier<SpanLimits> spanLimitsSupplier, Sampler sampler, List<SpanProcessor> spanProcessors, ScopeConfigurator<TracerConfig> tracerConfigurator)

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 Tracers created by this provider.
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.
Tracer	get(String instrumentationScopeName)	Gets or creates a named tracer instance.
Tracer	get(String instrumentationScopeName, String instrumentationScopeVersion)	Gets or creates a named and versioned tracer instance.
Sampler	getSampler()	Returns the configured Sampler.
SpanLimits	getSpanLimits()	Returns the SpanLimits that are currently applied to created spans.
private TracerConfig	getTracerConfig(InstrumentationScopeInfo instrumentationScopeInfo)
CompletableResultCode	shutdown()	Attempts to stop all the activity for Tracers created by this provider.
String	toString()
TracerBuilder	tracerBuilder(String instrumentationScopeName)	Creates a TracerBuilder for a named Tracer instance.

Methods inherited from class java.lang.Object

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

Field Details

logger

private static final Logger logger

DEFAULT_TRACER_NAME

static final String DEFAULT_TRACER_NAME

See Also:

• Constant Field Values

sharedState

private final TracerSharedState sharedState

tracerSdkComponentRegistry

private final ComponentRegistry<SdkTracer> tracerSdkComponentRegistry

tracerConfigurator

private final ScopeConfigurator<TracerConfig> tracerConfigurator

Constructor Details

SdkTracerProvider

SdkTracerProvider(Clock clock,
 IdGenerator idsGenerator,
 Resource resource,
 Supplier<SpanLimits> spanLimitsSupplier,
 Sampler sampler,
 List<SpanProcessor> spanProcessors,
 ScopeConfigurator<TracerConfig> tracerConfigurator)

Method Details

builder

public static SdkTracerProviderBuilder builder()

Returns a new SdkTracerProviderBuilder for SdkTracerProvider.

Returns:

a new SdkTracerProviderBuilder for SdkTracerProvider.

getTracerConfig

private TracerConfig getTracerConfig(InstrumentationScopeInfo instrumentationScopeInfo)

get

public Tracer get(String instrumentationScopeName)

Description copied from interface: TracerProvider

Gets or creates a named tracer instance.

Specified by:

get in interface TracerProvider

Parameters:

instrumentationScopeName - A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null.

Returns:

a tracer instance.

get

public Tracer get(String instrumentationScopeName,
 String instrumentationScopeVersion)

Description copied from interface: TracerProvider

Gets or creates a named and versioned tracer instance.

Specified by:

get in interface TracerProvider

Parameters:

instrumentationScopeName - A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null.

instrumentationScopeVersion - The version of the instrumentation scope (e.g., "1.0.0").

Returns:

a tracer instance.

tracerBuilder

public TracerBuilder tracerBuilder(@Nullable
 String instrumentationScopeName)

Description copied from interface: TracerProvider

Creates a TracerBuilder for a named Tracer instance.

Specified by:

tracerBuilder in interface TracerProvider

Parameters:

instrumentationScopeName - A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null.

Returns:

a TracerBuilder instance.

getSpanLimits

public SpanLimits getSpanLimits()

Returns the SpanLimits that are currently applied to created spans.

getSampler

public Sampler getSampler()

Returns the configured Sampler.

shutdown

public CompletableResultCode shutdown()

Attempts to stop all the activity for Tracers created by this provider. 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 this instance will result in undefined behavior. It should be considered a terminal operation for the SDK.

Returns:

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

forceFlush

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

close

public void close()

Attempts to stop all the activity for Tracers created by this provider. 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 this instance will result in undefined behavior. It should be considered a terminal operation for the SDK.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

toString

public String toString()

Overrides:

toString in class Object