SpringCloud/spring-cloud-sleuth
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Makes the new queueInstrumentation opt-in

Browse Source
This commit is contained in:
Marcin Grzejszczak
2021-02-26 13:53:52 +01:00
parent 4b123747b3
commit 2e902a7fec
8 changed files with 27 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
benchmarks/src/test/java/org/springframework/cloud/sleuth/benchmarks/jmh/Pair.java
View File

@@ -33,8 +33,8 @@ public class Pair {
return new Pair(key, value);
}
public static Pair noHook() {
return new Pair("spring.sleuth.reactor.decorate-queues", "false");
public static Pair onHook() {
return new Pair("spring.sleuth.reactor.decorate-queues", "true");
}
public static Pair noSleuth() {

18
benchmarks/src/test/java/org/springframework/cloud/sleuth/benchmarks/jmh/stream/MicroBenchmarkStreamTests.java
View File

@@ -22,6 +22,7 @@ import java.util.List;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;
import brave.Tracer;
import brave.Tracing;
import jmh.mbr.junit5.Microbenchmark;
import org.junit.platform.commons.annotation.Testable;
@@ -134,6 +135,7 @@ public class MicroBenchmarkStreamTests {
} else {
assertThat(b3).startsWith("4883117762eb9420");
}
assertThat(this.applicationContext.getBean(Tracer.class).currentSpan()).isNull();
}
}
@@ -155,15 +157,15 @@ public class MicroBenchmarkStreamTests {
// @formatter:off
noSleuthSimple(Pair.noSleuth(), function("simple")),
sleuthSimpleOnHooks(function("simple")),
sleuthSimpleOnEach(function("simple"), Pair.noHook(), Pair.onEach()),
sleuthSimpleOnLast(function("simple"), Pair.noHook(), Pair.onLast()),
sleuthSimpleWithAroundOnHooks(function("simple_function_with_around")),
sleuthSimpleWithAroundOnEach(function("simple_function_with_around"), Pair.noHook(), Pair.onEach()),
sleuthSimpleWithAroundOnLast(function("simple_function_with_around"), Pair.noHook(), Pair.onLast()),
sleuthSimpleOnHooks(function("simple"), Pair.onHook()),
sleuthSimpleOnEach(function("simple"), Pair.onEach()),
sleuthSimpleOnLast(function("simple"), Pair.onLast()),
sleuthSimpleWithAroundOnHooks(function("simple_function_with_around"), Pair.onHook()),
sleuthSimpleWithAroundOnEach(function("simple_function_with_around"), Pair.onEach()),
sleuthSimpleWithAroundOnLast(function("simple_function_with_around"), Pair.onLast()),
noSleuthReactiveSimple(function("reactive_simple"), Pair.noSleuth()),
sleuthReactiveSimpleOnHooks(function("DECORATE_ON_EACH")),
sleuthReactiveSimpleOnEach(function("DECORATE_ON_EACH"), Pair.noHook(), Pair.onEach(), integrationEnabled());
sleuthReactiveSimpleOnHooks(function("DECORATE_ON_EACH"), Pair.onHook()),
sleuthReactiveSimpleOnEach(function("DECORATE_ON_EACH"), Pair.onEach(), integrationEnabled());
// @formatter:on
private List<Pair> pairs;

16
benchmarks/src/test/java/org/springframework/cloud/sleuth/benchmarks/jmh/webflux/MicroBenchmarkHttpTests.java
View File

@@ -22,6 +22,7 @@ import java.util.List;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;
import brave.Tracer;
import brave.Tracing;
import jmh.mbr.junit5.Microbenchmark;
import org.junit.platform.commons.annotation.Testable;
@@ -47,6 +48,8 @@ import org.springframework.cloud.sleuth.benchmarks.jmh.TracerImplementation;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.test.web.reactive.server.WebTestClient;
import static org.assertj.core.api.Assertions.assertThat;
@Measurement(iterations = 10, time = 1)
@Warmup(iterations = 10, time = 1)
@Fork(4)
@@ -98,6 +101,7 @@ public class MicroBenchmarkHttpTests {
void run() {
this.webTestClient.get().uri(instrumentation.url).header("X-B3-TraceId", "4883117762eb9420")
.header("X-B3-SpanId", "4883117762eb9420").exchange().expectStatus().isOk();
assertThat(this.applicationContext.getBean(Tracer.class).currentSpan()).isNull();
}
@TearDown
@@ -118,13 +122,13 @@ public class MicroBenchmarkHttpTests {
// @formatter:off
noSleuthSimple("/simple", Pair.noSleuth()),
sleuthSimpleOnHooks("/simple"),
sleuthSimpleOnEach("/simple", Pair.noHook(), Pair.onEach()),
sleuthSimpleOnLast("/simple", Pair.noHook(), Pair.onLast()),
sleuthSimpleOnHooks("/simple", Pair.onHook()),
sleuthSimpleOnEach("/simple", Pair.onEach()),
sleuthSimpleOnLast("/simple", Pair.onLast()),
noSleuthComplex("/complexNoSleuth", Pair.noSleuth()),
onHooksComplex("/complex"),
onEachComplex("/complex", Pair.noHook(), Pair.onEach()),
onLastComplex("/complex", Pair.noHook(), Pair.onLast());
onHooksComplex("/complex", Pair.onHook()),
onEachComplex("/complex", Pair.onEach()),
onLastComplex("/complex", Pair.onLast());
// @formatter:on
private String url;

2
docs/src/main/asciidoc/spring-cloud-sleuth.adoc
View File

@@ -1528,7 +1528,7 @@ To turn off this feature, set the `spring.sleuth.quartz.enabled` property to `fa
==== From Spring Cloud Sleuth 2.2.8 (inclusive)
With the new Reactor https://github.com/reactor/reactor-core/pull/2566[queue wrapping mechanism] (Reactor 3.3.14) we're instrumenting the way threads are switched by Reactor. You should observe significant improvement in performance. In order to disable this feature you have to set the `spring.sleuth.reactor.decorate-queues` option to `false`. You'll fall back to the previous instrumentation mode mechanism.
With the new Reactor https://github.com/reactor/reactor-core/pull/2566[queue wrapping mechanism] (Reactor 3.3.14) we're instrumenting the way threads are switched by Reactor. You should observe significant improvement in performance. In order to enable this feature you have to set the `spring.sleuth.reactor.decorate-queues` option to `true`.
==== To Spring Cloud Sleuth 2.2.8 (exclusive)

2
spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/reactor/TraceReactorAutoConfiguration.java
View File

@@ -234,7 +234,7 @@ class HookRegisteringBeanDefinitionRegistryPostProcessor
"You have explicitly set the decorate hooks option but you're using an old version of Reactor. Please upgrade to the latest Boot version (at least 2.3.9.RELEASE). Will fall back to the previous reactor instrumentation mode");
}
else {
decorateQueues = decorateQueues != null ? decorateQueues : Boolean.TRUE;
decorateQueues = decorateQueues != null ? decorateQueues : Boolean.FALSE;
}
if (wrapperOnClasspathHooksPropertyTurnedOn(decorateQueues)) {
if (log.isTraceEnabled()) {

3
spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/sleuth/instrument/web/TraceNoWebEnvironmentTests.java
View File

@@ -49,8 +49,7 @@ public class TraceNoWebEnvironmentTests {
}
catch (Exception e) {
Throwable cause = e.getCause() != null ? e.getCause() : e;
then(cause.getClass())
.isNotEqualTo(NoSuchBeanDefinitionException.class);
then(cause.getClass()).isNotEqualTo(NoSuchBeanDefinitionException.class);
}
}

2
spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/sleuth/instrument/web/client/integration/WebClientTests.java
View File

@@ -167,7 +167,7 @@ public class WebClientTests {
this.testErrorController.clear();
this.fooController.clear();
}
@Before
public void setup() {
log.info("Starting test");

1
tests/spring-cloud-sleuth-instrumentation-reactor-tests/src/test/java/org/springframework/cloud/sleuth/instrument/reactor/sample/FlatMapTests.java
View File

@@ -88,6 +88,7 @@ public class FlatMapTests {
.web(WebApplicationType.REACTIVE)
.properties("server.port=0", "spring.jmx.enabled=false",
"spring.application.name=TraceWebFluxOnHooksTests",
"spring.sleuth.reactor.decorate-queues=true",
"security.basic.enabled=false",
"management.security.enabled=false")
.run();