module to your project.
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
- <version>Camden.RELEASE</version>
+ <version>Brixton.RELEASE</version>
<type>pom</type>
<scope>import</scope>
</dependency>
@@ -1016,7 +975,7 @@ the Spring BOM
dependencyManagement { (1)
imports {
- mavenBom "org.springframework.cloud:spring-cloud-dependencies:Camden.RELEASE"
+ mavenBom "org.springframework.cloud:spring-cloud-dependencies:Brixton.RELEASE"
}
}
@@ -1050,7 +1009,7 @@ the Spring BOM
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
- <version>Camden.RELEASE</version>
+ <version>Brixton.RELEASE</version>
<type>pom</type>
<scope>import</scope>
</dependency>
@@ -1079,7 +1038,7 @@ the Spring BOM
dependencyManagement { (1)
imports {
- mavenBom "org.springframework.cloud:spring-cloud-dependencies:Camden.RELEASE"
+ mavenBom "org.springframework.cloud:spring-cloud-dependencies:Brixton.RELEASE"
}
}
@@ -1113,7 +1072,7 @@ the Spring BOM
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
- <version>Camden.RELEASE</version>
+ <version>Brixton.RELEASE</version>
<type>pom</type>
<scope>import</scope>
</dependency>
@@ -1157,7 +1116,7 @@ the Spring BOM
dependencyManagement { (1)
imports {
- mavenBom "org.springframework.cloud:spring-cloud-dependencies:Camden.RELEASE"
+ mavenBom "org.springframework.cloud:spring-cloud-dependencies:Brixton.RELEASE"
}
}
@@ -1201,7 +1160,7 @@ dependency
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
- <version>Camden.RELEASE</version>
+ <version>Brixton.RELEASE</version>
<type>pom</type>
<scope>import</scope>
</dependency>
@@ -1245,7 +1204,7 @@ the Spring BOM
dependencyManagement { (1)
imports {
- mavenBom "org.springframework.cloud:spring-cloud-dependencies:Camden.RELEASE"
+ mavenBom "org.springframework.cloud:spring-cloud-dependencies:Brixton.RELEASE"
}
}
@@ -1299,22 +1258,6 @@ public class ZipkinStreamServerApplication {
-
Additional resources
-
-
-
Marcin Grzejszczak talking about Spring Cloud Sleuth and Zipkin
-
-
-
-
-
Features
@@ -1384,10 +1327,6 @@ works via Zipkin-compatible request headers. This propagation logic is defined a
SpanInjector and
SpanExtractor implementations.
-Sleuth gives you the possibility to propagate context (also known as baggage) between processes. That means that if you set on a Span
-a baggage element then it will be sent downstream either via HTTP or messaging to other processes.
-
-
Provides simple metrics of accepted / dropped spans.
@@ -1752,7 +1691,7 @@ artificial like:
@SpanName annotation
-
You can name the span explicitly via the @SpanName annotation.
+
You can do name the span explicitly via the @SpanName annotation.
@@ -1837,54 +1776,46 @@ are created and propagated.
or HTTP headers), to start or join an existing trace. Trace information is
injected into any outbound requests so the next hop can extract them.
-
-
The key change in comparison to the previous versions of Sleuth is that Sleuth is implementing
-the Open Tracing’s TextMap notion. In Sleuth it’s called SpanTextMap. Basically the idea
-is that any means of communication (e.g. message, http request, etc.) can be abstracted via
-a SpanTextMap. This abstraction defines how one can insert data into the carrier and
-how to retrieve it from there. Thanks to this if you want to instrument a new HTTP library
-that uses a FooRequest as a mean of sending HTTP requests then you have to create an
-implementation of a SpanTextMap that delegates calls to FooRequest in terms of retrieval
-and insertion of HTTP headers.
-
Spring Integration
-
For Spring Integration there are 2 interfaces responsible for creation of a Span from a Message.
-These are:
+
For Spring Integration these are the beans responsible for creation of a Span from a Message
+ and filling in the MessageBuilder with tracing information.
+
+
+
+
@Bean
+public SpanExtractor<Message> messagingSpanExtractor() {
+ ...
+}
+
+@Bean
+public SpanInjector<MessageBuilder> messagingSpanInjector() {
+ ...
+}
-
-
You can override them by providing your own implementation.
+
You can override them by providing your own implementation and by adding a @Primary annotation
+to your bean definition.
HTTP
-
For HTTP there are 2 interfaces responsible for creation of a Span from a Message.
-These are:
+
For HTTP these are the beans responsible for creation of a Span from a HttpServletRequest.
+
+
+
+
@Bean
+public SpanExtractor<HttpServletRequest> httpServletRequestSpanExtractor() {
+ ...
+}
-
-
--
-
HttpSpanExtractor
-
--
-
HttpSpanInjector
-
-
-
You can override them by providing your own implementation.
+
You can override them by providing your own implementation and by adding a @Primary annotation
+to your bean definition.
@@ -1908,26 +1839,18 @@ you have
-
static class CustomHttpSpanExtractor implements HttpSpanExtractor {
+static class CustomHttpServletRequestSpanExtractor
+ implements SpanExtractor<HttpServletRequest> {
- @Override public Span joinTrace(SpanTextMap carrier) {
- Map<String, String> map = TextMapUtil.asMap(carrier);
- long traceId = Span.hexToId(map.get("correlationid"));
- long spanId = Span.hexToId(map.get("myspanid"));
+ @Override
+ public Span joinTrace(HttpServletRequest carrier) {
+ long traceId = Span.hexToId(carrier.getHeader("correlationId"));
+ long spanId = Span.hexToId(carrier.getHeader("mySpanId"));
// extract all necessary headers
Span.SpanBuilder builder = Span.builder().traceId(traceId).spanId(spanId);
// build rest of the Span
return builder.build();
}
-}
-
-static class CustomHttpSpanInjector implements HttpSpanInjector {
-
- @Override
- public void inject(Span span, SpanTextMap carrier) {
- carrier.put("correlationId", span.traceIdString());
- carrier.put("mySpanId", Span.idToHex(span.getSpanId()));
- }
}
@@ -1937,13 +1860,9 @@ static class CustomHttpSpanInjector implements HttpSpanInjector {
@Bean
-HttpSpanInjector customHttpSpanInjector() {
- return new CustomHttpSpanInjector();
-}
-
-@Bean
-HttpSpanExtractor customHttpSpanExtractor() {
- return new CustomHttpSpanExtractor();
+@Primary
+SpanExtractor<HttpServletRequest> customHttpServletRequestSpanExtractor() {
+ return new CustomHttpServletRequestSpanExtractor();
}
@@ -1953,22 +1872,22 @@ that injects the headers into the Http Response and a Servlet filter which makes
-
static class CustomHttpServletResponseSpanInjector extends ZipkinHttpSpanInjector {
+static class CustomHttpServletResponseSpanInjector
+ implements SpanInjector<HttpServletResponse> {
@Override
- public void inject(Span span, SpanTextMap carrier) {
- super.inject(span, carrier);
- carrier.put(Span.TRACE_ID_NAME, span.traceIdString());
- carrier.put(Span.SPAN_ID_NAME, Span.idToHex(span.getSpanId()));
+ public void inject(Span span, HttpServletResponse carrier) {
+ carrier.addHeader(Span.TRACE_ID_NAME, span.traceIdString());
+ carrier.addHeader(Span.SPAN_ID_NAME, Span.idToHex(span.getSpanId()));
}
}
static class HttpResponseInjectingTraceFilter extends GenericFilterBean {
private final Tracer tracer;
- private final HttpSpanInjector spanInjector;
+ private final SpanInjector<HttpServletResponse> spanInjector;
- public HttpResponseInjectingTraceFilter(Tracer tracer, HttpSpanInjector spanInjector) {
+ public HttpResponseInjectingTraceFilter(Tracer tracer, SpanInjector<HttpServletResponse> spanInjector) {
this.tracer = tracer;
this.spanInjector = spanInjector;
}
@@ -1977,32 +1896,9 @@ static class HttpResponseInjectingTraceFilter extends GenericFilterBean {
public void doFilter(ServletRequest request, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
HttpServletResponse response = (HttpServletResponse) servletResponse;
Span currentSpan = this.tracer.getCurrentSpan();
- this.spanInjector.inject(currentSpan, new HttpServletResponseTextMap(response));
+ this.spanInjector.inject(currentSpan, response);
filterChain.doFilter(request, response);
}
-
- class HttpServletResponseTextMap implements SpanTextMap {
-
- private final HttpServletResponse delegate;
-
- HttpServletResponseTextMap(HttpServletResponse delegate) {
- this.delegate = delegate;
- }
-
- @Override
- public Iterator<Map.Entry<String, String>> iterator() {
- Map<String, String> map = new HashMap<>();
- for (String header : this.delegate.getHeaderNames()) {
- map.put(header, this.delegate.getHeader(header));
- }
- return map.entrySet().iterator();
- }
-
- @Override
- public void put(String key, String value) {
- this.delegate.addHeader(key, value);
- }
- }
}
@@ -2011,7 +1907,8 @@ static class HttpResponseInjectingTraceFilter extends GenericFilterBean {
-
@Bean HttpSpanInjector customHttpServletResponseSpanInjector() {
+@Bean
+SpanInjector<HttpServletResponse> customHttpServletResponseSpanInjector() {
return new CustomHttpServletResponseSpanInjector();
}
@@ -2186,25 +2083,6 @@ the consumer app).
-
-
In order to customize the polling mechanism you can create a bean of PollerMetadata type
-with name equal to StreamSpanReporter.POLLER. Here you can find an example of such a configuration.
-
-
-
-
@Configuration
-public static class CustomPollerConfiguration {
-
- @Bean(name = StreamSpanReporter.POLLER)
- PollerMetadata customPoller() {
- PollerMetadata poller = new PollerMetadata();
- poller.setMaxMessagesPerPoll(500);
- poller.setTrigger(new PeriodicTrigger(5000L));
- return poller;
- }
-}
-
-
@@ -2513,23 +2391,10 @@ backwards compatibility in 1.0.4 we’ve started sending both valid and inva
in Spring Cloud Sleuth 1.1 we will remove the support for the deprecated headers.
-
You can provide the spring.sleuth.integration.patterns pattern to explicitly
+
Since 1.0.4 you can provide the spring.sleuth.integration.patterns pattern to explicitly
provide the names of channels that you want to include for tracing. By default all channels
are included.
-
-
-
-|
- Important
- |
-
-When using the Executor to build a Spring Integration IntegrationFlow remember to use the untraced version of the Executor.
-Decorating Spring Integration Executor Channel with TraceableExecutorService will cause the spans to be improperly closed.
- |
-
-
-
Zuul
+
+
+
+
+
+
+
+
+