Repository files navigation

This repository provides OpenTracing instrumentation for Spring Boot and its various extensions. It can be used with any OpenTracingcompatible implementation.

It contains auto-configurations which instruments and trace following Spring Boot projects:

• Spring Web (RestControllers, RestTemplates, WebAsyncTask, WebClient, WebFlux)
• @Async, @Scheduled, Executors
• WebSocket STOMP
• Feign, HystrixFeign
• Hystrix
• JMS
• JDBC
• Kafka
• Mongo
• Zuul
• Reactor
• RxJava
• Redis
• Standard logging - logs are added to active span
• Spring Messaging - trace messages being sent throughMessaging Channels
• RabbitMQ

The following table shows versions with compatibleSpring Cloud releases.

This project is similar tospring-cloud-sleuth,both provide out of the box tracing solution for Spring Boot/Cloud. Some of the instrumentations in thispackage are based on originalsleuth work.

However there are a couple of differences:

• OpenTracing support insleuth is limited to only one tracer implementation -brave-opentracing. In other words it's not possible to use arbitrary OpenTracing tracer withsleuth.
• sleuth might support different set of instrumentations.
• Instrumentations insleuth might add different set of tags and logs to represent the same events.

It's worth noting that the although OpenTracing Spring Cloud contains code for instrumenting a wealth of Spring projects,it however does not pull those dependencies automatically, marking them as optional dependencies instead.

That means that for example a simple Spring Boot REST API application can include OpenTracing Spring Cloud without the fearof polluting the classpath with Spring Cloud dependencies that are otherwise unneeded

The preferred way to use this library is via vendored starters. These starters useinstrumentations from this library and expose specific tracer configuration in Springnative way:

• Jaeger
• Zipkin

Just add the following dependency in your pom.xml:

<dependency>  <groupId>io.opentracing.contrib</groupId>  <artifactId>opentracing-spring-cloud-starter</artifactId></dependency>

, and provide OpenTracing tracer bean:

@Beanpublicio.opentracing.Tracertracer() {returnnew// tracer instance of your choice (Zipkin, Jaeger, LightStep)}

Maven checkstyle plugin is used to maintain consistent code style based onGoogle Style Guides

./mvnw clean installmake // to run tests including dependency tests, a specific profile can be specified by make PROFILES=nodeps

Follow instructions inRELEASE

Apache 2.0 License.