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-codeNotice the [appname,traceId,spanId,exportable] entries from the MDC:
Notice the [appname,traceId,spanId] entries from the MDC:
List of {@link java.util.concurrent.Executor} bean names that should be ignored and not wrapped in a trace representation.
spring.sleuth.baggage.correlation-enabled
true
Enable a {@link Slf4jScopeDecorator} that prints tracing information in the logs.
spring.sleuth.baggage.correlation-fields
A list of keys to be put from baggage to MDC.
spring.sleuth.baggage.local-fields
Same as {@link #remoteKeys} except that this field is not propagated to remote services. @see brave.baggage.BaggagePropagationConfig.SingleBaggageField#local(BaggageField)
spring.sleuth.baggage.remote-fields
List of fields that are referenced the same in-process as it is on the wire. For example, the name "x-vcap-request-id" would be set as-is including the prefix. <p> Note: {@code fieldName} will be implicitly lower-cased. @see brave.baggage.BaggagePropagationConfig.SingleBaggageField#remote(BaggageField)
spring.sleuth.baggage.tag-fields
A list of baggage field names which are tagged when a span finishes.
spring.sleuth.circuitbreaker.enabled
true
Enable Spring Cloud CircuitBreaker instrumentation.
Enable tracing for WebSockets.
spring.sleuth.local-keys
Same as {@link #remoteKeys} except that this field is not propagated to remote services. @see brave.baggage.BaggagePropagationConfig.SingleBaggageField#local(BaggageField)
spring.sleuth.log.slf4j.enabled
true
Enable a {@link Slf4jScopeDecorator} that prints tracing information in the logs.
spring.sleuth.log.slf4j.whitelisted-mdc-keys
A list of keys to be put from baggage to MDC.
spring.sleuth.messaging.enabled
false
Should messaging be turned on.
spring.sleuth.remote-keys
List of fields that are referenced the same in-process as it is on the wire. For example, the name "x-vcap-request-id" would be set as-is including the prefix. <p> Note: {@code fieldName} will be implicitly lower-cased. @see brave.baggage.BaggagePropagationConfig.SingleBaggageField#remote(BaggageField)
spring.sleuth.propagation.tag.enabled
true
Enables a {@link TagPropagationFinishedSpanHandler} that adds extra propagated fields to span tags.
spring.sleuth.propagation.tag.whitelisted-keys
A list of keys to be put from extra propagation fields to span tags.
spring.sleuth.reactor.decorate-on-each
true
When true decorates on each operator, will be less performing, but logging will always contain the tracing entries in each operator. When false decorates on last operator, will be more performing, but logging might not always contain the tracing entries.
Adds trace and span IDs to the Slf4J MDC, so you can extract all the logs from a given trace or span in a log aggregator, as shown in the following example logs:
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:
traceId: The ID of the latency graph that contains the span.
exportable: Whether the log should be exported to Zipkin.
-When would you like the span not to be exportable?
-When you want to wrap some operation in a Span and have it written to the logs only.
logging.pattern.level set to %5p [${spring.zipkin.service.name:${spring.application.name:-}},%X{traceId:-},%X{spanId:-},%X{spanExportable:-}]
+logging.pattern.level set to %5p [${spring.zipkin.service.name:${spring.application.name:-}},%X{traceId:-},%X{spanId:-}]
(this is a Spring Boot feature for logback users).
If you do not use SLF4J, this pattern is NOT automatically applied.
diff --git a/reference/html/index.html b/reference/html/index.html
index 99fef69c1..e0f74d240 100644
--- a/reference/html/index.html
+++ b/reference/html/index.html
@@ -731,7 +731,14 @@ The span must be in scope.
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-codeNotice the [appname,traceId,spanId,exportable] entries from the MDC:
Notice the [appname,traceId,spanId] entries from the MDC:
spring.sleuth.remote-keys is a list of header names to accept and propagate to remote services.
spring.sleuth.remote-fields is a list of header names to accept and propagate to remote services.
spring.sleuth.local-keys is a list of names to propagate locally
spring.sleuth.local-fields is a list of names to propagate locally
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.
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.
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.
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-codeUnresolved 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-codeNotice the [appname,traceId,spanId,exportable] entries from the MDC:
Notice the [appname,traceId,spanId] entries from the MDC:
spring.sleuth.remote-keys is a list of header names to accept and propagate to remote services.
spring.sleuth.remote-fields is a list of header names to accept and propagate to remote services.
spring.sleuth.local-keys is a list of names to propagate locally
spring.sleuth.local-fields is a list of names to propagate locally
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.
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.
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.