Sync docs from v2.2.3.RELEASE to gh-pages
This commit is contained in:
@@ -278,7 +278,7 @@ Subtracting the <code>cs</code> timestamp from this timestamp reveals the whole
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/trace-id.png" alt="Trace Info propagation">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/trace-id.png" alt="Trace Info propagation">
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
@@ -301,7 +301,7 @@ Also, the <code>Client Sent</code> event took place.</p>
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/parents.png" alt="Parent child relationship">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/parents.png" alt="Parent child relationship">
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -318,7 +318,7 @@ If you go to traces in Zipkin, you can see this number in the second trace, as s
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/zipkin-traces.png" alt="Traces">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/zipkin-traces.png" alt="Traces">
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
@@ -326,7 +326,7 @@ If you go to traces in Zipkin, you can see this number in the second trace, as s
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/zipkin-ui.png" alt="Traces Info propagation">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/zipkin-ui.png" alt="Traces Info propagation">
|
||||
</div>
|
||||
</div>
|
||||
<div class="admonitionblock note">
|
||||
@@ -391,7 +391,7 @@ You could see in the list of traces one trace that is red. That appears because
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/zipkin-error-traces.png" alt="Error Traces">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/zipkin-error-traces.png" alt="Error Traces">
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
@@ -399,7 +399,7 @@ You could see in the list of traces one trace that is red. That appears because
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/zipkin-error-trace-screenshot.png" alt="Error Traces Info propagation">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/zipkin-error-trace-screenshot.png" alt="Error Traces Info propagation">
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
@@ -421,7 +421,7 @@ However, if you want to use the legacy Sleuth approaches, you can set the <code>
|
||||
<h4 id="_live_examples"><a class="link" href="#_live_examples">Live examples</a></h4>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<a class="image" href="https://docssleuth-zipkin-server.cfapps.io/"><img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/pws.png" alt="Zipkin deployed on Pivotal Web Services" width="150" height="74"></a>
|
||||
<a class="image" href="https://docssleuth-zipkin-server.cfapps.io/"><img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/pws.png" alt="Zipkin deployed on Pivotal Web Services" width="150" height="74"></a>
|
||||
</div>
|
||||
<div class="title">Click the Pivotal Web Services icon to see it live!Click the Pivotal Web Services icon to see it live!</div>
|
||||
</div>
|
||||
@@ -433,12 +433,12 @@ However, if you want to use the legacy Sleuth approaches, you can set the <code>
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/dependencies.png" alt="Dependencies">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/dependencies.png" alt="Dependencies">
|
||||
</div>
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<a class="image" href="https://docssleuth-zipkin-server.cfapps.io/dependency"><img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/pws.png" alt="Zipkin deployed on Pivotal Web Services" width="150" height="74"></a>
|
||||
<a class="image" href="https://docssleuth-zipkin-server.cfapps.io/dependency"><img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/pws.png" alt="Zipkin deployed on Pivotal Web Services" width="150" height="74"></a>
|
||||
</div>
|
||||
<div class="title">Click the Pivotal Web Services icon to see it live!Click the Pivotal Web Services icon to see it live!</div>
|
||||
</div>
|
||||
@@ -468,7 +468,7 @@ An example from Kibana would resemble the following image:</p>
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/kibana.png" alt="Log correlation with Kibana">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/kibana.png" alt="Log correlation with Kibana">
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
|
||||
@@ -211,8 +211,8 @@ Also, you can define your own properties.
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.sleuth.integration.patterns</p></td>
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">[!hystrixStreamOutput*, *]</p></td>
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">An array of patterns against which channel names will be matched. @see org.springframework.integration.config.GlobalChannelInterceptor#patterns() Defaults to any channel name not matching the Hystrix Stream channel name.</p></td>
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">[!hystrixStreamOutput*, <strong>, !channel</strong>]</p></td>
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">An array of patterns against which channel names will be matched. @see org.springframework.integration.config.GlobalChannelInterceptor#patterns() Defaults to any channel name not matching the Hystrix Stream and functional Stream channel names.</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.sleuth.integration.websockets.enabled</p></td>
|
||||
@@ -297,7 +297,7 @@ Also, you can define your own properties.
|
||||
<tr>
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.sleuth.propagation.tag.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">Enables a {@link TagPropagationSpanHandler} that adds extra propagated fields to span tags.</p></td>
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables a {@link TagPropagationFinishedSpanHandler} that adds extra propagated fields to span tags.</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.sleuth.propagation.tag.whitelisted-keys</p></td>
|
||||
@@ -325,6 +325,11 @@ Also, you can define your own properties.
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">Service name for the remote Redis endpoint.</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.sleuth.rpc.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 tracing of RPC.</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.sleuth.rxjava.schedulers.hook.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 support for RxJava via RxJavaSchedulersHook.</p></td>
|
||||
|
||||
@@ -270,7 +270,7 @@ Subtracting the <code>cs</code> timestamp from this timestamp reveals the whole
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/trace-id.png" alt="Trace Info propagation">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/trace-id.png" alt="Trace Info propagation">
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
@@ -293,7 +293,7 @@ Also, the <code>Client Sent</code> event took place.</p>
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/parents.png" alt="Parent child relationship">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/parents.png" alt="Parent child relationship">
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -310,7 +310,7 @@ If you go to traces in Zipkin, you can see this number in the second trace, as s
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/zipkin-traces.png" alt="Traces">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/zipkin-traces.png" alt="Traces">
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
@@ -318,7 +318,7 @@ If you go to traces in Zipkin, you can see this number in the second trace, as s
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/zipkin-ui.png" alt="Traces Info propagation">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/zipkin-ui.png" alt="Traces Info propagation">
|
||||
</div>
|
||||
</div>
|
||||
<div class="admonitionblock note">
|
||||
@@ -383,7 +383,7 @@ You could see in the list of traces one trace that is red. That appears because
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/zipkin-error-traces.png" alt="Error Traces">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/zipkin-error-traces.png" alt="Error Traces">
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
@@ -391,7 +391,7 @@ You could see in the list of traces one trace that is red. That appears because
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/zipkin-error-trace-screenshot.png" alt="Error Traces Info propagation">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/zipkin-error-trace-screenshot.png" alt="Error Traces Info propagation">
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
@@ -413,7 +413,7 @@ However, if you want to use the legacy Sleuth approaches, you can set the <code>
|
||||
<h4 id="live-examples"><a class="anchor" href="#live-examples"></a><a class="link" href="#live-examples">1.2.4. Live examples</a></h4>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<a class="image" href="https://docssleuth-zipkin-server.cfapps.io/"><img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/pws.png" alt="Zipkin deployed on Pivotal Web Services" width="150" height="74"></a>
|
||||
<a class="image" href="https://docssleuth-zipkin-server.cfapps.io/"><img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/pws.png" alt="Zipkin deployed on Pivotal Web Services" width="150" height="74"></a>
|
||||
</div>
|
||||
<div class="title">Click the Pivotal Web Services icon to see it live!Click the Pivotal Web Services icon to see it live!</div>
|
||||
</div>
|
||||
@@ -425,12 +425,12 @@ However, if you want to use the legacy Sleuth approaches, you can set the <code>
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/dependencies.png" alt="Dependencies">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/dependencies.png" alt="Dependencies">
|
||||
</div>
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<a class="image" href="https://docssleuth-zipkin-server.cfapps.io/dependency"><img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/pws.png" alt="Zipkin deployed on Pivotal Web Services" width="150" height="74"></a>
|
||||
<a class="image" href="https://docssleuth-zipkin-server.cfapps.io/dependency"><img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/pws.png" alt="Zipkin deployed on Pivotal Web Services" width="150" height="74"></a>
|
||||
</div>
|
||||
<div class="title">Click the Pivotal Web Services icon to see it live!Click the Pivotal Web Services icon to see it live!</div>
|
||||
</div>
|
||||
@@ -460,7 +460,7 @@ An example from Kibana would resemble the following image:</p>
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/kibana.png" alt="Log correlation with Kibana">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/kibana.png" alt="Log correlation with Kibana">
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
@@ -1891,17 +1891,35 @@ Doing so forces a new child span on <code>Tracer.joinSpan()</code>.</p>
|
||||
<h4 id="implementing-propagation"><a class="anchor" href="#implementing-propagation"></a><a class="link" href="#implementing-propagation">5.1.4. Implementing Propagation</a></h4>
|
||||
<div class="paragraph">
|
||||
<p><code>TraceContext.Extractor<C></code> is implemented by a <code>Propagation.Factory</code> plugin.
|
||||
Internally, this code creates the union type, <code>TraceContextOrSamplingFlags</code>, with one of the following:
|
||||
* <code>TraceContext</code> if trace and span IDs were present.
|
||||
* <code>TraceIdContext</code> if a trace ID was present but span IDs were not present.
|
||||
* <code>SamplingFlags</code> if no identifiers were present.</p>
|
||||
Internally, this code creates the union type, <code>TraceContextOrSamplingFlags</code>, with one of the following:</p>
|
||||
</div>
|
||||
<div class="ulist">
|
||||
<ul>
|
||||
<li>
|
||||
<p><code>TraceContext</code> if trace and span IDs were present.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>TraceIdContext</code> if a trace ID was present but span IDs were not present.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>SamplingFlags</code> if no identifiers were present.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>Some <code>Propagation</code> implementations carry extra data from the point of extraction (for example, reading incoming headers) to injection (for example, writing outgoing headers).
|
||||
For example, it might carry a request ID.
|
||||
When implementations have extra data, they handle it as follows:
|
||||
* If a <code>TraceContext</code> were extracted, add the extra data as <code>TraceContext.extra()</code>.
|
||||
* Otherwise, add it as <code>TraceContextOrSamplingFlags.extra()</code>, which <code>Tracer.nextSpan</code> handles.</p>
|
||||
When implementations have extra data, they handle it as follows:</p>
|
||||
</div>
|
||||
<div class="ulist">
|
||||
<ul>
|
||||
<li>
|
||||
<p>If a <code>TraceContext</code> were extracted, add the extra data as <code>TraceContext.extra()</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Otherwise, add it as <code>TraceContextOrSamplingFlags.extra()</code>, which <code>Tracer.nextSpan</code> handles.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -178,7 +178,7 @@ Subtracting the <code>cs</code> timestamp from this timestamp reveals the whole
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/trace-id.png" alt="Trace Info propagation">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/trace-id.png" alt="Trace Info propagation">
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
@@ -201,7 +201,7 @@ Also, the <code>Client Sent</code> event took place.</p>
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/parents.png" alt="Parent child relationship">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/parents.png" alt="Parent child relationship">
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -218,7 +218,7 @@ If you go to traces in Zipkin, you can see this number in the second trace, as s
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/zipkin-traces.png" alt="Traces">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/zipkin-traces.png" alt="Traces">
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
@@ -226,7 +226,7 @@ If you go to traces in Zipkin, you can see this number in the second trace, as s
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/zipkin-ui.png" alt="Traces Info propagation">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/zipkin-ui.png" alt="Traces Info propagation">
|
||||
</div>
|
||||
</div>
|
||||
<div class="admonitionblock note">
|
||||
@@ -291,7 +291,7 @@ You could see in the list of traces one trace that is red. That appears because
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/zipkin-error-traces.png" alt="Error Traces">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/zipkin-error-traces.png" alt="Error Traces">
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
@@ -299,7 +299,7 @@ You could see in the list of traces one trace that is red. That appears because
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/zipkin-error-trace-screenshot.png" alt="Error Traces Info propagation">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/zipkin-error-trace-screenshot.png" alt="Error Traces Info propagation">
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
@@ -321,7 +321,7 @@ However, if you want to use the legacy Sleuth approaches, you can set the <code>
|
||||
<h4 id="_live_examples"><a class="link" href="#_live_examples">Live examples</a></h4>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<a class="image" href="https://docssleuth-zipkin-server.cfapps.io/"><img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/pws.png" alt="Zipkin deployed on Pivotal Web Services" width="150" height="74"></a>
|
||||
<a class="image" href="https://docssleuth-zipkin-server.cfapps.io/"><img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/pws.png" alt="Zipkin deployed on Pivotal Web Services" width="150" height="74"></a>
|
||||
</div>
|
||||
<div class="title">Click the Pivotal Web Services icon to see it live!Click the Pivotal Web Services icon to see it live!</div>
|
||||
</div>
|
||||
@@ -333,12 +333,12 @@ However, if you want to use the legacy Sleuth approaches, you can set the <code>
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/dependencies.png" alt="Dependencies">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/dependencies.png" alt="Dependencies">
|
||||
</div>
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<a class="image" href="https://docssleuth-zipkin-server.cfapps.io/dependency"><img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/pws.png" alt="Zipkin deployed on Pivotal Web Services" width="150" height="74"></a>
|
||||
<a class="image" href="https://docssleuth-zipkin-server.cfapps.io/dependency"><img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/pws.png" alt="Zipkin deployed on Pivotal Web Services" width="150" height="74"></a>
|
||||
</div>
|
||||
<div class="title">Click the Pivotal Web Services icon to see it live!Click the Pivotal Web Services icon to see it live!</div>
|
||||
</div>
|
||||
@@ -368,7 +368,7 @@ An example from Kibana would resemble the following image:</p>
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/kibana.png" alt="Log correlation with Kibana">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/kibana.png" alt="Log correlation with Kibana">
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
|
||||
@@ -270,7 +270,7 @@ Subtracting the <code>cs</code> timestamp from this timestamp reveals the whole
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/trace-id.png" alt="Trace Info propagation">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/trace-id.png" alt="Trace Info propagation">
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
@@ -293,7 +293,7 @@ Also, the <code>Client Sent</code> event took place.</p>
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/parents.png" alt="Parent child relationship">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/parents.png" alt="Parent child relationship">
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -310,7 +310,7 @@ If you go to traces in Zipkin, you can see this number in the second trace, as s
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/zipkin-traces.png" alt="Traces">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/zipkin-traces.png" alt="Traces">
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
@@ -318,7 +318,7 @@ If you go to traces in Zipkin, you can see this number in the second trace, as s
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/zipkin-ui.png" alt="Traces Info propagation">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/zipkin-ui.png" alt="Traces Info propagation">
|
||||
</div>
|
||||
</div>
|
||||
<div class="admonitionblock note">
|
||||
@@ -383,7 +383,7 @@ You could see in the list of traces one trace that is red. That appears because
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/zipkin-error-traces.png" alt="Error Traces">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/zipkin-error-traces.png" alt="Error Traces">
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
@@ -391,7 +391,7 @@ You could see in the list of traces one trace that is red. That appears because
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/zipkin-error-trace-screenshot.png" alt="Error Traces Info propagation">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/zipkin-error-trace-screenshot.png" alt="Error Traces Info propagation">
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
@@ -413,7 +413,7 @@ However, if you want to use the legacy Sleuth approaches, you can set the <code>
|
||||
<h4 id="live-examples"><a class="anchor" href="#live-examples"></a><a class="link" href="#live-examples">1.2.4. Live examples</a></h4>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<a class="image" href="https://docssleuth-zipkin-server.cfapps.io/"><img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/pws.png" alt="Zipkin deployed on Pivotal Web Services" width="150" height="74"></a>
|
||||
<a class="image" href="https://docssleuth-zipkin-server.cfapps.io/"><img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/pws.png" alt="Zipkin deployed on Pivotal Web Services" width="150" height="74"></a>
|
||||
</div>
|
||||
<div class="title">Click the Pivotal Web Services icon to see it live!Click the Pivotal Web Services icon to see it live!</div>
|
||||
</div>
|
||||
@@ -425,12 +425,12 @@ However, if you want to use the legacy Sleuth approaches, you can set the <code>
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/dependencies.png" alt="Dependencies">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/dependencies.png" alt="Dependencies">
|
||||
</div>
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<a class="image" href="https://docssleuth-zipkin-server.cfapps.io/dependency"><img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/pws.png" alt="Zipkin deployed on Pivotal Web Services" width="150" height="74"></a>
|
||||
<a class="image" href="https://docssleuth-zipkin-server.cfapps.io/dependency"><img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/pws.png" alt="Zipkin deployed on Pivotal Web Services" width="150" height="74"></a>
|
||||
</div>
|
||||
<div class="title">Click the Pivotal Web Services icon to see it live!Click the Pivotal Web Services icon to see it live!</div>
|
||||
</div>
|
||||
@@ -460,7 +460,7 @@ An example from Kibana would resemble the following image:</p>
|
||||
</div>
|
||||
<div class="imageblock">
|
||||
<div class="content">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/docs/src/main/asciidoc/images/kibana.png" alt="Log correlation with Kibana">
|
||||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/2.2.x/docs/src/main/asciidoc/images/kibana.png" alt="Log correlation with Kibana">
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
@@ -1891,17 +1891,35 @@ Doing so forces a new child span on <code>Tracer.joinSpan()</code>.</p>
|
||||
<h4 id="implementing-propagation"><a class="anchor" href="#implementing-propagation"></a><a class="link" href="#implementing-propagation">5.1.4. Implementing Propagation</a></h4>
|
||||
<div class="paragraph">
|
||||
<p><code>TraceContext.Extractor<C></code> is implemented by a <code>Propagation.Factory</code> plugin.
|
||||
Internally, this code creates the union type, <code>TraceContextOrSamplingFlags</code>, with one of the following:
|
||||
* <code>TraceContext</code> if trace and span IDs were present.
|
||||
* <code>TraceIdContext</code> if a trace ID was present but span IDs were not present.
|
||||
* <code>SamplingFlags</code> if no identifiers were present.</p>
|
||||
Internally, this code creates the union type, <code>TraceContextOrSamplingFlags</code>, with one of the following:</p>
|
||||
</div>
|
||||
<div class="ulist">
|
||||
<ul>
|
||||
<li>
|
||||
<p><code>TraceContext</code> if trace and span IDs were present.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>TraceIdContext</code> if a trace ID was present but span IDs were not present.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>SamplingFlags</code> if no identifiers were present.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>Some <code>Propagation</code> implementations carry extra data from the point of extraction (for example, reading incoming headers) to injection (for example, writing outgoing headers).
|
||||
For example, it might carry a request ID.
|
||||
When implementations have extra data, they handle it as follows:
|
||||
* If a <code>TraceContext</code> were extracted, add the extra data as <code>TraceContext.extra()</code>.
|
||||
* Otherwise, add it as <code>TraceContextOrSamplingFlags.extra()</code>, which <code>Tracer.nextSpan</code> handles.</p>
|
||||
When implementations have extra data, they handle it as follows:</p>
|
||||
</div>
|
||||
<div class="ulist">
|
||||
<ul>
|
||||
<li>
|
||||
<p>If a <code>TraceContext</code> were extracted, add the extra data as <code>TraceContext.extra()</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Otherwise, add it as <code>TraceContextOrSamplingFlags.extra()</code>, which <code>Tracer.nextSpan</code> handles.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user