Package io.opentelemetry.sdk.autoconfigure

Class AutoConfiguredOpenTelemetrySdk

java.lang.Object

io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk

@Immutable
public abstract class AutoConfiguredOpenTelemetrySdk
extends Object

An auto-configured OpenTelemetry SDK. As an alternative to programmatically configuring the SDK using OpenTelemetrySdk.builder(), this package can be used to automatically configure the SDK using environment properties specified by OpenTelemetry.

Since:

1.28.0

Method Summary

Modifier and Type	Method	Description
static AutoConfiguredOpenTelemetrySdkBuilder	builder()	Returns a new AutoConfiguredOpenTelemetrySdkBuilder which can be used to customize auto-configuration behavior.
abstract io.opentelemetry.sdk.OpenTelemetrySdk	getOpenTelemetrySdk()	Returns the OpenTelemetrySdk that was auto-configured, or an effectively noop instance if the SDK has been disabled.
static AutoConfiguredOpenTelemetrySdk	initialize()	Returns an AutoConfiguredOpenTelemetrySdk automatically initialized through recognized system properties and environment variables.

Methods inherited from class java.lang.Object

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

Method Details

initialize

public static AutoConfiguredOpenTelemetrySdk initialize()

Returns an AutoConfiguredOpenTelemetrySdk automatically initialized through recognized system properties and environment variables.

This will automatically set the resulting SDK as the GlobalOpenTelemetry instance.

builder

public static AutoConfiguredOpenTelemetrySdkBuilder builder()

Returns a new AutoConfiguredOpenTelemetrySdkBuilder which can be used to customize auto-configuration behavior.

getOpenTelemetrySdk

public abstract io.opentelemetry.sdk.OpenTelemetrySdk getOpenTelemetrySdk()

Returns the OpenTelemetrySdk that was auto-configured, or an effectively noop instance if the SDK has been disabled.

The instance returned if the SDK is disabled is equivalent to OpenTelemetrySdk.builder().build(), which is notably not the same as OpenTelemetry.noop().