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 an OpenTelemetrySdk.

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

Modifier and Type	Method	Description
OpenTelemetrySdk	build()	Returns a new OpenTelemetrySdk built with the configuration of this OpenTelemetrySdkBuilder.
OpenTelemetrySdk	buildAndRegisterGlobal()	Returns a new OpenTelemetrySdk built with the configuration of this OpenTelemetrySdkBuilder and registers it as the global OpenTelemetry.
OpenTelemetrySdkBuilder	setLoggerProvider(SdkLoggerProvider loggerProvider)	Sets the SdkLoggerProvider to use.
OpenTelemetrySdkBuilder	setMeterProvider(SdkMeterProvider meterProvider)	Sets the SdkMeterProvider to use.
OpenTelemetrySdkBuilder	setPropagators(ContextPropagators propagators)	Sets the ContextPropagators to use.
OpenTelemetrySdkBuilder	setTracerProvider(SdkTracerProvider tracerProvider)	Sets the SdkTracerProvider to use.

Methods inherited from class java.lang.Object

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

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 the SdkTracerProvider to use. This can be used to configure tracing settings by returning the instance created by a SdkTracerProviderBuilder.

See Also:

SdkTracerProvider.builder()

setMeterProvider

public OpenTelemetrySdkBuilder setMeterProvider(SdkMeterProvider meterProvider)

Sets the SdkMeterProvider to use. This can be used to configure metric settings by returning the instance created by a SdkMeterProviderBuilder.

See Also:

SdkMeterProvider.builder()

setLoggerProvider

public OpenTelemetrySdkBuilder setLoggerProvider(SdkLoggerProvider loggerProvider)

Sets the SdkLoggerProvider to use. This can be used to configure log settings by returning the instance created by a SdkLoggerProviderBuilder.

Since:

1.19.0

See Also:

SdkLoggerProvider.builder()

setPropagators

public OpenTelemetrySdkBuilder setPropagators(ContextPropagators propagators)

Sets the ContextPropagators to use.

buildAndRegisterGlobal

public OpenTelemetrySdk buildAndRegisterGlobal()

Returns a new OpenTelemetrySdk built with the configuration of this OpenTelemetrySdkBuilder and registers it as the global OpenTelemetry. 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, use GlobalOpenTelemetry.resetForTest() between them.

See Also:

GlobalOpenTelemetry

build

public OpenTelemetrySdk build()

Returns a new OpenTelemetrySdk built with the configuration of this OpenTelemetrySdkBuilder. This SDK is not registered as the global OpenTelemetry. It is recommended that you register one SDK using buildAndRegisterGlobal() for use by instrumentation that requires access to a global instance of OpenTelemetry.

See Also:

GlobalOpenTelemetry