From fae40042b613978b14dd37f94011f73b8fce9fdd Mon Sep 17 00:00:00 2001 From: buildmaster Date: Thu, 15 Feb 2018 11:36:07 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- multi/multi__features.html | 2 +- multi/multi__sending_spans_to_zipkin.html | 5 ++++- single/spring-cloud-sleuth.html | 7 +++++-- spring-cloud-sleuth.xml | 7 ++++++- 4 files changed, 16 insertions(+), 5 deletions(-) diff --git a/multi/multi__features.html b/multi/multi__features.html index 30821373f..aa66022d0 100644 --- a/multi/multi__features.html +++ b/multi/multi__features.html @@ -10,7 +10,7 @@ latency in your applications. Sleuth is written to not log too much, and to not rest template, scheduled actions, message channels, zuul filters, feign client).
  • Sleuth includes default logic to join a trace across http or messaging boundaries. For example, http propagation works via Zipkin-compatible request headers. This propagation logic is defined and customized via SpanInjector and SpanExtractor implementations.
  • Sleuth gives you the possibility to propagate context (also known as baggage) between processes. That means that if you set on a Span -a baggage element then it will be sent downstream either via HTTP or messaging to other processes.
  • Provides a way to create / continue spans and add tags and logs via annotations.

  • If spring-cloud-sleuth-zipkin then the app will generate and collect Zipkin-compatible traces. +a baggage element then it will be sent downstream either via HTTP or messaging to other processes.

  • Provides a way to create / continue spans and add tags and logs via annotations.

  • If spring-cloud-sleuth-zipkin is on the classpath then the app will generate and collect Zipkin-compatible traces. By default it sends them via HTTP to a Zipkin server on localhost (port 9411). Configure the location of the service using spring.zipkin.baseUrl.

    • If you depend on spring-rabbit or spring-kafka your app will send traces to a broker instead of http.
    • Note: spring-cloud-sleuth-stream is deprecated and should no longer be used.
  • Spring Cloud Sleuth is OpenTracing compatible
    • [Important]Important

    If using Zipkin, configure the percentage of spans exported using spring.sleuth.sampler.percentage (default 0.1, i.e. 10%). Otherwise you might think that Sleuth is not working cause it’s omitting some spans.

    [Note]Note

    the SLF4J MDC is always set and logback users will immediately see the trace and span ids in logs per the example diff --git a/multi/multi__sending_spans_to_zipkin.html b/multi/multi__sending_spans_to_zipkin.html index 37c87e209..82594b045 100644 --- a/multi/multi__sending_spans_to_zipkin.html +++ b/multi/multi__sending_spans_to_zipkin.html @@ -4,4 +4,7 @@ when the span is closed, it will be sent to Zipkin over HTTP. The communication is asynchronous. You can configure the URL by setting the spring.zipkin.baseUrl property as follows:

    spring.zipkin.baseUrl: http://192.168.99.100:9411/

    If you want to find Zipkin via service discovery it’s enough to pass the -Zipkin’s service id inside the URL (example for zipkinserver service id)

    spring.zipkin.baseUrl: http://zipkinserver/
    Prev   Next
    12. Customizations Home 14. Zipkin Stream Span Consumer
    \ No newline at end of file +Zipkin’s service id inside the URL (example for zipkinserver service id)

    spring.zipkin.baseUrl: http://zipkinserver/

    If you have web, rabbit or kafka together on the classpath, you might need +to pick the means by which you would like to send spans to zipkin. To do that +just set either web, rabbit or kafka to the spring.zipkin.sender.type property. +Example for web:

    spring.zipkin.sender.type: web
    Prev   Next
    12. Customizations Home 14. Zipkin Stream Span Consumer
    \ No newline at end of file diff --git a/single/spring-cloud-sleuth.html b/single/spring-cloud-sleuth.html index cb1c89a04..921c0e719 100644 --- a/single/spring-cloud-sleuth.html +++ b/single/spring-cloud-sleuth.html @@ -254,7 +254,7 @@ latency in your applications. Sleuth is written to not log too much, and to not rest template, scheduled actions, message channels, zuul filters, feign client).
  • Sleuth includes default logic to join a trace across http or messaging boundaries. For example, http propagation works via Zipkin-compatible request headers. This propagation logic is defined and customized via SpanInjector and SpanExtractor implementations.
  • Sleuth gives you the possibility to propagate context (also known as baggage) between processes. That means that if you set on a Span -a baggage element then it will be sent downstream either via HTTP or messaging to other processes.
  • Provides a way to create / continue spans and add tags and logs via annotations.

  • If spring-cloud-sleuth-zipkin then the app will generate and collect Zipkin-compatible traces. +a baggage element then it will be sent downstream either via HTTP or messaging to other processes.

  • Provides a way to create / continue spans and add tags and logs via annotations.

  • If spring-cloud-sleuth-zipkin is on the classpath then the app will generate and collect Zipkin-compatible traces. By default it sends them via HTTP to a Zipkin server on localhost (port 9411). Configure the location of the service using spring.zipkin.baseUrl.

    • If you depend on spring-rabbit or spring-kafka your app will send traces to a broker instead of http.
    • Note: spring-cloud-sleuth-stream is deprecated and should no longer be used.
  • Spring Cloud Sleuth is OpenTracing compatible
    • [Important]Important

    If using Zipkin, configure the percentage of spans exported using spring.sleuth.sampler.percentage (default 0.1, i.e. 10%). Otherwise you might think that Sleuth is not working cause it’s omitting some spans.

    [Note]Note

    the SLF4J MDC is always set and logback users will immediately see the trace and span ids in logs per the example @@ -716,7 +716,10 @@ Stream based span reporting).

    spring.zipkin.baseUrl
 property as follows:
    spring.zipkin.baseUrl: http://192.168.99.100:9411/
    If you want to find Zipkin via service discovery it’s enough to pass the
