From 9386a86774e73ed2660b603319bf67746acbaf39 Mon Sep 17 00:00:00 2001 From: buildmaster Date: Mon, 6 Apr 2020 08:47:17 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- reference/html/README.html | 2 +- reference/html/index.html | 41 +++++++++++++++++++------ reference/html/intro.html | 2 +- reference/html/spring-cloud-sleuth.html | 41 +++++++++++++++++++------ 4 files changed, 66 insertions(+), 20 deletions(-) diff --git a/reference/html/README.html b/reference/html/README.html index 1aae7f7b4..819cd1877 100644 --- a/reference/html/README.html +++ b/reference/html/README.html @@ -753,7 +753,7 @@ The span must be in scope.
The setup
-
Unresolved directive in intro.adoc - include::/opt/jenkins/data/workspace/spring-cloud-jdk11-spring-cloud-sleuth-master-ci/spring-cloud-sleuth-core/src/test/resources/application-baggage.yml[indent=0]
+
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]
diff --git a/reference/html/index.html b/reference/html/index.html index 37f721c06..c8e4d6196 100644 --- a/reference/html/index.html +++ b/reference/html/index.html @@ -129,7 +129,7 @@ $(globalSwitch);
  • 2. Additional Resources
  • 3. Features
    • -
  • 4. Introduction to Brave +
  • 4. Introduction @@ -727,7 +727,7 @@ The span must be in scope.
    The setup
    -
    Unresolved directive in intro.adoc - include::/opt/jenkins/data/workspace/spring-cloud-jdk11-spring-cloud-sleuth-master-ci/spring-cloud-sleuth-core/src/test/resources/application-baggage.yml[indent=0]
    +
    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]
    @@ -1226,22 +1226,45 @@ We’ve converted the MDC entries from B3 to non B3 keys (e.g. X-B3-Tr
    • -

    4. Introduction to Brave

    +

    4. Introduction

    +

    Spring Cloud Sleuth is a layer over Brave.

    +
    +

    Brave is a distributed tracing instrumentation library. Brave typically intercepts production requests to gather timing data, correlate and propagate -trace contexts. While typically trace data is sent to Zipkin server, -third-party plugins are available to send to alternate services such as Amazon -X-Ray.

    +trace contexts.

    -

    Spring Cloud Sleuth is a layer over Brave. -It configures everything you need to get started with tracing. Sleuth +

    Trace data, also called spans, are typically reported to Zipkin. +Zipkin is an Open Source tracing system, which includes a UI and various +collectors, such as HTTP and messaging.

    +
    +
    +

    Many Open Source and commercial products accept Zipkin format. +Some options are documented here, +but many are not. If you cannot use Zipkin and your product isn’t listed, clarify +with your support representative and have them update that page. In many cases, +products already support Zipkin format, they just don’t document it.

    +
    +
    +

    Traces connect from service to service using header propagation. The default +format is B3. Similar to data +formats, you can configure alternate header formats also, provided trace and +span IDs are compatible with B3. Most notably, this means the trace ID and span +IDs are lower-case hex, not UUIDs. Besides trace identifiers, other properties +(Baggage) can also be passed along with the request. Remote Baggage must be +predefined, but is flexible otherwise.

    +
    +
    +

    Sleuth configures everything you need to get started with tracing. Sleuth configures where trace data (spans) are reported to, how many traces to keep (sampling), if remote fields (baggage) and which libraries are traced. Sleuth also adds annotation based tracing features and some instrumentation not -available otherwise, such as Reactor.

    +available otherwise, such as Reactor. If cannot find the configuration you are +looking for in the documentation, ask Gitter +before assuming something cannot be done.

    4.1. Brave Basics

    diff --git a/reference/html/intro.html b/reference/html/intro.html index 5bd264b14..c2eff3ad4 100644 --- a/reference/html/intro.html +++ b/reference/html/intro.html @@ -653,7 +653,7 @@ The span must be in scope.
    The setup
    -
    Unresolved directive in intro.adoc - include::/opt/jenkins/data/workspace/spring-cloud-jdk11-spring-cloud-sleuth-master-ci/spring-cloud-sleuth-core/src/test/resources/application-baggage.yml[indent=0]
    +
    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]
    diff --git a/reference/html/spring-cloud-sleuth.html b/reference/html/spring-cloud-sleuth.html index 37f721c06..c8e4d6196 100644 --- a/reference/html/spring-cloud-sleuth.html +++ b/reference/html/spring-cloud-sleuth.html @@ -129,7 +129,7 @@ $(globalSwitch);
  • 2. Additional Resources
  • 3. Features
    • -
  • 4. Introduction to Brave +
  • 4. Introduction @@ -727,7 +727,7 @@ The span must be in scope.
    The setup
    -
    Unresolved directive in intro.adoc - include::/opt/jenkins/data/workspace/spring-cloud-jdk11-spring-cloud-sleuth-master-ci/spring-cloud-sleuth-core/src/test/resources/application-baggage.yml[indent=0]
    +
    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]
    @@ -1226,22 +1226,45 @@ We’ve converted the MDC entries from B3 to non B3 keys (e.g. X-B3-Tr
    • -

    4. Introduction to Brave

    +

    4. Introduction

    +

    Spring Cloud Sleuth is a layer over Brave.

    +
    +

    Brave is a distributed tracing instrumentation library. Brave typically intercepts production requests to gather timing data, correlate and propagate -trace contexts. While typically trace data is sent to Zipkin server, -third-party plugins are available to send to alternate services such as Amazon -X-Ray.

    +trace contexts.

    -

    Spring Cloud Sleuth is a layer over Brave. -It configures everything you need to get started with tracing. Sleuth +

    Trace data, also called spans, are typically reported to Zipkin. +Zipkin is an Open Source tracing system, which includes a UI and various +collectors, such as HTTP and messaging.

    +
    +
    +

    Many Open Source and commercial products accept Zipkin format. +Some options are documented here, +but many are not. If you cannot use Zipkin and your product isn’t listed, clarify +with your support representative and have them update that page. In many cases, +products already support Zipkin format, they just don’t document it.

    +
    +
    +

    Traces connect from service to service using header propagation. The default +format is B3. Similar to data +formats, you can configure alternate header formats also, provided trace and +span IDs are compatible with B3. Most notably, this means the trace ID and span +IDs are lower-case hex, not UUIDs. Besides trace identifiers, other properties +(Baggage) can also be passed along with the request. Remote Baggage must be +predefined, but is flexible otherwise.

    +
    +
    +

    Sleuth configures everything you need to get started with tracing. Sleuth configures where trace data (spans) are reported to, how many traces to keep (sampling), if remote fields (baggage) and which libraries are traced. Sleuth also adds annotation based tracing features and some instrumentation not -available otherwise, such as Reactor.

    +available otherwise, such as Reactor. If cannot find the configuration you are +looking for in the documentation, ask Gitter +before assuming something cannot be done.

    4.1. Brave Basics