diff --git a/docs/src/main/asciidoc/spring-cloud-sleuth.adoc b/docs/src/main/asciidoc/spring-cloud-sleuth.adoc index 77e151532..763edb211 100644 --- a/docs/src/main/asciidoc/spring-cloud-sleuth.adoc +++ b/docs/src/main/asciidoc/spring-cloud-sleuth.adoc @@ -329,6 +329,9 @@ SpanAdjuster customSpanAdjuster() { This will lead in changing the name of the reported span just before it gets sent to Zipkin. +IMPORTANT: Your `SpanReporter` should inject the `SpanAdjuster` and + allow span manipulation before the actual reporting is done. + === Host locator In order to define the host that is corresponding to a particular span we need to resolve the host name diff --git a/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/SpanAdjuster.java b/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/SpanAdjuster.java index e9d938215..a5d1ecc77 100644 --- a/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/SpanAdjuster.java +++ b/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/SpanAdjuster.java @@ -19,6 +19,9 @@ package org.springframework.cloud.sleuth; /** * Adds ability to adjust a span before reporting it. * + * IMPORTANT: Your {@link SpanReporter} should inject the {@link SpanAdjuster} and + * allow {@link Span} manipulation before the actual reporting is done. + * * @author Marcin Grzejszczak * @since 1.1.4 */ diff --git a/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/SpanReporter.java b/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/SpanReporter.java index a72170c79..6eec0c092 100644 --- a/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/SpanReporter.java +++ b/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/SpanReporter.java @@ -19,6 +19,9 @@ package org.springframework.cloud.sleuth; /** * Contract for reporting Sleuth spans for collection. For example to Zipkin. * + * IMPORTANT: Your {@link SpanReporter} should inject the {@link SpanAdjuster} and + * allow {@link Span} manipulation before the actual reporting is done. + * * @author Marcin Grzejszczak * @since 1.0.0 */