From eab6d39cb6b33481d431b30527ef313ac0e227e9 Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Thu, 10 Nov 2016 15:49:22 +0100 Subject: [PATCH] Updated docs --- README.adoc | 6 +++--- docs/src/main/asciidoc/intro.adoc | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.adoc b/README.adoc index 62fe54eeb..71ef987d3 100644 --- a/README.adoc +++ b/README.adoc @@ -280,7 +280,7 @@ Below you can find an example of a Logback configuration (file named `https://gi NOTE: If you're using a custom `logback-spring.xml` then you have to pass the `spring.application.name` in `bootstrap` instead of `application` property file. Otherwise your custom logback file won't read the property properly. -===== Propagating Span Context +==== Propagating Span Context The span context is the state that must get propagated to any child Spans across process boundaries. Part of the Span Context is the Baggage. The trace and span IDs are a required part of the span context. @@ -294,7 +294,7 @@ IMPORTANT: There's currently no limitation of the count or size of baggage items 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 span: +Example of setting baggage on a span: [source,java] ---- @@ -302,7 +302,7 @@ Span initialSpan = this.tracer.createSpan("span"); initialSpan.setBaggageItem("foo", "bar"); ---- -====== Baggage vs. Span Tags +===== 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. diff --git a/docs/src/main/asciidoc/intro.adoc b/docs/src/main/asciidoc/intro.adoc index 8c118fcea..249aba5c3 100644 --- a/docs/src/main/asciidoc/intro.adoc +++ b/docs/src/main/asciidoc/intro.adoc @@ -164,7 +164,7 @@ include::https://raw.githubusercontent.com/spring-cloud-samples/sleuth-documenta NOTE: If you're using a custom `logback-spring.xml` then you have to pass the `spring.application.name` in `bootstrap` instead of `application` property file. Otherwise your custom logback file won't read the property properly. -===== Propagating Span Context +==== Propagating Span Context The span context is the state that must get propagated to any child Spans across process boundaries. Part of the Span Context is the Baggage. The trace and span IDs are a required part of the span context. @@ -178,14 +178,14 @@ IMPORTANT: There's currently no limitation of the count or size of baggage items 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 span: +Example of setting baggage on a span: [source,java] ---- include::{github-raw}/spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/sleuth/instrument/web/multiple/MultipleHopsIntegrationTests.java[tags=baggage,indent=0] ---- -====== Baggage vs. Span Tags +===== 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.