Adds documentation and javadocs about SpanAdjuster and SpanReporter

fixes #570
This commit is contained in:
Marcin Grzejszczak
2017-04-24 15:17:59 +02:00
parent 115ace8bcc
commit b95ecd5f7e
3 changed files with 9 additions and 0 deletions

View File

@@ -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

View File

@@ -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
*/

View File

@@ -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
*/