From 888437f5b47ccd920396aa3595b43cefec6a4358 Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Mon, 1 Jun 2020 14:40:38 +0200 Subject: [PATCH] Sync docs from v2.2.3.RELEASE to gh-pages --- .../2.2.3.RELEASE/reference/html/README.html | 20 +++---- .../reference/html/appendix.html | 11 ++-- .../2.2.3.RELEASE/reference/html/index.html | 52 +++++++++++++------ .../2.2.3.RELEASE/reference/html/intro.html | 20 +++---- .../reference/html/spring-cloud-sleuth.html | 52 +++++++++++++------ 5 files changed, 98 insertions(+), 57 deletions(-) diff --git a/spring-cloud-sleuth/2.2.3.RELEASE/reference/html/README.html b/spring-cloud-sleuth/2.2.3.RELEASE/reference/html/README.html index aa33ad43..1ab00381 100644 --- a/spring-cloud-sleuth/2.2.3.RELEASE/reference/html/README.html +++ b/spring-cloud-sleuth/2.2.3.RELEASE/reference/html/README.html @@ -278,7 +278,7 @@ Subtracting the cs timestamp from this timestamp reveals the whole
-Trace Info propagation +Trace Info propagation
@@ -301,7 +301,7 @@ Also, the Client Sent event took place.

-Parent child relationship +Parent child relationship
@@ -318,7 +318,7 @@ If you go to traces in Zipkin, you can see this number in the second trace, as s
-Traces +Traces
@@ -326,7 +326,7 @@ If you go to traces in Zipkin, you can see this number in the second trace, as s
-Traces Info propagation +Traces Info propagation
@@ -391,7 +391,7 @@ You could see in the list of traces one trace that is red. That appears because
-Error Traces +Error Traces
@@ -399,7 +399,7 @@ You could see in the list of traces one trace that is red. That appears because
-Error Traces Info propagation +Error Traces Info propagation
@@ -421,7 +421,7 @@ However, if you want to use the legacy Sleuth approaches, you can set the

Live examples

-Zipkin deployed on Pivotal Web Services +Zipkin deployed on Pivotal Web Services
Click the Pivotal Web Services icon to see it live!Click the Pivotal Web Services icon to see it live!
@@ -433,12 +433,12 @@ However, if you want to use the legacy Sleuth approaches, you can set the
-Dependencies +Dependencies
-Zipkin deployed on Pivotal Web Services +Zipkin deployed on Pivotal Web Services
Click the Pivotal Web Services icon to see it live!Click the Pivotal Web Services icon to see it live!
@@ -468,7 +468,7 @@ An example from Kibana would resemble the following image:

-Log correlation with Kibana +Log correlation with Kibana
diff --git a/spring-cloud-sleuth/2.2.3.RELEASE/reference/html/appendix.html b/spring-cloud-sleuth/2.2.3.RELEASE/reference/html/appendix.html index 162b3508..e87a5adc 100644 --- a/spring-cloud-sleuth/2.2.3.RELEASE/reference/html/appendix.html +++ b/spring-cloud-sleuth/2.2.3.RELEASE/reference/html/appendix.html @@ -211,8 +211,8 @@ Also, you can define your own properties.

spring.sleuth.integration.patterns

-

[!hystrixStreamOutput*, *]

-

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.

+

[!hystrixStreamOutput*, , !channel]

+

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.

spring.sleuth.integration.websockets.enabled

@@ -297,7 +297,7 @@ Also, you can define your own properties.

spring.sleuth.propagation.tag.enabled

true

-

Enables a {@link TagPropagationSpanHandler} that adds extra propagated fields to span tags.

+

Enables a {@link TagPropagationFinishedSpanHandler} that adds extra propagated fields to span tags.

spring.sleuth.propagation.tag.whitelisted-keys

@@ -325,6 +325,11 @@ Also, you can define your own properties.

Service name for the remote Redis endpoint.

+

spring.sleuth.rpc.enabled

+

true

+

Enable tracing of RPC.

+ +

spring.sleuth.rxjava.schedulers.hook.enabled

true

Enable support for RxJava via RxJavaSchedulersHook.

