Skip to content

Allow reusing registered global OpenTelemetry #46230

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.

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

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,30 @@
* Configuration properties for OpenTelemetry.
*
* @author Moritz Halbritter
* @author Yanming Zhou
* @since 4.0.0
*/
@ConfigurationProperties("management.opentelemetry")
public class OpenTelemetryProperties {

/**
* Whether to reuse registered global OpenTelemetry.
*/
private boolean reuseRegisteredGlobal;

/**
* Resource attributes.
*/
private Map<String, String> resourceAttributes = new HashMap<>();

public boolean isReuseRegisteredGlobal() {
return this.reuseRegisteredGlobal;
}

public void setReuseRegisteredGlobal(boolean reuseRegisteredGlobal) {
this.reuseRegisteredGlobal = reuseRegisteredGlobal;
}

public Map<String, String> getResourceAttributes() {
return this.resourceAttributes;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

package org.springframework.boot.opentelemetry.autoconfigure;

import io.opentelemetry.api.GlobalOpenTelemetry;
import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.context.propagation.ContextPropagators;
import io.opentelemetry.sdk.OpenTelemetrySdk;
Expand All @@ -33,17 +34,25 @@
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionMessage;
import org.springframework.boot.autoconfigure.condition.ConditionOutcome;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBooleanProperty;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.SpringBootCondition;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.type.AnnotatedTypeMetadata;

/**
* {@link EnableAutoConfiguration Auto-configuration} for the OpenTelemetry SDK.
*
* @author Moritz Halbritter
* @author Yanming Zhou
* @since 4.0.0
*/
@AutoConfiguration
Expand All @@ -54,6 +63,14 @@ public class OpenTelemetrySdkAutoConfiguration {
OpenTelemetrySdkAutoConfiguration() {
}

@Bean
@ConditionalOnMissingBean(OpenTelemetry.class)
@ConditionalOnBooleanProperty("management.opentelemetry.reuse-registered-global")
@Conditional(OnRegisteredGlobalOpenTelemetryCondition.class)
OpenTelemetry globalOpenTelemetry() {
return GlobalOpenTelemetry.get();
}

@Bean
@ConditionalOnMissingBean(OpenTelemetry.class)
OpenTelemetrySdk openTelemetrySdk(ObjectProvider<SdkTracerProvider> openTelemetrySdkTracerProvider,
Expand Down Expand Up @@ -106,4 +123,15 @@ SdkLoggerProvider openTelemetrySdkLoggerProvider(Resource openTelemetryResource,

}

static class OnRegisteredGlobalOpenTelemetryCondition extends SpringBootCondition {

@Override
public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) {
boolean globalOpenTelemetryRegistered = GlobalOpenTelemetry.get() != OpenTelemetry.noop();
return new ConditionOutcome(globalOpenTelemetryRegistered, ConditionMessage
.of("GlobalOpenTelemetry is" + (globalOpenTelemetryRegistered ? "" : " not") + " registered"));
}

}

}
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,11 @@
import java.util.Collection;
import java.util.concurrent.atomic.AtomicInteger;

import io.opentelemetry.api.GlobalOpenTelemetry;
import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.trace.Tracer;
import io.opentelemetry.api.trace.TracerProvider;
import io.opentelemetry.context.Context;
import io.opentelemetry.context.propagation.ContextPropagators;
import io.opentelemetry.sdk.OpenTelemetrySdk;
Expand Down Expand Up @@ -49,6 +52,8 @@

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.entry;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock;

/**
Expand All @@ -57,6 +62,7 @@
* @author Moritz Halbritter
* @author Toshiaki Maki
* @author Phillip Webb
* @author Yanming Zhou
*/
class OpenTelemetrySdkAutoConfigurationTests {

Expand Down Expand Up @@ -240,6 +246,21 @@ void whenHasMultipleSdkLoggerProviderBuilderCustomizersCallsCustomizeMethod() {
});
}

@Test
void reuseRegisteredGlobalOpenTelemetry() {
OpenTelemetry openTelemetry = mock(OpenTelemetry.class);
TracerProvider tracerProvider = mock(TracerProvider.class);
Tracer tracer = mock(Tracer.class);
given(tracerProvider.get(eq("org.springframework.boot"))).willReturn(tracer);
given(openTelemetry.getTracerProvider()).willReturn(tracerProvider);
GlobalOpenTelemetry.set(openTelemetry);
this.contextRunner.withPropertyValues("management.opentelemetry.reuse-registered-global=true")
.run((context) -> {
assertThat(context).doesNotHaveBean(OpenTelemetrySdk.class);
assertThat(context.getBean(OpenTelemetry.class).getTracer("org.springframework.boot")).isSameAs(tracer);
});
}

@Configuration(proxyBeanMethods = false)
static class UserConfiguration {

Expand Down