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

Abstract tracer implementations via an API (#1757)

Browse Source 
Spring Cloud Sleuth currently is an autoconfiguration over Brave. It also consists of various instrumentation mechanisms for libraries that are not supported by Brave (e.g. Spring Cloud Circuitbreaker).

We would like to abstract Brave so that Spring Cloud Sleuth becomes an autoconfiguration for any tracer implementation that is compatible with Spring Cloud Sleuth. That way Spring Cloud Sleuth in its core module would consist of an API and various tracer implementations would implement that API which would also allow automatic instrumentation of libraries that are supported by Spring Cloud Sleuth.

## OpenTelemetry Support

Thanks to doing this abstraction we are able to support new tracer implementations, not only Brave. We've decided to add support for the OpenTelemetry SDK as the second one. If in the future if we decide to add new tracers then it will be just a matter of adding a new module that bridges to the Spring Cloud Sleuth one. Thanks to abstraction of tests as well we will be easily able to plug that tracer mechanism into our current suite of tests.
This commit is contained in:
Marcin Grzejszczak
2020-10-23 08:50:23 +02:00
committed by GitHub
parent e6ebce4505
commit 6e306e594d
658 changed files with 27572 additions and 7261 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
spring-cloud-sleuth-samples/spring-cloud-sleuth-sample-messaging/src/test/java/integration/MessagingApplicationTests.java
View File

@@ -18,10 +18,10 @@ package integration;
import java.util.List;
import java.util.Optional;
import java.util.Random;
import java.util.stream.Collectors;
import brave.Span;
import brave.Tracer;
import brave.handler.MutableSpan;
import brave.handler.SpanHandler;
import brave.sampler.Sampler;
@@ -55,6 +55,9 @@ public class MessagingApplicationTests extends AbstractIntegrationTest {
@Autowired
IntegrationTestZipkinSpanHandler testSpanHandler;
@Autowired
Tracer tracer;
@AfterEach
public void cleanup() {
this.testSpanHandler.spans.clear();
@@ -62,23 +65,27 @@ public class MessagingApplicationTests extends AbstractIntegrationTest {
@Test
public void should_have_passed_trace_id_when_message_is_about_to_be_sent() {
long traceId = new Random().nextLong();
Span span = tracer.nextSpan().start();
long traceId = span.context().traceId();
await().atMost(15, SECONDS).untilAsserted(
await().atMost(3, SECONDS).untilAsserted(
() -> httpMessageWithTraceIdInHeadersIsSuccessfullySent(sampleAppUrl + "/", traceId).run());
await().atMost(15, SECONDS).untilAsserted(() -> thenAllSpansHaveTraceIdEqualTo(traceId));
span.finish();
await().atMost(3, SECONDS).untilAsserted(() -> thenAllSpansHaveTraceIdEqualTo(traceId));
}
@Test
public void should_have_passed_trace_id_and_generate_new_span_id_when_message_is_about_to_be_sent() {
long traceId = new Random().nextLong();
long spanId = new Random().nextLong();
Span span = tracer.nextSpan().start();
long traceId = span.context().traceId();
long spanId = span.context().spanId();
await().atMost(15, SECONDS).untilAsserted(
await().atMost(3, SECONDS).untilAsserted(
() -> httpMessageWithTraceIdInHeadersIsSuccessfullySent(sampleAppUrl + "/", traceId, spanId).run());
await().atMost(15, SECONDS).untilAsserted(() -> {
span.finish();
await().atMost(3, SECONDS).untilAsserted(() -> {
thenAllSpansHaveTraceIdEqualTo(traceId);
thenTheSpansHaveProperParentStructure();
});
@@ -86,12 +93,14 @@ public class MessagingApplicationTests extends AbstractIntegrationTest {
@Test
public void should_have_passed_trace_id_with_annotations_in_async_thread_when_message_is_about_to_be_sent() {
long traceId = new Random().nextLong();
Span span = tracer.nextSpan().start();
long traceId = span.context().traceId();
await().atMost(15, SECONDS).untilAsserted(
await().atMost(3, SECONDS).untilAsserted(
() -> httpMessageWithTraceIdInHeadersIsSuccessfullySent(sampleAppUrl + "/xform", traceId).run());
await().atMost(15, SECONDS).untilAsserted(() -> {
span.finish();
await().atMost(3, SECONDS).untilAsserted(() -> {
thenAllSpansHaveTraceIdEqualTo(traceId);
thenThereIsAtLeastOneTagWithKey("background-sleep-millis");
});
@@ -121,12 +130,17 @@ public class MessagingApplicationTests extends AbstractIntegrationTest {
// "http:/parent/" -> "message:messages" -> "http:/foo" (CS + CR) -> "http:/foo"
// (SS)
thenAllSpansArePresent(firstHttpSpan, eventSpans, lastHttpSpansParent, eventSentSpan, producerSpan);
then(this.testSpanHandler.spans).as("There were 6 spans").hasSize(6);
List<MutableSpan> spans = this.testSpanHandler.spans;
then(spans).as("There were 7 spans").hasSize(7);
log.info("Checking the parent child structure");
List<Optional<MutableSpan>> parentChild = this.testSpanHandler.spans.stream()
.filter(span -> span.parentId() != null).map(span -> this.testSpanHandler.spans.stream()
.filter(span1 -> span1.id().equals(span.parentId())).findAny())
.collect(Collectors.toList());
List<Optional<MutableSpan>> parentChild = spans.stream().filter(span -> span.parentId() != null).map(span -> {
Optional<MutableSpan> any = spans.stream().filter(span1 -> span1.id().equals(span.parentId())).findAny();
if (!any.isPresent()) {
log.warn("Span with id [" + span.id() + "] and parent span id [" + span.parentId()
+ "] doesn't have a corresponding span with id equal to parent id");
}
return any;
}).collect(Collectors.toList());
log.info("List of parents and children " + parentChild);
then(parentChild.stream().allMatch(Optional::isPresent)).isTrue();
}
@@ -169,7 +183,7 @@ public class MessagingApplicationTests extends AbstractIntegrationTest {
then(lastHttpSpan.isPresent()).isTrue();
}
@Configuration
@Configuration(proxyBeanMethods = false)
public static class IntegrationSpanCollectorConfig {
@Bean