spring-cloud-sleuth

Files

Adrian Cole b92db4ce51 Stops propagating Sleuth 1.x spring-messaging headers

To reduce confusion and overhead, the following custom spring-messaging headers added in Sleuth 1.0 are no longer sent, and a log warning is issued once if they are by outside code.

* spanId
* spanSampled
* spanParentSpanId
* spanTraceId
* spanFlags

Sending the above headers actually increases the headers by up to 10 because they are duplicated in the "native" part of messages. This overhead is extreme especially if messages never leave the process.

The solution is to only send [b3 single format](https://github.com/openzipkin/b3-propagation#single-header), which has been in sleuth since 2.0 and is compatible with JMS. The B3 single format is always parsed and takes precedence, even if multiple headers are sent, so this is a safe change.

Note: Unlike RPC, messaging spans never join with their parent. Better performance is achieved by not propagating the producer's parentId downstream.

Note: Deprecated spring-messaging headers such "spanTraceId" as are still read in Sleuth 3.x. However, they will not be at some point in the future. Please pay attention to the log messages and update your code if you are accidentally using them.

2020-04-07 10:58:49 +08:00

spring-cloud-sleuth-sample

Bumping versions to 2.2.3.BUILD-SNAPSHOT after release

2020-03-04 16:59:42 +00:00

spring-cloud-sleuth-sample-feign

Merge branch '2.2.x'

2020-04-04 14:39:36 +08:00

spring-cloud-sleuth-sample-messaging

Bumping versions to 2.2.3.BUILD-SNAPSHOT after release

2020-03-04 16:59:42 +00:00

spring-cloud-sleuth-sample-test-core

Stops propagating Sleuth 1.x spring-messaging headers

2020-04-07 10:58:49 +08:00

spring-cloud-sleuth-sample-websocket

Bumping versions to 2.2.3.BUILD-SNAPSHOT after release

2020-03-04 16:59:42 +00:00

spring-cloud-sleuth-sample-zipkin

Bumping versions to 2.2.3.BUILD-SNAPSHOT after release

2020-03-04 16:59:42 +00:00

pom.xml

Bumping versions to 2.2.3.BUILD-SNAPSHOT after release

2020-03-04 16:59:42 +00:00

README.adoc

Merge branch '2.2.x'

2020-04-04 14:39:36 +08:00

README.adoc

== Spring Cloud Sleuth Samples

=== Running the samples

There are a few samples with slightly different features. You can run all of them from an IDE via the main method, or on the command line with `mvn spring-boot:run`. They all log trace and span data on the console by default. Here's a list:

* `spring-cloud-sleuth-sample`: vanilla (no zipkin) web app that calls back to itself on various endpoints ("/", "/call", "/async")

* `spring-cloud-sleuth-sample-zipkin`: same as vanilla sample but with zipkin (set `sample.zipkin.enabled=true` if you have a collector running)

* `spring-cloud-sleuth-sample-messaging`: a Spring Integration application with two HTTP endpoints ("/" and "/xform")

=== Running samples with Zipkin

1. Optionally run the https://github.com/openzipkin/zipkin[Zipkin] Server, e.g. via docker compose (there's a `docker-compose.yml` in https://github.com/spring-cloud/spring-cloud-sleuth-samples/spring-cloud-sleuth-sample-zipkin[Spring Cloud Sleuth], or in https://github.com/openzipkin/docker-zipkin[Docker Zipkin]
7. Run the zipkin sample application (set `sample.zipkin.enabled=false` if you have no Zipkin running). If you are using a VM to run docker you might need to tunnel port 9411 to localhost, or change the `spring.zipkin.baseUrl`.
8. Hit `http://localhost:3380`, `http://localhost:3380/call`, `http://localhost:3380/async` for some interesting sample traces (the app callas back to itself).
9. Go to `http://localhost:9411` for Zipkin's UI (if you are using boot2docker the host will be different)

NOTE: You can see the zipkin spans without the UI (in logs) if you run the sample with `sample.zipkin.enabled=false`.

image::{github-raw}/docs/src/main/asciidoc/images/zipkin-trace-screenshot.png[Sample Zipkin Screenshot]

> The fact that the first trace in says "testSleuthMessaging" seems to be a bug in the UI (it has some annotations from that service, but it originates in the "testSleuthMessaging" service).