+ * "spring-cloud-sleuth-zipkin" obviated the {@link Sampler#NEVER_SAMPLE} default by + * importing {@link SamplerAutoConfiguration}. Nothing else did, so sampling properties + * were effectively ignored unless "spring-cloud-sleuth-zipkin" was in use, or something + * else similarly imported {@link SamplerAutoConfiguration}. + * + *
+ * During a review of Wavefront integration, it was considered not correct to have other + * code import {@link SamplerAutoConfiguration}. To avoid that, retain the old behaviour + * about log only nodes, and also not pin configuration to Zipkin involves a more complex + * condition. + * + *
+ * This condition looks for signs of non-default setup which likely requires sampling + * configuration. It passes on one of the following beans exist: + * + *
+ *
+ * An integrated test that shows {@link Sampler#NEVER_SAMPLE} is default on fail exists in + * {@code TraceAutoConfigurationTests} intentionally, as users now needn't import + * {@link SamplerAutoConfiguration} directly. + */ +final class SamplerCondition extends AnyNestedCondition { + + SamplerCondition() { + super(ConfigurationPhase.REGISTER_BEAN); + } + + // zipkin2.reporter.Reporter is in the classpath here, but technically it is optional + @ConditionalOnBean(type = "zipkin2.reporter.Reporter") + static final class ReporterAvailable { + + } + + @ConditionalOnBean(FinishedSpanHandler.class) + static final class FinishedSpanHandlerAvailable { + + } + + @ConditionalOnBean(TracingCustomizer.class) + static final class TracingCustomizerAvailable { + + } + +} diff --git a/spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/sleuth/sampler/SamplerAutoConfigurationTests.java b/spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/sleuth/sampler/SamplerAutoConfigurationTests.java index 6ad1fdb04..c6c72113b 100644 --- a/spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/sleuth/sampler/SamplerAutoConfigurationTests.java +++ b/spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/sleuth/sampler/SamplerAutoConfigurationTests.java @@ -16,33 +16,159 @@ package org.springframework.cloud.sleuth.sampler; +import brave.Tracing; +import brave.TracingCustomizer; +import brave.handler.FinishedSpanHandler; +import brave.handler.MutableSpan; +import brave.propagation.TraceContext; +import brave.sampler.CountingSampler; import brave.sampler.Sampler; import org.assertj.core.api.BDDAssertions; import org.junit.Test; +import zipkin2.Span; +import zipkin2.reporter.Reporter; + +import org.springframework.boot.autoconfigure.AutoConfigurations; +import org.springframework.boot.test.context.runner.ApplicationContextRunner; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; /** * @author Marcin Grzejszczak * @since */ +// TODO: missing spring cloud context tests public class SamplerAutoConfigurationTests { + private final ApplicationContextRunner contextRunner = new ApplicationContextRunner() + .withConfiguration(AutoConfigurations.of(SamplerAutoConfiguration.class)); + @Test - public void should_use_rate_limit_sampler_when_property_set() { - SamplerProperties properties = new SamplerProperties(); - properties.setRate(10); - - Sampler sampler = SamplerAutoConfiguration.samplerFromProps(properties); - - BDDAssertions.then(sampler).isInstanceOf(RateLimitingSampler.class); + public void should_use_NEVER_SAMPLER_when_only_logging() { + this.contextRunner.run((context -> { + final Sampler bean = context.getBean(Sampler.class); + BDDAssertions.then(bean).isSameAs(Sampler.NEVER_SAMPLE); + })); } @Test - public void should_use_probability_sampler_when_rate_limiting_not_set() { + public void should_use_CountingSampler_withFinishedSpanHandler() { + this.contextRunner.withUserConfiguration(WithFinishedSpanHandler.class) + .run((context -> { + final Sampler bean = context.getBean(Sampler.class); + BDDAssertions.then(bean).isInstanceOf(CountingSampler.class); + })); + } + + @Test + public void should_use_CountingSampler_withReporter() { + this.contextRunner.withUserConfiguration(WithReporter.class).run((context -> { + final Sampler bean = context.getBean(Sampler.class); + BDDAssertions.then(bean).isInstanceOf(CountingSampler.class); + })); + } + + @Test + public void should_use_CountingSampler_withTracingCustomizer() { + this.contextRunner.withUserConfiguration(WithTracingCustomizer.class) + .run((context -> { + final Sampler bean = context.getBean(Sampler.class); + BDDAssertions.then(bean).isInstanceOf(CountingSampler.class); + })); + } + + @Test + public void should_override_sampler() { + this.contextRunner.withUserConfiguration(WithReporter.class, WithSampler.class) + .run((context -> { + final Sampler bean = context.getBean(Sampler.class); + BDDAssertions.then(bean).isSameAs(Sampler.ALWAYS_SAMPLE); + })); + } + + @Test + public void samplerFromProps_probability() { + SamplerProperties properties = new SamplerProperties(); + properties.setProbability(0.01f); + + Sampler sampler = SamplerAutoConfiguration.samplerFromProps(properties); + + BDDAssertions.then(sampler).isInstanceOf(brave.sampler.CountingSampler.class); + } + + @Test + public void samplerFromProps_rateLimit() { SamplerProperties properties = new SamplerProperties(); Sampler sampler = SamplerAutoConfiguration.samplerFromProps(properties); - BDDAssertions.then(sampler).isInstanceOf(ProbabilityBasedSampler.class); + BDDAssertions.then(sampler).isInstanceOf(brave.sampler.CountingSampler.class); + } + + @Test + public void samplerFromProps_rateLimitZero() { + SamplerProperties properties = new SamplerProperties(); + properties.setRate(0); + + Sampler sampler = SamplerAutoConfiguration.samplerFromProps(properties); + + BDDAssertions.then(sampler).isSameAs(Sampler.NEVER_SAMPLE); + } + + @Test + public void samplerFromProps_prefersRate() { + SamplerProperties properties = new SamplerProperties(); + properties.setProbability(0.01f); + properties.setRate(20); + + Sampler sampler = SamplerAutoConfiguration.samplerFromProps(properties); + + BDDAssertions.then(sampler).isInstanceOf(brave.sampler.RateLimitingSampler.class); + } + + @Configuration + static class WithFinishedSpanHandler { + + @Bean + FinishedSpanHandler finishedSpanHandler() { + return new FinishedSpanHandler() { + @Override + public boolean handle(TraceContext context, MutableSpan span) { + return true; + } + }; + } + + } + + @Configuration + static class WithReporter { + + @Bean + Reporter spanReporter() { + return zipkin2.Span::toString; + } + + } + + @Configuration + static class WithSampler { + + @Bean + Sampler alwaysSampler() { + return Sampler.ALWAYS_SAMPLE; + } + + } + + @Configuration + static class WithTracingCustomizer { + + @Bean + TracingCustomizer tracingCustomizer() { + return Tracing.Builder::toString; + } + } }