Package io.opentelemetry.sdk
Class OpenTelemetrySdkBuilder
- java.lang.Object
-
- io.opentelemetry.sdk.OpenTelemetrySdkBuilder
-
public final class OpenTelemetrySdkBuilder extends java.lang.Object
A builder for configuring anOpenTelemetrySdk
.
-
-
Field Summary
Fields Modifier and Type Field Description private SdkLoggerProvider
loggerProvider
private SdkMeterProvider
meterProvider
private ContextPropagators
propagators
private SdkTracerProvider
tracerProvider
-
Constructor Summary
Constructors Constructor Description OpenTelemetrySdkBuilder()
Package protected to disallow direct initialization.
-
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
setLoggerProvider(SdkLoggerProvider loggerProvider)
Sets theSdkLoggerProvider
to use.OpenTelemetrySdkBuilder
setMeterProvider(SdkMeterProvider meterProvider)
Sets theSdkMeterProvider
to use.OpenTelemetrySdkBuilder
setPropagators(ContextPropagators propagators)
Sets theContextPropagators
to use.OpenTelemetrySdkBuilder
setTracerProvider(SdkTracerProvider tracerProvider)
Sets theSdkTracerProvider
to use.
-
-
-
Field Detail
-
propagators
private ContextPropagators propagators
-
tracerProvider
@Nullable private SdkTracerProvider tracerProvider
-
meterProvider
@Nullable private SdkMeterProvider meterProvider
-
loggerProvider
@Nullable private SdkLoggerProvider loggerProvider
-
-
Constructor Detail
-
OpenTelemetrySdkBuilder
OpenTelemetrySdkBuilder()
Package protected to disallow direct initialization.- See Also:
OpenTelemetrySdk.builder()
-
-
Method Detail
-
setTracerProvider
public OpenTelemetrySdkBuilder setTracerProvider(SdkTracerProvider tracerProvider)
Sets theSdkTracerProvider
to use. This can be used to configure tracing settings by returning the instance created by aSdkTracerProviderBuilder
.- See Also:
SdkTracerProvider.builder()
-
setMeterProvider
public OpenTelemetrySdkBuilder setMeterProvider(SdkMeterProvider meterProvider)
Sets theSdkMeterProvider
to use. This can be used to configure metric settings by returning the instance created by aSdkMeterProviderBuilder
.- See Also:
SdkMeterProvider.builder()
-
setLoggerProvider
public OpenTelemetrySdkBuilder setLoggerProvider(SdkLoggerProvider loggerProvider)
Sets theSdkLoggerProvider
to use. This can be used to configure log settings by returning the instance created by aSdkLoggerProviderBuilder
.- Since:
- 1.19.0
- See Also:
SdkLoggerProvider.builder()
-
setPropagators
public OpenTelemetrySdkBuilder setPropagators(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
-
-