Package io.opentelemetry.sdk

Class OpenTelemetrySdkBuilder

java.lang.Object

io.opentelemetry.sdk.OpenTelemetrySdkBuilder

public final class OpenTelemetrySdkBuilder
extends Object

A builder for configuring an OpenTelemetrySdk.

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	setPropagators(io.opentelemetry.context.propagation.ContextPropagators propagators)	Sets the ContextPropagators to use.
OpenTelemetrySdkBuilder	setTracerProvider(io.opentelemetry.sdk.trace.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

Method Detail

setTracerProvider

public OpenTelemetrySdkBuilder setTracerProvider(io.opentelemetry.sdk.trace.SdkTracerProvider tracerProvider)

Sets the SdkTracerProvider to use. This can be used to configure tracing settings by returning the instance created by a SdkTracerProviderBuilder.

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 - A SdkTracerProvider to use with this instance.

See Also:

SdkTracerProvider.builder()

setPropagators

public OpenTelemetrySdkBuilder setPropagators(io.opentelemetry.context.propagation.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