Package io.opentelemetry.sdk.trace

Class TracerSdkProvider

java.lang.Object

io.opentelemetry.sdk.trace.TracerSdkProvider

All Implemented Interfaces:

io.opentelemetry.api.trace.TracerProvider, TracerSdkManagement

public class TracerSdkProvider
extends Object
implements io.opentelemetry.api.trace.TracerProvider, TracerSdkManagement

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TracerSdkProvider.Builder	Builder class for the TraceSdkProvider.

Method Summary

Modifier and Type	Method	Description
void	addSpanProcessor(SpanProcessor spanProcessor)	Adds a new SpanProcessor to this Tracer.
static TracerSdkProvider.Builder	builder()	Returns a new TracerSdkProvider.Builder for TracerSdkProvider.
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 TracerSdkProvider.Builder builder()

Returns a new TracerSdkProvider.Builder for TracerSdkProvider.

Returns:

a new TracerSdkProvider.Builder for TracerSdkProvider.

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: TracerSdkManagement

Returns the active TraceConfig.

Specified by:

getActiveTraceConfig in interface TracerSdkManagement

Returns:

the active TraceConfig.

updateActiveTraceConfig

public void updateActiveTraceConfig(TraceConfig traceConfig)

Description copied from interface: TracerSdkManagement

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

Specified by:

updateActiveTraceConfig in interface TracerSdkManagement

Parameters:

traceConfig - the new active TraceConfig.

See Also:

TraceConfig

addSpanProcessor

public void addSpanProcessor(SpanProcessor spanProcessor)

Description copied from interface: TracerSdkManagement

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

Specified by:

addSpanProcessor in interface TracerSdkManagement

Parameters:

spanProcessor - the new SpanProcessor to be added.

shutdown

public void shutdown()

Description copied from interface: TracerSdkManagement

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 all the newly created Spans will be no-op.

Specified by:

shutdown in interface TracerSdkManagement

forceFlush

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

Description copied from interface: TracerSdkManagement

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 TracerSdkManagement

See Also:

SpanProcessor.forceFlush()