Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix autoconfigure javadoc explaining behavior when disabled #6109

Merged
merged 1 commit into from
Jan 3, 2024
Merged

Fix autoconfigure javadoc explaining behavior when disabled #6109

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions ...gure/src/main/java/io/opentelemetry/sdk/autoconfigure/AutoConfiguredOpenTelemetrySdk.java
View file
Open in desktop
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