Interface SdkTracerManagement
-
- All Superinterfaces:
AutoCloseable,Closeable
- All Known Implementing Classes:
SdkTracerProvider
public interface SdkTracerManagement extends Closeable
"Management" interface for the Tracing SDK. This interface exposes methods for configuring the Tracing SDK, as well as several lifecycle methods.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description voidaddSpanProcessor(SpanProcessor spanProcessor)Deprecated.UseSdkTracerProvider.addSpanProcessor(SpanProcessor)when initializing the SDKdefault voidclose()Attempts to stop all the activity for thisTracer.io.opentelemetry.sdk.common.CompletableResultCodeforceFlush()Requests the active span processor to process all span events that have not yet been processed and returns aCompletableResultCodewhich is completed when the flush is finished.TraceConfiggetActiveTraceConfig()Returns the activeTraceConfig.io.opentelemetry.sdk.common.CompletableResultCodeshutdown()Attempts to stop all the activity for thisTracer.voidupdateActiveTraceConfig(TraceConfig traceConfig)Deprecated.UseSdkTracerProviderBuilder.setTraceConfig(Supplier)to register a supplier ofTraceConfigif you need to make dynamic updates.
-
-
-
Method Detail
-
getActiveTraceConfig
TraceConfig getActiveTraceConfig()
Returns the activeTraceConfig.- Returns:
- the active
TraceConfig.
-
updateActiveTraceConfig
@Deprecated void updateActiveTraceConfig(TraceConfig traceConfig)
Deprecated.UseSdkTracerProviderBuilder.setTraceConfig(Supplier)to register a supplier ofTraceConfigif you need to make dynamic updates.Updates the activeTraceConfig.Note: To update the
TraceConfigassociated with this instance you should use theTraceConfig.toBuilder()method on theTraceConfigreturned fromgetActiveTraceConfig(), make the changes desired to theTraceConfigBuilderinstance, then use this method with the resultingTraceConfiginstance.- Parameters:
traceConfig- the new activeTraceConfig.- See Also:
TraceConfig
-
addSpanProcessor
@Deprecated void addSpanProcessor(SpanProcessor spanProcessor)
Deprecated.UseSdkTracerProvider.addSpanProcessor(SpanProcessor)when initializing the SDKAdds a newSpanProcessorto thisTracer.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 newSpanProcessorto be added.
-
shutdown
io.opentelemetry.sdk.common.CompletableResultCode shutdown()
Attempts to stop all the activity for thisTracer. CallsSpanProcessor.shutdown()for all registeredSpanProcessors.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.
- Returns:
- a
CompletableResultCodewhich is completed when all the span processors have been shut down.
-
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 aCompletableResultCodewhich is completed when the flush is finished.- See Also:
SpanProcessor.forceFlush()
-
close
default void close()
Attempts to stop all the activity for thisTracer. CallsSpanProcessor.shutdown()for all registeredSpanProcessors.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:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable
-
-