diff --git a/spring-cloud-sleuth/2.2.3.RELEASE/reference/html/index.html b/spring-cloud-sleuth/2.2.3.RELEASE/reference/html/index.html index 9a9fa5fe..e1050233 100644 --- a/spring-cloud-sleuth/2.2.3.RELEASE/reference/html/index.html +++ b/spring-cloud-sleuth/2.2.3.RELEASE/reference/html/index.html @@ -270,7 +270,7 @@ Subtracting the cs timestamp from this timestamp reveals the whole
-Trace Info propagation +Trace Info propagation
@@ -293,7 +293,7 @@ Also, the Client Sent event took place.

-Parent child relationship +Parent child relationship
@@ -310,7 +310,7 @@ If you go to traces in Zipkin, you can see this number in the second trace, as s
-Traces +Traces
@@ -318,7 +318,7 @@ If you go to traces in Zipkin, you can see this number in the second trace, as s
-Traces Info propagation +Traces Info propagation
@@ -383,7 +383,7 @@ You could see in the list of traces one trace that is red. That appears because
-Error Traces +Error Traces
@@ -391,7 +391,7 @@ You could see in the list of traces one trace that is red. That appears because
-Error Traces Info propagation +Error Traces Info propagation
@@ -413,7 +413,7 @@ However, if you want to use the legacy Sleuth approaches, you can set the

1.2.4. Live examples

-Zipkin deployed on Pivotal Web Services +Zipkin deployed on Pivotal Web Services
Click the Pivotal Web Services icon to see it live!Click the Pivotal Web Services icon to see it live!
@@ -425,12 +425,12 @@ However, if you want to use the legacy Sleuth approaches, you can set the
-Dependencies +Dependencies
-Zipkin deployed on Pivotal Web Services +Zipkin deployed on Pivotal Web Services
Click the Pivotal Web Services icon to see it live!Click the Pivotal Web Services icon to see it live!
@@ -460,7 +460,7 @@ An example from Kibana would resemble the following image:

-Log correlation with Kibana +Log correlation with Kibana
@@ -1891,17 +1891,35 @@ Doing so forces a new child span on Tracer.joinSpan().

5.1.4. Implementing Propagation

TraceContext.Extractor<C> is implemented by a Propagation.Factory plugin. -Internally, this code creates the union type, TraceContextOrSamplingFlags, with one of the following: -* TraceContext if trace and span IDs were present. -* TraceIdContext if a trace ID was present but span IDs were not present. -* SamplingFlags if no identifiers were present.

+Internally, this code creates the union type, TraceContextOrSamplingFlags, with one of the following:

+
+
+
    +
  • +

    TraceContext if trace and span IDs were present.

    +
    • +
  • +

    TraceIdContext if a trace ID was present but span IDs were not present.

    +
    • +
  • +

    SamplingFlags if no identifiers were present.

    +
    • +

Some Propagation 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 TraceContext were extracted, add the extra data as TraceContext.extra(). -* Otherwise, add it as TraceContextOrSamplingFlags.extra(), which Tracer.nextSpan handles.

+When implementations have extra data, they handle it as follows:

+
+
+
    +
  • +

    If a TraceContext were extracted, add the extra data as TraceContext.extra().

    +
    • +
  • +

    Otherwise, add it as TraceContextOrSamplingFlags.extra(), which Tracer.nextSpan handles.

    +
    • +
diff --git a/spring-cloud-sleuth/2.2.3.RELEASE/reference/html/intro.html b/spring-cloud-sleuth/2.2.3.RELEASE/reference/html/intro.html index b9a2d248..27637453 100644 --- a/spring-cloud-sleuth/2.2.3.RELEASE/reference/html/intro.html +++ b/spring-cloud-sleuth/2.2.3.RELEASE/reference/html/intro.html @@ -178,7 +178,7 @@ Subtracting the cs timestamp from this timestamp reveals the whole
-Trace Info propagation +Trace Info propagation
@@ -201,7 +201,7 @@ Also, the Client Sent event took place.

-Parent child relationship +Parent child relationship
@@ -218,7 +218,7 @@ If you go to traces in Zipkin, you can see this number in the second trace, as s
-Traces +Traces
@@ -226,7 +226,7 @@ If you go to traces in Zipkin, you can see this number in the second trace, as s
-Traces Info propagation +Traces Info propagation
@@ -291,7 +291,7 @@ You could see in the list of traces one trace that is red. That appears because
-Error Traces +Error Traces
@@ -299,7 +299,7 @@ You could see in the list of traces one trace that is red. That appears because
-Error Traces Info propagation +Error Traces Info propagation
@@ -321,7 +321,7 @@ However, if you want to use the legacy Sleuth approaches, you can set the

