Skip to content

Fix race condition of GlobalOpenTelemetry initialization with AutoConfiguredOpenTelemetrySdkBuilder #7365

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

Merged
jack-berg merged 19 commits into from
Jun 24, 2025
Merged

Fix race condition of GlobalOpenTelemetry initialization with AutoConfiguredOpenTelemetrySdkBuilder #7365

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
1d5245f
hold mutex
fandreuz May 23, 2025
89181a9
test
fandreuz May 23, 2025
06ff8eb
fix condition
fandreuz May 23, 2025
2ff428b
review comments
fandreuz Jun 8, 2025
70aede1
fix test
fandreuz Jun 8, 2025
e0d0405
supplier and then function
fandreuz Jun 8, 2025
5dbbbc1
new api
fandreuz Jun 8, 2025
6920278
Adjust API to be only supplier
jack-berg Jun 9, 2025
a5f3c0c
fix api
fandreuz Jun 9, 2025
4b994e6
Merge branch 'main' into auto-opentelemetry-builder-hold-mutex
fandreuz Jun 9, 2025
4c7028d
fix format and cmpl
fandreuz Jun 9, 2025
138601c
add log statement
fandreuz Jun 9, 2025
71ca31c
new test
fandreuz Jun 12, 2025
e1dd23e
test
fandreuz Jun 17, 2025
f2d9648
comment and sleep
fandreuz Jun 17, 2025
8ebb79a
apply suggestion
fandreuz Jun 20, 2025
4cce67c
spotless
fandreuz Jun 20, 2025
e89f04c
Merge branch 'main' into auto-opentelemetry-builder-hold-mutex
fandreuz Jun 20, 2025
9d00edd
imports
fandreuz Jun 20, 2025
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
17 changes: 17 additions & 0 deletions api/all/src/main/java/io/opentelemetry/api/GlobalOpenTelemetry.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
import io.opentelemetry.context.propagation.ContextPropagators;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.annotation.Nullable;
Expand Down Expand Up @@ -116,6 +118,21 @@ public static void set(OpenTelemetry openTelemetry) {
}
}

/**
* Sets the {@link OpenTelemetry} that should be the global instance.
*
* <p>This method calls the given {@code supplier}, converts the output to an {@link
* OpenTelemetry} object, and finally calls {@link #set(OpenTelemetry)}, all while holding the
* {@link GlobalOpenTelemetry} mutex.
*/
public static <T> T set(Supplier<T> supplier, Function<T, OpenTelemetry> converter) {
Copy link
Member

@jack-berg jack-berg Jun 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about something like: 5f06de2

This API signature will look strange outside of the autoconfigure use case.

I like this approach in general though and would love to get it merged!

Copy link
Contributor Author

@fandreuz fandreuz Jun 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I didn't like that signature either, your commit made it look much better. I chery-picked it into my branch

synchronized (mutex) {
T output = supplier.get();
set(converter.apply(output));
return output;
}
}

/** Returns the globally registered {@link TracerProvider}. */
public static TracerProvider getTracerProvider() {
return get().getTracerProvider();
Expand Down
7 changes: 5 additions & 2 deletions docs/apidiffs/current_vs_latest/opentelemetry-api.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
Comparing source compatibility of opentelemetry-api-1.51.0-SNAPSHOT.jar against opentelemetry-api-1.50.0.jar
No changes.
Comparing source compatibility of opentelemetry-api-1.51.0-SNAPSHOT.jar against opentelemetry-api-1.51.0.jar
*** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.api.GlobalOpenTelemetry (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++ NEW METHOD: PUBLIC(+) STATIC(+) java.lang.Object set(java.util.function.Supplier<T>, java.util.function.Function<T,io.opentelemetry.api.OpenTelemetry>)
GENERIC TEMPLATES: +++ T:java.lang.Object
31 changes: 15 additions & 16 deletions ...c/main/java/io/opentelemetry/sdk/autoconfigure/AutoConfiguredOpenTelemetrySdkBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -424,6 +424,17 @@ AutoConfiguredOpenTelemetrySdkBuilder setComponentLoader(ComponentLoader compone
* the settings of this {@link AutoConfiguredOpenTelemetrySdkBuilder}.
*/
public AutoConfiguredOpenTelemetrySdk build() {
if (!setResultAsGlobal) {
return buildImpl();
}
AutoConfiguredOpenTelemetrySdk sdk =
GlobalOpenTelemetry.set(
this::buildImpl, AutoConfiguredOpenTelemetrySdk::getOpenTelemetrySdk);
logger.log(Level.FINE, "Global OpenTelemetry set to {0} by autoconfiguration", sdk);
return sdk;
}

private AutoConfiguredOpenTelemetrySdk buildImpl() {
SpiHelper spiHelper = SpiHelper.create(componentLoader);
if (!customized) {
customized = true;
Expand All @@ -440,8 +451,10 @@ public AutoConfiguredOpenTelemetrySdk build() {
maybeConfigureFromFile(config, componentLoader);
if (fromFileConfiguration != null) {
maybeRegisterShutdownHook(fromFileConfiguration.getOpenTelemetrySdk());
maybeSetAsGlobal(
fromFileConfiguration.getOpenTelemetrySdk(), fromFileConfiguration.getConfigProvider());
Object configProvider = fromFileConfiguration.getConfigProvider();
if (setResultAsGlobal && INCUBATOR_AVAILABLE && configProvider != null) {
IncubatingUtil.setGlobalConfigProvider(configProvider);
}
return fromFileConfiguration;
}

Expand All @@ -467,7 +480,6 @@ public AutoConfiguredOpenTelemetrySdk build() {

OpenTelemetrySdk openTelemetrySdk = sdkBuilder.build();
maybeRegisterShutdownHook(openTelemetrySdk);
maybeSetAsGlobal(openTelemetrySdk, null);
callAutoConfigureListeners(spiHelper, openTelemetrySdk);

return AutoConfiguredOpenTelemetrySdk.create(openTelemetrySdk, resource, config, null);
Expand Down Expand Up @@ -572,19 +584,6 @@ private void maybeRegisterShutdownHook(OpenTelemetrySdk openTelemetrySdk) {
Runtime.getRuntime().addShutdownHook(shutdownHook(openTelemetrySdk));
}

private void maybeSetAsGlobal(
OpenTelemetrySdk openTelemetrySdk, @Nullable Object configProvider) {
if (!setResultAsGlobal) {
return;
}
GlobalOpenTelemetry.set(openTelemetrySdk);
if (INCUBATOR_AVAILABLE && configProvider != null) {
IncubatingUtil.setGlobalConfigProvider(configProvider);
}
logger.log(
Level.FINE, "Global OpenTelemetry set to {0} by autoconfiguration", openTelemetrySdk);
}

// Visible for testing
void callAutoConfigureListeners(SpiHelper spiHelper, OpenTelemetrySdk openTelemetrySdk) {
for (AutoConfigureListener listener : spiHelper.getListeners()) {
Expand Down