Package io.opentelemetry.sdk
Class OpenTelemetrySdkBuilder
- java.lang.Object
-
- io.opentelemetry.sdk.OpenTelemetrySdkBuilder
-
public final class OpenTelemetrySdkBuilder extends Object
A builder for configuring anOpenTelemetrySdk
.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OpenTelemetrySdk
build()
Returns a newOpenTelemetrySdk
built with the configuration of thisOpenTelemetrySdkBuilder
.OpenTelemetrySdk
buildAndRegisterGlobal()
Returns a newOpenTelemetrySdk
built with the configuration of thisOpenTelemetrySdkBuilder
and registers it as the globalOpenTelemetry
.OpenTelemetrySdkBuilder
setPropagators(io.opentelemetry.context.propagation.ContextPropagators propagators)
Sets theContextPropagators
to use.OpenTelemetrySdkBuilder
setTracerProvider(io.opentelemetry.sdk.trace.SdkTracerProvider tracerProvider)
Sets theSdkTracerProvider
to use.
-
-
-
Method Detail
-
setTracerProvider
public OpenTelemetrySdkBuilder setTracerProvider(io.opentelemetry.sdk.trace.SdkTracerProvider tracerProvider)
Sets theSdkTracerProvider
to use. This can be used to configure tracing settings by returning the instance created by aSdkTracerProviderBuilder
.If you use this method, it is assumed that you are providing a fully configured TracerSdkProvider, and other settings will be ignored.
Note: the parameter passed in here must be a
SdkTracerProvider
instance.- Parameters:
tracerProvider
- ASdkTracerProvider
to use with this instance.- See Also:
SdkTracerProvider.builder()
-
setPropagators
public OpenTelemetrySdkBuilder setPropagators(io.opentelemetry.context.propagation.ContextPropagators propagators)
Sets theContextPropagators
to use.
-
buildAndRegisterGlobal
public OpenTelemetrySdk buildAndRegisterGlobal()
Returns a newOpenTelemetrySdk
built with the configuration of thisOpenTelemetrySdkBuilder
and registers it as the globalOpenTelemetry
. An exception will be thrown if this method is attempted to be called multiple times in the lifecycle of an application - ensure you have only one SDK for use as the global instance. If you need to configure multiple SDKs for tests, useGlobalOpenTelemetry.resetForTest()
between them.- See Also:
GlobalOpenTelemetry
-
build
public OpenTelemetrySdk build()
Returns a newOpenTelemetrySdk
built with the configuration of thisOpenTelemetrySdkBuilder
. This SDK is not registered as the globalOpenTelemetry
. It is recommended that you register one SDK usingbuildAndRegisterGlobal()
for use by instrumentation that requires access to a global instance ofOpenTelemetry
.- See Also:
GlobalOpenTelemetry
-
-