Fixed javadocs

This commit is contained in:
Marcin Grzejszczak
2020-03-30 14:52:24 +02:00
parent ec1ada24b1
commit e7a84d5a13
8 changed files with 36 additions and 54 deletions

View File

@@ -23,21 +23,15 @@ import org.springframework.core.annotation.AnnotationUtils;
/**
* Default implementation of SpanNamer that tries to get the span name as follows:
*
* <li>
* <ul>
* from the @SpanName annotation on the class if one is present.
* </ul>
* <ul>
* from the @SpanName annotation on the method if passed object is of a {@link Method}.
* * from the @SpanName annotation on the class if one is present.
*
* * from the @SpanName annotation on the method if passed object is of a {@link Method}.
* type
* </ul>
* <ul>
* from the toString() of the delegate if it's not the default {@link Object#toString()}.
* </ul>
* <ul>
* the default provided value.
* </ul>
* </li>
*
* * from the toString() of the delegate if it's not the default
* {@link Object#toString()}.
*
* * the default provided value.
*
* @author Marcin Grzejszczak
* @since 1.0.0

View File

@@ -28,12 +28,9 @@ import org.springframework.core.annotation.AliasFor;
* There are 3 different ways to add tags to a span. All of them are controlled by the
* annotation values. Precedence is:
*
* <ul>
* <li>try with the {@link TagValueResolver} bean</li>
* <li>if the value of the bean wasn't set, try to evaluate a SPEL expression</li>
* <li>if theres no SPEL expression just return a {@code toString()} value of the
* parameter</li>
* </ul>
* try with the {@link TagValueResolver} bean if the value of the bean wasn't set, try to
* evaluate a SPEL expression if theres no SPEL expression just return a
* {@code toString()} value of the parameter
*
* @author Christian Schwerdtfeger
* @since 1.2.0

View File

@@ -27,10 +27,8 @@ import org.springframework.core.env.MutablePropertySources;
import org.springframework.core.env.PropertySource;
/**
* Adds default properties for the application:
* <ul>
* <li>logging pattern level that prints trace information (e.g. trace ids)</li>
* </ul>
* Adds default properties for the application: logging pattern level that prints trace
* information (e.g. trace ids).
*
* @author Dave Syer
* @author Marcin Grzejszczak

View File

@@ -50,12 +50,10 @@ import org.springframework.util.ClassUtils;
* native headers. It also extracts or creates a {@link Span.Kind#CONSUMER} span for each
* message received. This span is injected onto each message so it becomes the parent when
* a handler later calls {@link MessageHandler#handleMessage(Message)}, or a another
* processing library calls {@link #nextSpan(Message)}.
* <p>
* <p>
* This implementation uses {@link ThreadLocalSpan} to propagate context between
* callbacks. This is an alternative to {@code ThreadStatePropagationChannelInterceptor}
* which is less sensitive to message manipulation by other interceptors.
* processing library calls {@link #nextSpan(Message)}. This implementation uses
* {@link ThreadLocalSpan} to propagate context between callbacks. This is an alternative
* to {@code ThreadStatePropagationChannelInterceptor} which is less sensitive to message
* manipulation by other interceptors.
*
* @author Marcin Grzejszczak
*/

View File

@@ -33,18 +33,18 @@ import org.springframework.web.context.request.async.WebAsyncTask;
/**
* Aspect that adds tracing to
* <p/>
* <ul>
* <li>{@code RestController} annotated classes with public {@link Callable} methods</li>
* <li>{@link org.springframework.stereotype.Controller} annotated classes with public
* {@link Callable} methods</li>
* <li>{@link org.springframework.stereotype.Controller} or {@code RestController}
* annotated classes with public {@link WebAsyncTask} methods</li>
* </ul>
* <p/>
* <p>
* </p>
* {@code RestController} annotated classes with public {@link Callable} methods
* {@link org.springframework.stereotype.Controller} annotated classes with public
* {@link Callable} methods {@link org.springframework.stereotype.Controller} or
* {@code RestController} annotated classes with public {@link WebAsyncTask} methods
* <p>
* </p>
* For controllers an around aspect is created that wraps the {@link Callable#call()}
* method execution in {@link TraceCallable}
* <p/>
* <p>
* </p>
*
* This aspect will continue a span created by the TracingFilter. It will not create a new
* span - since the one in TracingFilter will wait until processing has been finished

View File

@@ -32,8 +32,7 @@ import org.springframework.cloud.client.loadbalancer.LoadBalancerClient;
import org.springframework.cloud.openfeign.loadbalancer.FeignBlockingLoadBalancerClient;
/**
* A trace representation of {@link FeignBlockingLoadBalancerClient}. Needed due to casts
* in {@link org.springframework.cloud.openfeign.FeignClientFactoryBean}.
* A trace representation of {@link FeignBlockingLoadBalancerClient}.
*
* @author Olga Maciaszek-Sharma
* @since 2.2.0

View File

@@ -26,15 +26,14 @@ import org.springframework.util.Assert;
/**
* This sampler is appropriate for low-traffic instrumentation (ex servers that each
* receive <100K requests), or those who do not provision random trace ids. It not
* appropriate for collectors as the sampling decision isn't idempotent (consistent based
* on trace id).
* receive less than 100K requests), or those who do not provision random trace ids. It
* not appropriate for collectors as the sampling decision isn't idempotent (consistent
* based on trace id).
*
* <h3>Implementation</h3>
*
* <p>
* Taken from <a href= "https://github.com/openzipkin/zipkin-java/blob/traceid-sampler/
* zipkin/src/main/java/zipkin/CountingTraceIdSampler.java">Zipkin project</a>
* Taken from CountingTraceIdSampler class from Zipkin project.
* </p>
*
* <p>

View File

@@ -32,13 +32,10 @@ import org.springframework.core.env.Environment;
import org.springframework.util.StringUtils;
/**
* {@link EndpointLocator} implementation that.
*
* <ul>
* <li><b>serviceName</b> - from {@link ServerProperties} or {@link Registration}</li>
* <li><b>ip</b> - from {@link ServerProperties}</li>
* <li><b>port</b> - from lazily assigned port or {@link ServerProperties}</li>
* </ul>
* {@link EndpointLocator} implementation that. <b>serviceName</b> - from
* {@link ServerProperties} or {@link Registration} <b>ip</b> - from
* {@link ServerProperties} <b>port</b> - from lazily assigned port or
* {@link ServerProperties}
*
* You can override the name using {@link ZipkinProperties.Service#setName(String)}
*