Sync docs from master to gh-pages
This commit is contained in:
buildmaster
@@ -1177,7 +1177,7 @@ To that end, Sleuth:</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<p>Instruments common ingress and egress points from Spring applications (servlet filter, async endpoints, rest template, scheduled actions, message channels, Zuul filters, and Feign client).</p>
|
||||
<p>Instruments common ingress and egress points from Spring applications (servlet filter, async endpoints, rest template, scheduled actions, message channels, and Feign client).</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Sleuth includes default logic to join a trace across HTTP or messaging boundaries.
|
||||
|
||||
@@ -350,7 +350,7 @@ Also, you can define your own properties.
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.sleuth.scheduled.skip-pattern</p></td>
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">org.springframework.cloud.netflix.hystrix.stream.HystrixStreamTask</p></td>
|
||||
<td class="tableblock halign-left valign-top"></td>
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">Pattern for the fully qualified name of a class that should be skipped.</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -409,11 +409,6 @@ Also, you can define your own properties.
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">Pattern for URLs that should be skipped in tracing.</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.sleuth.zuul.enabled</p></td>
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">Enable span information propagation when using Zuul.</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.zipkin.activemq.message-max-bytes</p></td>
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">100000</p></td>
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">Maximum number of bytes for a given message with spans sent to Zipkin over ActiveMQ.</p></td>
|
||||
|
||||
@@ -184,7 +184,7 @@ To that end, Sleuth:</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<p>Instruments common ingress and egress points from Spring applications (servlet filter, async endpoints, rest template, scheduled actions, message channels, Zuul filters, and Feign client).</p>
|
||||
<p>Instruments common ingress and egress points from Spring applications (servlet filter, async endpoints, rest template, scheduled actions, message channels, and Feign client).</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Sleuth includes default logic to join a trace across HTTP or messaging boundaries.
|
||||
|
||||
@@ -199,10 +199,9 @@ $(globalSwitch);
|
||||
<li><a href="#grpc">15.8. gRPC</a></li>
|
||||
<li><a href="#asynchronous-communication">15.9. Asynchronous Communication</a></li>
|
||||
<li><a href="#messaging-2">15.10. Messaging</a></li>
|
||||
<li><a href="#zuul">15.11. Zuul</a></li>
|
||||
<li><a href="#redis">15.12. Redis</a></li>
|
||||
<li><a href="#quartz">15.13. Quartz</a></li>
|
||||
<li><a href="#project-reactor">15.14. Project Reactor</a></li>
|
||||
<li><a href="#redis">15.11. Redis</a></li>
|
||||
<li><a href="#quartz">15.12. Quartz</a></li>
|
||||
<li><a href="#project-reactor">15.13. Project Reactor</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#configuration-properties">16. Configuration properties</a></li>
|
||||
@@ -1168,7 +1167,7 @@ To that end, Sleuth:</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<p>Instruments common ingress and egress points from Spring applications (servlet filter, async endpoints, rest template, scheduled actions, message channels, Zuul filters, and Feign client).</p>
|
||||
<p>Instruments common ingress and egress points from Spring applications (servlet filter, async endpoints, rest template, scheduled actions, message channels, and Feign client).</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Sleuth includes default logic to join a trace across HTTP or messaging boundaries.
|
||||
@@ -2155,10 +2154,6 @@ situation might be as follows:</p>
|
||||
<li>
|
||||
<p><strong>AOP</strong>: If there was already a span created before an aspect was reached, you might not want to create a new span.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>Hystrix</strong>: Executing a Hystrix command is most likely a logical part of the current processing.
|
||||
It is in fact merely a technical implementation detail that you would not necessarily want to reflect in tracing as a separate being.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
@@ -3441,9 +3436,7 @@ You can disable this behavior by setting the value of <code>spring.sleuth.schedu
|
||||
</ul>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>If you want to skip span creation for some <code>@Scheduled</code> annotated classes, you can set the <code>spring.sleuth.scheduled.skipPattern</code> with a regular expression that matches the fully qualified name of the <code>@Scheduled</code> annotated class.
|
||||
If you use <code>spring-cloud-sleuth-stream</code> and <code>spring-cloud-netflix-hystrix-stream</code> together, a span is created for each Hystrix metrics and sent to Zipkin.
|
||||
This behavior may be annoying. That’s why, by default, <code>spring.sleuth.scheduled.skipPattern=org.springframework.cloud.netflix.hystrix.stream.HystrixStreamTask</code>.</p>
|
||||
<p>If you want to skip span creation for some <code>@Scheduled</code> annotated classes, you can set the <code>spring.sleuth.scheduled.skipPattern</code> with a regular expression that matches the fully qualified name of the <code>@Scheduled</code> annotated class.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect3">
|
||||
@@ -3644,21 +3637,14 @@ so that tracing headers get extracted from the message and a trace gets put into
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect2">
|
||||
<h3 id="zuul"><a class="anchor" href="#zuul"></a><a class="link" href="#zuul">15.11. Zuul</a></h3>
|
||||
<div class="paragraph">
|
||||
<p>We instrument the Zuul Ribbon integration by enriching the Ribbon requests with tracing information.
|
||||
To disable Zuul support, set the <code>spring.sleuth.zuul.enabled</code> property to <code>false</code>.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect2">
|
||||
<h3 id="redis"><a class="anchor" href="#redis"></a><a class="link" href="#redis">15.12. Redis</a></h3>
|
||||
<h3 id="redis"><a class="anchor" href="#redis"></a><a class="link" href="#redis">15.11. Redis</a></h3>
|
||||
<div class="paragraph">
|
||||
<p>We set <code>tracing</code> property to Lettcue <code>ClientResources</code> instance to enable Brave tracing built in Lettuce .
|
||||
To disable Redis support, set the <code>spring.sleuth.redis.enabled</code> property to <code>false</code>.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect2">
|
||||
<h3 id="quartz"><a class="anchor" href="#quartz"></a><a class="link" href="#quartz">15.13. Quartz</a></h3>
|
||||
<h3 id="quartz"><a class="anchor" href="#quartz"></a><a class="link" href="#quartz">15.12. Quartz</a></h3>
|
||||
<div class="paragraph">
|
||||
<p>We instrument quartz jobs by adding Job/Trigger listeners to the Quartz Scheduler.</p>
|
||||
</div>
|
||||
@@ -3667,7 +3653,7 @@ To disable Redis support, set the <code>spring.sleuth.redis.enabled</code> prope
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect2">
|
||||
<h3 id="project-reactor"><a class="anchor" href="#project-reactor"></a><a class="link" href="#project-reactor">15.14. Project Reactor</a></h3>
|
||||
<h3 id="project-reactor"><a class="anchor" href="#project-reactor"></a><a class="link" href="#project-reactor">15.13. Project Reactor</a></h3>
|
||||
<div class="paragraph">
|
||||
<p>For projects depending on Project Reactor such as Spring Cloud Gateway, we suggest turning the <code>spring.sleuth.reactor.decorate-on-each</code> option to <code>false</code>. That way an increased performance gain should be observed in comparison to the standard instrumentation mechanism. What this option does is it will wrap decorate <code>onLast</code> operator instead of <code>onEach</code> which will result in creation of far fewer objects. The downside of this is that when Project Reactor will change threads, the trace propagation will continue without issues, however anything relying on the <code>ThreadLocal</code> such as e.g. MDC entries can be buggy.</p>
|
||||
</div>
|
||||
|
||||
@@ -144,7 +144,7 @@ $(globalSwitch);
|
||||
<p>Provides an abstraction over common distributed tracing data models: traces, spans (forming a DAG), annotations, key-value annotations. Loosely based on HTrace, but Zipkin (Dapper) compatible.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Instruments common ingress and egress points from Spring applications (servlet filter, rest template, scheduled actions, message channels, zuul filters, feign client).</p>
|
||||
<p>Instruments common ingress and egress points from Spring applications (servlet filter, rest template, scheduled actions, message channels, feign client).</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>If <code>spring-cloud-sleuth-zipkin</code> is available then the app will generate and collect Zipkin-compatible traces via HTTP. By default it sends them to a Zipkin collector service on localhost (port 9411). Configure the location of the service using <code>spring.zipkin.baseUrl</code>.</p>
|
||||
|
||||
@@ -199,10 +199,9 @@ $(globalSwitch);
|
||||
<li><a href="#grpc">15.8. gRPC</a></li>
|
||||
<li><a href="#asynchronous-communication">15.9. Asynchronous Communication</a></li>
|
||||
<li><a href="#messaging-2">15.10. Messaging</a></li>
|
||||
<li><a href="#zuul">15.11. Zuul</a></li>
|
||||
<li><a href="#redis">15.12. Redis</a></li>
|
||||
<li><a href="#quartz">15.13. Quartz</a></li>
|
||||
<li><a href="#project-reactor">15.14. Project Reactor</a></li>
|
||||
<li><a href="#redis">15.11. Redis</a></li>
|
||||
<li><a href="#quartz">15.12. Quartz</a></li>
|
||||
<li><a href="#project-reactor">15.13. Project Reactor</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#configuration-properties">16. Configuration properties</a></li>
|
||||
@@ -1168,7 +1167,7 @@ To that end, Sleuth:</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<p>Instruments common ingress and egress points from Spring applications (servlet filter, async endpoints, rest template, scheduled actions, message channels, Zuul filters, and Feign client).</p>
|
||||
<p>Instruments common ingress and egress points from Spring applications (servlet filter, async endpoints, rest template, scheduled actions, message channels, and Feign client).</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Sleuth includes default logic to join a trace across HTTP or messaging boundaries.
|
||||
@@ -2155,10 +2154,6 @@ situation might be as follows:</p>
|
||||
<li>
|
||||
<p><strong>AOP</strong>: If there was already a span created before an aspect was reached, you might not want to create a new span.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>Hystrix</strong>: Executing a Hystrix command is most likely a logical part of the current processing.
|
||||
It is in fact merely a technical implementation detail that you would not necessarily want to reflect in tracing as a separate being.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
@@ -3441,9 +3436,7 @@ You can disable this behavior by setting the value of <code>spring.sleuth.schedu
|
||||
</ul>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>If you want to skip span creation for some <code>@Scheduled</code> annotated classes, you can set the <code>spring.sleuth.scheduled.skipPattern</code> with a regular expression that matches the fully qualified name of the <code>@Scheduled</code> annotated class.
|
||||
If you use <code>spring-cloud-sleuth-stream</code> and <code>spring-cloud-netflix-hystrix-stream</code> together, a span is created for each Hystrix metrics and sent to Zipkin.
|
||||
This behavior may be annoying. That’s why, by default, <code>spring.sleuth.scheduled.skipPattern=org.springframework.cloud.netflix.hystrix.stream.HystrixStreamTask</code>.</p>
|
||||
<p>If you want to skip span creation for some <code>@Scheduled</code> annotated classes, you can set the <code>spring.sleuth.scheduled.skipPattern</code> with a regular expression that matches the fully qualified name of the <code>@Scheduled</code> annotated class.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect3">
|
||||
@@ -3644,21 +3637,14 @@ so that tracing headers get extracted from the message and a trace gets put into
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect2">
|
||||
<h3 id="zuul"><a class="anchor" href="#zuul"></a><a class="link" href="#zuul">15.11. Zuul</a></h3>
|
||||
<div class="paragraph">
|
||||
<p>We instrument the Zuul Ribbon integration by enriching the Ribbon requests with tracing information.
|
||||
To disable Zuul support, set the <code>spring.sleuth.zuul.enabled</code> property to <code>false</code>.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect2">
|
||||
<h3 id="redis"><a class="anchor" href="#redis"></a><a class="link" href="#redis">15.12. Redis</a></h3>
|
||||
<h3 id="redis"><a class="anchor" href="#redis"></a><a class="link" href="#redis">15.11. Redis</a></h3>
|
||||
<div class="paragraph">
|
||||
<p>We set <code>tracing</code> property to Lettcue <code>ClientResources</code> instance to enable Brave tracing built in Lettuce .
|
||||
To disable Redis support, set the <code>spring.sleuth.redis.enabled</code> property to <code>false</code>.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect2">
|
||||
<h3 id="quartz"><a class="anchor" href="#quartz"></a><a class="link" href="#quartz">15.13. Quartz</a></h3>
|
||||
<h3 id="quartz"><a class="anchor" href="#quartz"></a><a class="link" href="#quartz">15.12. Quartz</a></h3>
|
||||
<div class="paragraph">
|
||||
<p>We instrument quartz jobs by adding Job/Trigger listeners to the Quartz Scheduler.</p>
|
||||
</div>
|
||||
@@ -3667,7 +3653,7 @@ To disable Redis support, set the <code>spring.sleuth.redis.enabled</code> prope
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect2">
|
||||
<h3 id="project-reactor"><a class="anchor" href="#project-reactor"></a><a class="link" href="#project-reactor">15.14. Project Reactor</a></h3>
|
||||
<h3 id="project-reactor"><a class="anchor" href="#project-reactor"></a><a class="link" href="#project-reactor">15.13. Project Reactor</a></h3>
|
||||
<div class="paragraph">
|
||||
<p>For projects depending on Project Reactor such as Spring Cloud Gateway, we suggest turning the <code>spring.sleuth.reactor.decorate-on-each</code> option to <code>false</code>. That way an increased performance gain should be observed in comparison to the standard instrumentation mechanism. What this option does is it will wrap decorate <code>onLast</code> operator instead of <code>onEach</code> which will result in creation of far fewer objects. The downside of this is that when Project Reactor will change threads, the trace propagation will continue without issues, however anything relying on the <code>ThreadLocal</code> such as e.g. MDC entries can be buggy.</p>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user