Spring Cloud Sleuth
3.1.3Spring Cloud Sleuth provides Spring Boot auto-configuration for distributed tracing.
Features
Sleuth configures everything you need to get started. This includes where trace data (spans) are reported to, how many traces to keep (sampling), if remote fields (baggage) are sent, and which libraries are traced.
Specifically, Spring Cloud Sleuth…
-
Adds trace and span ids to the Slf4J MDC, so you can extract all the logs from a given trace or span in a log aggregator.
-
Instruments common ingress and egress points from Spring applications (servlet filter, rest template, scheduled actions, message channels, feign client).
-
If
spring-cloud-sleuth-zipkinis available then the app will generate and report Zipkin-compatible traces via HTTP. By default it sends them to a Zipkin collector service on localhost (port 9411). Configure the location of the service usingspring.zipkin.baseUrl.
Spring Boot Config
Add Sleuth to your classpath:
Maven
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${release.train.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-sleuth</artifactId>
</dependency>
</dependencies>Gradle
buildscript {
dependencies {
classpath "io.spring.gradle:dependency-management-plugin:0.5.2.RELEASE"
}
}
apply plugin: "io.spring.dependency-management"
dependencyManagement {
imports {
mavenBom "org.springframework.cloud:spring-cloud-dependencies:${releaseTrainVersion}"
}
}
dependencies {
compile 'org.springframework.cloud:spring-cloud-starter-sleuth'
}As long as Spring Cloud Sleuth is on the classpath any Spring Boot application will generate trace data:
@SpringBootApplication
@RestController
public class Application {
private static Logger log = LoggerFactory.getLogger(DemoController.class);
@RequestMapping("/")
public String home() {
log.info("Handling home");
return "Hello World";
}
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}Run this app and then hit the home page. You will see traceId and spanId populated in the logs.
If this app calls out to another one (e.g. with RestTemplate) it will send the trace data in
headers and if the receiver is another Sleuth app you will see the trace continue there.
-
Instead of logging the request in the handler explicitly, you could set
logging.level.org.springframework.web.servlet.DispatcherServlet=DEBUG -
Sleuth defaults to a rate limited sampler. That means that it will sample up to 1000 transactions per second.
-
Set
spring.application.name=bar(for instance) to see the service name as well as the trace and span ids.
Documentation
| 3.1.3 CURRENT GA | Reference Doc. | |
| 3.1.4-SNAPSHOT SNAPSHOT | Reference Doc. | |
| 3.0.5-SNAPSHOT SNAPSHOT | Reference Doc. | |
| 3.0.4 GA | Reference Doc. | |
| 2.2.9.BUILD-SNAPSHOT SNAPSHOT | Reference Doc. | |
| 2.2.8.RELEASE GA | Reference Doc. |
| Branch | Initial Release | End of Support | End Commercial Support * |
|---|---|---|---|
|
3.1.x
|
2021-11-30 | 2023-05-18 | 2024-08-22 |
|
3.0.x
|
2020-12-22 | 2022-05-19 | 2023-09-19 |
|
2.2.x
|
2019-11-26 | 2020-11-26 | 2022-03-26 |
OSS support
Free security updates and bugfixes with support from the Spring community. See VMware Tanzu OSS support policy.
Commercial support
Business support from Spring experts during the OSS timeline, plus extended support after OSS End-Of-Life.
Publicly available releases for critical bugfixes and security issues when requested by customers.
Future release
Generation not yet released, timeline is subject to changes.