From ba3e41083a0094bd6e214a64d6a683074807d217 Mon Sep 17 00:00:00 2001 From: buildmaster Date: Mon, 6 Apr 2020 23:20:24 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- reference/html/README.html | 24 ++++++----- reference/html/appendix.html | 55 +++++++++++-------------- reference/html/features.html | 15 +++---- reference/html/index.html | 40 ++++++++++-------- reference/html/intro.html | 9 +++- reference/html/spring-cloud-sleuth.html | 40 ++++++++++-------- 6 files changed, 95 insertions(+), 88 deletions(-) diff --git a/reference/html/README.html b/reference/html/README.html index 0c670467d..cf6eb95ec 100644 --- a/reference/html/README.html +++ b/reference/html/README.html @@ -753,7 +753,14 @@ The span must be in scope.
The setup
-
Unresolved directive in intro.adoc - include::/opt/jenkins/data/workspace/spring-cloud-sleuth-master-ci/spring-cloud-sleuth-core/src/test/resources/application-baggage.yml[indent=0]
+
spring:
+  sleuth:
+    baggage:
+      remoteFields:
+        - country-code
+        - x-vcap-request-id
+      tagFields:
+        - country-code
@@ -1112,13 +1119,13 @@ Sleuth and Zipkin
-
2016-02-02 15:30:57.902  INFO [bar,6bfd228dc00d216b,6bfd228dc00d216b,false] 23030 --- [nio-8081-exec-3] ...
-2016-02-02 15:30:58.372 ERROR [bar,6bfd228dc00d216b,6bfd228dc00d216b,false] 23030 --- [nio-8081-exec-3] ...
-2016-02-02 15:31:01.936  INFO [bar,46ab0d418373cbc9,46ab0d418373cbc9,false] 23030 --- [nio-8081-exec-4] ...
+
2016-02-02 15:30:57.902  INFO [bar,6bfd228dc00d216b,6bfd228dc00d216b] 23030 --- [nio-8081-exec-3] ...
+2016-02-02 15:30:58.372 ERROR [bar,6bfd228dc00d216b,6bfd228dc00d216b] 23030 --- [nio-8081-exec-3] ...
+2016-02-02 15:31:01.936  INFO [bar,46ab0d418373cbc9,46ab0d418373cbc9] 23030 --- [nio-8081-exec-4] ...
-

Notice the [appname,traceId,spanId,exportable] entries from the MDC:

+

Notice the [appname,traceId,spanId] entries from the MDC:

In order to automatically set the baggage values to Slf4j’s MDC, you have to set -the spring.sleuth.log.slf4j.whitelisted-mdc-keys property with a list of whitelisted -local or remote keys. E.g. spring.sleuth.log.slf4j.whitelisted-mdc-keys=country-code will set the +the spring.sleuth.baggage.correlation-fields property with a list of whitelisted +local or remote keys. E.g. spring.sleuth.baggage.correlation-fields=country-code will set the value of the country-code baggage into MDC.

@@ -1388,15 +1390,17 @@ Remember that adding entries to MDC can drastically decrease the performance of

If you want to add the baggage entries as tags, to make it possible to search for spans via the baggage entries, you can set the value of -spring.sleuth.propagation.tag.whitelisted-keys with a list of whitelisted baggage keys. To disable the feature you have to pass the spring.sleuth.propagation.tag.enabled=false property.

+spring.sleuth.baggage.tag-fields with a list of whitelisted baggage keys. To disable the feature you have to pass the spring.sleuth.propagation.tag.enabled=false property.

6.1. Java configuration

If you need to do anything more advanced than above, do not define properties and instead use a @Bean config for the baggage fields you use. - * SingleBaggageField controls header names for one BaggageField. - * SingleCorrelationField controls the MDC name of one BaggageField, and whether updates flush.

+ * BaggagePropagationCustomizer sets up baggage fields + * Add a SingleBaggageField to control header names for a BaggageField. + * CorrelationScopeCustomizer sets up MDC fields + * Add a SingleCorrelationField to change the MDC name of a BaggageField or if updates flush.

