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

Added docs explaining how to work with @Async and new spans

Browse Source 
fixes gh-1738
This commit is contained in:
Marcin Grzejszczak
2020-12-11 12:13:04 +01:00
parent 0f458b03ee
commit d0d462a8bf
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/src/main/asciidoc/spring-cloud-sleuth.adoc
View File

@@ -1390,12 +1390,15 @@ https://github.com/yidongnan/grpc-spring-boot-starter[Grpc Spring Boot Starter]
In Spring Cloud Sleuth, we instrument async-related components so that the tracing information is passed between threads.
You can disable this behavior by setting the value of `spring.sleuth.async.enabled` to `false`.
If you annotate your method with `@Async`, we automatically create a new Span with the following characteristics:
If you annotate your method with `@Async`, we automatically modify the existing Span as follows:
* If the method is annotated with `@SpanName`, the value of the annotation is the Span's name.
* If the method is not annotated with `@SpanName`, the Span name is the annotated method name.
* The span is tagged with the method's class name and method name.
Since we're modifying the existing span, if you want to maintain its original name (e.g. a span created by receiving an HTTP request)
you should wrap your `@Async` annotated method with a `@NewSpan` annotation or create a new span manually.
==== `@Scheduled` Annotated Methods
In Spring Cloud Sleuth, we instrument scheduled method execution so that the tracing information is passed between threads.