Package io.opentelemetry.sdk

Class OpenTelemetrySdk

java.lang.Object

io.opentelemetry.sdk.OpenTelemetrySdk

All Implemented Interfaces:

OpenTelemetry, Closeable, AutoCloseable

@ThreadSafe
public final class OpenTelemetrySdk
extends Object
implements OpenTelemetry, Closeable

The SDK implementation of OpenTelemetry.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	OpenTelemetrySdk.ObfuscatedLoggerProvider	This class allows the SDK to unobfuscate an obfuscated static global provider.
(package private) static class	OpenTelemetrySdk.ObfuscatedMeterProvider	This class allows the SDK to unobfuscate an obfuscated static global provider.
(package private) static class	OpenTelemetrySdk.ObfuscatedTracerProvider	This class allows the SDK to unobfuscate an obfuscated static global provider.

Field Summary

Fields

Modifier and Type	Field	Description
private final AtomicBoolean	isShutdown
private static final Logger	LOGGER
private final OpenTelemetrySdk.ObfuscatedLoggerProvider	loggerProvider
private final OpenTelemetrySdk.ObfuscatedMeterProvider	meterProvider
private final ContextPropagators	propagators
private final OpenTelemetrySdk.ObfuscatedTracerProvider	tracerProvider

Constructor Summary

Constructors

Constructor	Description
OpenTelemetrySdk(SdkTracerProvider tracerProvider, SdkMeterProvider meterProvider, SdkLoggerProvider loggerProvider, ContextPropagators propagators)

Method Summary

Modifier and Type	Method	Description
static OpenTelemetrySdkBuilder	builder()	Returns a new OpenTelemetrySdkBuilder for configuring an instance of the OpenTelemetry SDK.
void	close()
LoggerProvider	getLogsBridge()	Returns the LoggerProvider for bridging logs into OpenTelemetry.
MeterProvider	getMeterProvider()	Returns the MeterProvider for this OpenTelemetry.
ContextPropagators	getPropagators()	Returns the ContextPropagators for this OpenTelemetry.
SdkLoggerProvider	getSdkLoggerProvider()	Returns the SdkLoggerProvider for this OpenTelemetrySdk.
SdkMeterProvider	getSdkMeterProvider()	Returns the SdkMeterProvider for this OpenTelemetrySdk.
SdkTracerProvider	getSdkTracerProvider()	Returns the SdkTracerProvider for this OpenTelemetrySdk.
TracerProvider	getTracerProvider()	Returns the TracerProvider for this OpenTelemetry.
CompletableResultCode	shutdown()	Shutdown the SDK.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.opentelemetry.api.OpenTelemetry

getMeter, getTracer, getTracer, meterBuilder, tracerBuilder

Field Details

LOGGER

private static final Logger LOGGER

isShutdown

private final AtomicBoolean isShutdown

tracerProvider

private final OpenTelemetrySdk.ObfuscatedTracerProvider tracerProvider

meterProvider

private final OpenTelemetrySdk.ObfuscatedMeterProvider meterProvider

loggerProvider

private final OpenTelemetrySdk.ObfuscatedLoggerProvider loggerProvider

propagators

private final ContextPropagators propagators

Constructor Details

OpenTelemetrySdk

OpenTelemetrySdk(SdkTracerProvider tracerProvider,
 SdkMeterProvider meterProvider,
 SdkLoggerProvider loggerProvider,
 ContextPropagators propagators)

Method Details

builder

public static OpenTelemetrySdkBuilder builder()

Returns a new OpenTelemetrySdkBuilder for configuring an instance of the OpenTelemetry SDK.

getTracerProvider

public TracerProvider getTracerProvider()

Description copied from interface: OpenTelemetry

Returns the TracerProvider for this OpenTelemetry.

Specified by:

getTracerProvider in interface OpenTelemetry

getSdkTracerProvider

public SdkTracerProvider getSdkTracerProvider()

Returns the SdkTracerProvider for this OpenTelemetrySdk.

getMeterProvider

public MeterProvider getMeterProvider()

Description copied from interface: OpenTelemetry

Returns the MeterProvider for this OpenTelemetry.

Specified by:

getMeterProvider in interface OpenTelemetry

getSdkMeterProvider

public SdkMeterProvider getSdkMeterProvider()

Returns the SdkMeterProvider for this OpenTelemetrySdk.

getLogsBridge

public LoggerProvider getLogsBridge()

Description copied from interface: OpenTelemetry

Returns the LoggerProvider for bridging logs into OpenTelemetry.

The OpenTelemetry logs bridge API exists to enable bridging logs from other log frameworks (e.g. SLF4J, Log4j, JUL, Logback, etc) into OpenTelemetry and is NOT a replacement log API.

Specified by:

getLogsBridge in interface OpenTelemetry

getSdkLoggerProvider

public SdkLoggerProvider getSdkLoggerProvider()

Returns the SdkLoggerProvider for this OpenTelemetrySdk.

Since:

1.19.0

getPropagators

public ContextPropagators getPropagators()

Description copied from interface: OpenTelemetry

Returns the ContextPropagators for this OpenTelemetry.

Specified by:

getPropagators in interface OpenTelemetry

shutdown

public CompletableResultCode shutdown()

Shutdown the SDK. Calls SdkTracerProvider.shutdown(), SdkMeterProvider.shutdown(), and SdkLoggerProvider.shutdown().

Returns:

a CompletableResultCode which completes when all providers are shutdown

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

toString

public String toString()

Overrides:

toString in class Object