-Zipkin’s service id inside the URL (example for zipkinserver service id)
    spring.zipkin.baseUrl: http://zipkinserver/
    14. Zipkin Stream Span Consumer
    [Important]Important
    The suggested approach is to use the Zipkin’s
+Zipkin’s service id inside the URL (example for zipkinserver service id)
    spring.zipkin.baseUrl: http://zipkinserver/
    If you have web, rabbit or kafka together on the classpath, you might need
+to pick the means by which you would like to send spans to zipkin. To do that
+just set either web, rabbit or kafka to the spring.zipkin.sender.type property.
+Example for web:
    spring.zipkin.sender.type: web
    14. Zipkin Stream Span Consumer
    [Important]Important
    The suggested approach is to use the Zipkin’s
 native support for message based span sending. Starting from
 Edgware Zipkin Stream server is deprecated and in Finchley
 it got removed.
    Please refer to the Dalston Documentaion
diff --git a/spring-cloud-sleuth.xml b/spring-cloud-sleuth.xml
index 9896ad243..6617bde37 100644
--- a/spring-cloud-sleuth.xml
+++ b/spring-cloud-sleuth.xml
@@ -654,7 +654,7 @@ a baggage element then it will be sent downstream either via HTTP or messaging t
 Provides a way to create / continue spans and add tags and logs via annotations.
 
 
-If spring-cloud-sleuth-zipkin then the app will generate and collect Zipkin-compatible traces.
+If spring-cloud-sleuth-zipkin is on the classpath then the app will generate and collect Zipkin-compatible traces.
 By default it sends them via HTTP to a Zipkin server on localhost (port 9411).
 Configure the location of the service using spring.zipkin.baseUrl.
 
@@ -1543,6 +1543,11 @@ property as follows:
 If you want to find Zipkin via service discovery it’s enough to pass the
 Zipkin’s service id inside the URL (example for zipkinserver service id)
 spring.zipkin.baseUrl: http://zipkinserver/
+If you have web, rabbit or kafka together on the classpath, you might need
+to pick the means by which you would like to send spans to zipkin. To do that
+just set either web, rabbit or kafka to the spring.zipkin.sender.type property.
+Example for web:
+spring.zipkin.sender.type: web
 
 
 Zipkin Stream Span Consumer