diff --git a/multi/multi__introduction.html b/multi/multi__introduction.html index 9f7aa7971..45a955fd8 100644 --- a/multi/multi__introduction.html +++ b/multi/multi__introduction.html @@ -139,10 +139,16 @@ Baggage is an optional part.

Baggage is a set of key:value pairs stored in and is attached to every span. Spring Cloud Sleuth will understand that a header is baggage related if the HTTP header is prefixed with baggage- and for messaging it starts with baggage_.

[Important]Important

There’s currently no limitation of the count or size of baggage items. However, keep in mind that too many can decrease system throughput or increase RPC latency. In extreme cases, it could crash the app due -to exceeding transport-level message or header capacity.

Example of setting baggage on a span:

Unresolved directive in intro.adoc - include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/brave/instrument/web/multiple/MultipleHopsIntegrationTests.java[tags=baggage,indent=0]
+to exceeding transport-level message or header capacity.
Example of setting baggage on a span:
Span initialSpan = this.tracer.nextSpan().name("span").start();
+try (Tracer.SpanInScope ws = this.tracer.withSpanInScope(initialSpan)) {
+	ExtraFieldPropagation.set("foo", "bar");
+	ExtraFieldPropagation.set("UPPER_CASE", "someValue");
 }
Baggage vs. Span Tags
Baggage travels with the trace (i.e. every child span contains the baggage of its parent). Zipkin has no knowledge of
 baggage and will not even receive that information.
Tags are attached to a specific span - they are presented for that particular span only. However you
-can search by tag to find the trace, where there exists a span having the searched tag value.
If you want to be able to lookup a span based on baggage, you should add corresponding entry as a tag in the root span.
[Important]Important
Remember that the span needs to be in scope!
Unresolved directive in intro.adoc - include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/brave/instrument/web/multiple/MultipleHopsIntegrationTests.java[tags=baggage_tag,indent=0]
1.3 Adding to the project
[Important]Important
To ensure that your application name is properly displayed in Zipkin
+can search by tag to find the trace, where there exists a span having the searched tag value.
If you want to be able to lookup a span based on baggage, you should add corresponding entry as a tag in the root span.
[Important]Important
Remember that the span needs to be in scope!
initialSpan.tag("foo",
+		ExtraFieldPropagation.get(initialSpan.context(), "foo"));
+initialSpan.tag("UPPER_CASE",
+		ExtraFieldPropagation.get(initialSpan.context(), "UPPER_CASE"));
1.3 Adding to the project
[Important]Important
To ensure that your application name is properly displayed in Zipkin
  set the spring.application.name property in bootstrap.yml.
1.3.1 Only Sleuth (log correlation)
If you want to profit only from Spring Cloud Sleuth without the Zipkin integration just add
 the spring-cloud-starter-sleuth module to your project.
Maven. 
 
<dependencyManagement> 1
diff --git a/single/spring-cloud-sleuth.html b/single/spring-cloud-sleuth.html
index bc07b162e..cb1c89a04 100644
--- a/single/spring-cloud-sleuth.html
+++ b/single/spring-cloud-sleuth.html
@@ -139,10 +139,16 @@ Baggage is an optional part.
Baggage is a set of key:value pairs stored in
 and is attached to every span. Spring Cloud Sleuth will understand that a header is baggage related if the HTTP
  header is prefixed with baggage- and for messaging it starts with baggage_.
[Important]Important
There’s currently no limitation of the count or size of baggage items. However, keep in mind that
 too many can decrease system throughput or increase RPC latency. In extreme cases, it could crash the app due
-to exceeding transport-level message or header capacity.
Example of setting baggage on a span:
Unresolved directive in intro.adoc - include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/brave/instrument/web/multiple/MultipleHopsIntegrationTests.java[tags=baggage,indent=0]
+to exceeding transport-level message or header capacity.
Example of setting baggage on a span:
Span initialSpan = this.tracer.nextSpan().name("span").start();
+try (Tracer.SpanInScope ws = this.tracer.withSpanInScope(initialSpan)) {
+	ExtraFieldPropagation.set("foo", "bar");
+	ExtraFieldPropagation.set("UPPER_CASE", "someValue");
 }
Baggage vs. Span Tags
Baggage travels with the trace (i.e. every child span contains the baggage of its parent). Zipkin has no knowledge of
 baggage and will not even receive that information.
Tags are attached to a specific span - they are presented for that particular span only. However you
-can search by tag to find the trace, where there exists a span having the searched tag value.
If you want to be able to lookup a span based on baggage, you should add corresponding entry as a tag in the root span.
[Important]Important
Remember that the span needs to be in scope!
Unresolved directive in intro.adoc - include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/brave/instrument/web/multiple/MultipleHopsIntegrationTests.java[tags=baggage_tag,indent=0]
1.3 Adding to the project
[Important]Important
To ensure that your application name is properly displayed in Zipkin
+can search by tag to find the trace, where there exists a span having the searched tag value.
If you want to be able to lookup a span based on baggage, you should add corresponding entry as a tag in the root span.
[Important]Important
Remember that the span needs to be in scope!
initialSpan.tag("foo",
+		ExtraFieldPropagation.get(initialSpan.context(), "foo"));
+initialSpan.tag("UPPER_CASE",
+		ExtraFieldPropagation.get(initialSpan.context(), "UPPER_CASE"));
1.3 Adding to the project
[Important]Important
To ensure that your application name is properly displayed in Zipkin
  set the spring.application.name property in bootstrap.yml.
1.3.1 Only Sleuth (log correlation)
If you want to profit only from Spring Cloud Sleuth without the Zipkin integration just add
 the spring-cloud-starter-sleuth module to your project.
Maven. 
 
<dependencyManagement> 1
diff --git a/spring-cloud-sleuth.xml b/spring-cloud-sleuth.xml
index 90949dc1d..d98d9192f 100644
--- a/spring-cloud-sleuth.xml
+++ b/spring-cloud-sleuth.xml
@@ -4,7 +4,7 @@
 
 
 Spring Cloud Sleuth
-2018-02-09
+2018-02-10
 
 
 Adrian Cole, Spencer Gibb, Marcin Grzejszczak, Dave Syer
@@ -366,7 +366,10 @@ too many can decrease system throughput or increase RPC latency. In extreme case
 to exceeding transport-level message or header capacity.
 
 Example of setting baggage on a span:
-Unresolved directive in intro.adoc - include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/brave/instrument/web/multiple/MultipleHopsIntegrationTests.java[tags=baggage,indent=0]
+Span initialSpan = this.tracer.nextSpan().name("span").start();
+try (Tracer.SpanInScope ws = this.tracer.withSpanInScope(initialSpan)) {
+	ExtraFieldPropagation.set("foo", "bar");
+	ExtraFieldPropagation.set("UPPER_CASE", "someValue");
 }
 

 Baggage vs. Span Tags
@@ -378,7 +381,10 @@ can search by tag to find the trace, where there exists a span having the search
 
 Remember that the span needs to be in scope!
 
-Unresolved directive in intro.adoc - include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/master/spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/brave/instrument/web/multiple/MultipleHopsIntegrationTests.java[tags=baggage_tag,indent=0]
+initialSpan.tag("foo",
+		ExtraFieldPropagation.get(initialSpan.context(), "foo"));
+initialSpan.tag("UPPER_CASE",
+		ExtraFieldPropagation.get(initialSpan.context(), "UPPER_CASE"));