diff --git a/reference/html/intro.html b/reference/html/intro.html index 3fb5e8410..5b1574136 100644 --- a/reference/html/intro.html +++ b/reference/html/intro.html @@ -653,7 +653,14 @@ The span must be in scope.
The setup
-
Unresolved directive in intro.adoc - include::/opt/jenkins/data/workspace/spring-cloud-sleuth-master-ci/spring-cloud-sleuth-core/src/test/resources/application-baggage.yml[indent=0]
+
spring:
+  sleuth:
+    baggage:
+      remoteFields:
+        - country-code
+        - x-vcap-request-id
+      tagFields:
+        - country-code
diff --git a/reference/html/spring-cloud-sleuth.html b/reference/html/spring-cloud-sleuth.html index 99fef69c1..e0f74d240 100644 --- a/reference/html/spring-cloud-sleuth.html +++ b/reference/html/spring-cloud-sleuth.html @@ -731,7 +731,14 @@ The span must be in scope.
The setup
-
Unresolved directive in intro.adoc - include::/opt/jenkins/data/workspace/spring-cloud-sleuth-master-ci/spring-cloud-sleuth-core/src/test/resources/application-baggage.yml[indent=0]
+
spring:
+  sleuth:
+    baggage:
+      remoteFields:
+        - country-code
+        - x-vcap-request-id
+      tagFields:
+        - country-code
@@ -1090,13 +1097,13 @@ Sleuth and Zipkin
-
2016-02-02 15:30:57.902  INFO [bar,6bfd228dc00d216b,6bfd228dc00d216b,false] 23030 --- [nio-8081-exec-3] ...
-2016-02-02 15:30:58.372 ERROR [bar,6bfd228dc00d216b,6bfd228dc00d216b,false] 23030 --- [nio-8081-exec-3] ...
-2016-02-02 15:31:01.936  INFO [bar,46ab0d418373cbc9,46ab0d418373cbc9,false] 23030 --- [nio-8081-exec-4] ...
+
2016-02-02 15:30:57.902  INFO [bar,6bfd228dc00d216b,6bfd228dc00d216b] 23030 --- [nio-8081-exec-3] ...
+2016-02-02 15:30:58.372 ERROR [bar,6bfd228dc00d216b,6bfd228dc00d216b] 23030 --- [nio-8081-exec-3] ...
+2016-02-02 15:31:01.936  INFO [bar,46ab0d418373cbc9,46ab0d418373cbc9] 23030 --- [nio-8081-exec-4] ...
-

Notice the [appname,traceId,spanId,exportable] entries from the MDC:

+

Notice the [appname,traceId,spanId] entries from the MDC:

@@ -1370,8 +1372,8 @@ properties to define fields that have no special configuration such as name mapp

In order to automatically set the baggage values to Slf4j’s MDC, you have to set -the spring.sleuth.log.slf4j.whitelisted-mdc-keys property with a list of whitelisted -local or remote keys. E.g. spring.sleuth.log.slf4j.whitelisted-mdc-keys=country-code will set the +the spring.sleuth.baggage.correlation-fields property with a list of whitelisted +local or remote keys. E.g. spring.sleuth.baggage.correlation-fields=country-code will set the value of the country-code baggage into MDC.

@@ -1388,15 +1390,17 @@ Remember that adding entries to MDC can drastically decrease the performance of

If you want to add the baggage entries as tags, to make it possible to search for spans via the baggage entries, you can set the value of -spring.sleuth.propagation.tag.whitelisted-keys with a list of whitelisted baggage keys. To disable the feature you have to pass the spring.sleuth.propagation.tag.enabled=false property.

+spring.sleuth.baggage.tag-fields with a list of whitelisted baggage keys. To disable the feature you have to pass the spring.sleuth.propagation.tag.enabled=false property.

6.1. Java configuration

If you need to do anything more advanced than above, do not define properties and instead use a @Bean config for the baggage fields you use. - * SingleBaggageField controls header names for one BaggageField. - * SingleCorrelationField controls the MDC name of one BaggageField, and whether updates flush.

+ * BaggagePropagationCustomizer sets up baggage fields + * Add a SingleBaggageField to control header names for a BaggageField. + * CorrelationScopeCustomizer sets up MDC fields + * Add a SingleCorrelationField to change the MDC name of a BaggageField or if updates flush.