From fa4832709b2fdcbb6c29de13dfa33aa5bc3caf42 Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Mon, 16 Nov 2020 16:22:26 +0100 Subject: [PATCH] Fixed conditions for sampling --- .../zipkin2/ZipkinBraveAutoConfiguration.java | 3 +- .../zipkin2/ZipkinOtelAutoConfiguration.java | 3 +- .../sleuth/zipkin2/ZipkinSamplerTests.java | 70 +++++++++++++++++++ 3 files changed, 74 insertions(+), 2 deletions(-) create mode 100644 spring-cloud-sleuth-zipkin/src/test/java/org/springframework/cloud/sleuth/zipkin2/ZipkinSamplerTests.java diff --git a/spring-cloud-sleuth-zipkin/src/main/java/org/springframework/cloud/sleuth/zipkin2/ZipkinBraveAutoConfiguration.java b/spring-cloud-sleuth-zipkin/src/main/java/org/springframework/cloud/sleuth/zipkin2/ZipkinBraveAutoConfiguration.java index 252fba6a3..450d1fe48 100644 --- a/spring-cloud-sleuth-zipkin/src/main/java/org/springframework/cloud/sleuth/zipkin2/ZipkinBraveAutoConfiguration.java +++ b/spring-cloud-sleuth-zipkin/src/main/java/org/springframework/cloud/sleuth/zipkin2/ZipkinBraveAutoConfiguration.java @@ -37,6 +37,7 @@ import org.springframework.boot.autoconfigure.AutoConfigureBefore; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; import org.springframework.cloud.sleuth.autoconfig.TraceAutoConfiguration; +import org.springframework.cloud.sleuth.brave.autoconfig.TraceBraveAutoConfiguration; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.lang.Nullable; @@ -58,7 +59,7 @@ import org.springframework.web.client.RestTemplate; */ @Configuration(proxyBeanMethods = false) @ConditionalOnProperty(value = { "spring.sleuth.enabled", "spring.zipkin.enabled" }, matchIfMissing = true) -@AutoConfigureBefore(TraceAutoConfiguration.class) +@AutoConfigureBefore({ TraceAutoConfiguration.class, TraceBraveAutoConfiguration.class }) @ConditionalOnClass(Tracer.class) @AutoConfigureAfter(ZipkinAutoConfiguration.class) public class ZipkinBraveAutoConfiguration { diff --git a/spring-cloud-sleuth-zipkin/src/main/java/org/springframework/cloud/sleuth/zipkin2/ZipkinOtelAutoConfiguration.java b/spring-cloud-sleuth-zipkin/src/main/java/org/springframework/cloud/sleuth/zipkin2/ZipkinOtelAutoConfiguration.java index e3a03aed5..c0c3f326e 100644 --- a/spring-cloud-sleuth-zipkin/src/main/java/org/springframework/cloud/sleuth/zipkin2/ZipkinOtelAutoConfiguration.java +++ b/spring-cloud-sleuth-zipkin/src/main/java/org/springframework/cloud/sleuth/zipkin2/ZipkinOtelAutoConfiguration.java @@ -27,6 +27,7 @@ import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; import org.springframework.cloud.sleuth.autoconfig.TraceAutoConfiguration; +import org.springframework.cloud.sleuth.otel.autoconfig.TraceOtelAutoConfiguration; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.core.env.Environment; @@ -49,7 +50,7 @@ import org.springframework.web.client.RestTemplate; */ @Configuration(proxyBeanMethods = false) @ConditionalOnProperty(value = { "spring.sleuth.enabled", "spring.zipkin.enabled" }, matchIfMissing = true) -@AutoConfigureBefore(TraceAutoConfiguration.class) +@AutoConfigureBefore({ TraceAutoConfiguration.class, TraceOtelAutoConfiguration.class }) @ConditionalOnClass(Tracer.class) @AutoConfigureAfter(ZipkinAutoConfiguration.class) public class ZipkinOtelAutoConfiguration { diff --git a/spring-cloud-sleuth-zipkin/src/test/java/org/springframework/cloud/sleuth/zipkin2/ZipkinSamplerTests.java b/spring-cloud-sleuth-zipkin/src/test/java/org/springframework/cloud/sleuth/zipkin2/ZipkinSamplerTests.java new file mode 100644 index 000000000..e35c098a4 --- /dev/null +++ b/spring-cloud-sleuth-zipkin/src/test/java/org/springframework/cloud/sleuth/zipkin2/ZipkinSamplerTests.java @@ -0,0 +1,70 @@ +/* + * Copyright 2013-2020 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.cloud.sleuth.zipkin2; + +import org.assertj.core.api.BDDAssertions; +import org.junit.jupiter.api.Test; + +import org.springframework.boot.autoconfigure.AutoConfigurations; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.context.runner.ApplicationContextRunner; +import org.springframework.cloud.sleuth.brave.autoconfig.TraceBraveAutoConfiguration; +import org.springframework.cloud.sleuth.otel.autoconfig.TraceOtelAutoConfiguration; +import org.springframework.context.annotation.Configuration; + +/** + * Not using {@linkplain SpringBootTest} as we need to change properties per test. + * + * @author Adrian Cole + */ +public class ZipkinSamplerTests { + + @Test + void should_set_sampler_to_non_never_when_zipkin_handler_on_classpath_for_brave() { + ApplicationContextRunner contextRunner = new ApplicationContextRunner().withConfiguration( + AutoConfigurations.of(BraveTestConfig.class)); + + contextRunner.run(context -> { + brave.sampler.Sampler sampler = context.getBean(brave.sampler.Sampler.class); + BDDAssertions.then(sampler).isNotSameAs(brave.sampler.Sampler.NEVER_SAMPLE); + }); + } + + @Test + void should_set_sampler_to_non_off_when_zipkin_handler_on_classpath_for_otel() { + ApplicationContextRunner contextRunner = new ApplicationContextRunner().withConfiguration( + AutoConfigurations.of(OtelTestConfig.class)); + + contextRunner.run(context -> { + io.opentelemetry.sdk.trace.samplers.Sampler sampler = context.getBean(io.opentelemetry.sdk.trace.samplers.Sampler.class); + BDDAssertions.then(sampler).isNotSameAs(io.opentelemetry.sdk.trace.samplers.Sampler.alwaysOff()); + }); + } + + @Configuration(proxyBeanMethods = false) + @EnableAutoConfiguration(exclude = TraceBraveAutoConfiguration.class) + static class OtelTestConfig { + + } + + @Configuration(proxyBeanMethods = false) + @EnableAutoConfiguration(exclude = TraceOtelAutoConfiguration.class) + static class BraveTestConfig { + + } +}