Live examples

-Zipkin deployed on Pivotal Web Services +Zipkin deployed on Pivotal Web Services
Click the Pivotal Web Services icon to see it live!Click the Pivotal Web Services icon to see it live!
@@ -333,12 +333,12 @@ However, if you want to use the legacy Sleuth approaches, you can set the
-Dependencies +Dependencies
-Zipkin deployed on Pivotal Web Services +Zipkin deployed on Pivotal Web Services
Click the Pivotal Web Services icon to see it live!Click the Pivotal Web Services icon to see it live!
@@ -368,7 +368,7 @@ An example from Kibana would resemble the following image:

-Log correlation with Kibana +Log correlation with Kibana
diff --git a/spring-cloud-sleuth/2.2.3.RELEASE/reference/html/spring-cloud-sleuth.html b/spring-cloud-sleuth/2.2.3.RELEASE/reference/html/spring-cloud-sleuth.html index 9a9fa5fe..e1050233 100644 --- a/spring-cloud-sleuth/2.2.3.RELEASE/reference/html/spring-cloud-sleuth.html +++ b/spring-cloud-sleuth/2.2.3.RELEASE/reference/html/spring-cloud-sleuth.html @@ -270,7 +270,7 @@ Subtracting the cs timestamp from this timestamp reveals the whole
-Trace Info propagation +Trace Info propagation
@@ -293,7 +293,7 @@ Also, the Client Sent event took place.

-Parent child relationship +Parent child relationship
@@ -310,7 +310,7 @@ If you go to traces in Zipkin, you can see this number in the second trace, as s
-Traces +Traces
@@ -318,7 +318,7 @@ If you go to traces in Zipkin, you can see this number in the second trace, as s
-Traces Info propagation +Traces Info propagation
@@ -383,7 +383,7 @@ You could see in the list of traces one trace that is red. That appears because
-Error Traces +Error Traces
@@ -391,7 +391,7 @@ You could see in the list of traces one trace that is red. That appears because
-Error Traces Info propagation +Error Traces Info propagation
@@ -413,7 +413,7 @@ However, if you want to use the legacy Sleuth approaches, you can set the

1.2.4. Live examples

-Zipkin deployed on Pivotal Web Services +Zipkin deployed on Pivotal Web Services
Click the Pivotal Web Services icon to see it live!Click the Pivotal Web Services icon to see it live!
@@ -425,12 +425,12 @@ However, if you want to use the legacy Sleuth approaches, you can set the
-Dependencies +Dependencies
-Zipkin deployed on Pivotal Web Services +Zipkin deployed on Pivotal Web Services
Click the Pivotal Web Services icon to see it live!Click the Pivotal Web Services icon to see it live!
@@ -460,7 +460,7 @@ An example from Kibana would resemble the following image:

-Log correlation with Kibana +Log correlation with Kibana
@@ -1891,17 +1891,35 @@ Doing so forces a new child span on Tracer.joinSpan().

5.1.4. Implementing Propagation

TraceContext.Extractor<C> is implemented by a Propagation.Factory plugin. -Internally, this code creates the union type, TraceContextOrSamplingFlags, with one of the following: -* TraceContext if trace and span IDs were present. -* TraceIdContext if a trace ID was present but span IDs were not present. -* SamplingFlags if no identifiers were present.

+Internally, this code creates the union type, TraceContextOrSamplingFlags, with one of the following:

+
+
+
    +
  • +

    TraceContext if trace and span IDs were present.

    +
    • +
  • +

    TraceIdContext if a trace ID was present but span IDs were not present.

    +
    • +
  • +

    SamplingFlags if no identifiers were present.

    +
    • +

Some Propagation 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 TraceContext were extracted, add the extra data as TraceContext.extra(). -* Otherwise, add it as TraceContextOrSamplingFlags.extra(), which Tracer.nextSpan handles.

+When implementations have extra data, they handle it as follows:

+
+
+
    +
  • +

    If a TraceContext were extracted, add the extra data as TraceContext.extra().

    +
    • +
  • +

    Otherwise, add it as TraceContextOrSamplingFlags.extra(), which Tracer.nextSpan handles.

    +
    • +