Skip to content

Commit

Permalink
Fix autoconfigure javadoc explaining behavior when disabled (#6109)
Browse files Browse the repository at this point in the history
  • Loading branch information
jack-berg authored Jan 3, 2024
1 parent 517ef88 commit bc0df3b
Showing 1 changed file with 7 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

import com.google.auto.value.AutoValue;
import io.opentelemetry.api.GlobalOpenTelemetry;
import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.sdk.OpenTelemetrySdk;
import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
import io.opentelemetry.sdk.resources.Resource;
Expand Down Expand Up @@ -47,8 +48,12 @@ static AutoConfiguredOpenTelemetrySdk create(
}

/**
* Returns the {@link OpenTelemetrySdk} that was auto-configured, or {@code null} if the SDK has
* been disabled.
* Returns the {@link OpenTelemetrySdk} that was auto-configured, or an effectively noop instance
* if the SDK has been disabled.
*
* <p>The instance returned if the SDK is disabled is equivalent to {@code
* OpenTelemetrySdk.builder().build()}, which is notably not the same as {@link
* OpenTelemetry#noop()}.
*/
public abstract OpenTelemetrySdk getOpenTelemetrySdk();

Expand Down

0 comments on commit bc0df3b

Please sign in to comment.