diff --git a/1.3.x/multi/multi__features.html b/1.3.x/multi/multi__features.html index bb705d5d4..45da37ea4 100644 --- a/1.3.x/multi/multi__features.html +++ b/1.3.x/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.
  • Provides simple metrics of accepted / dropped spans.
  • 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.
  • Provides simple metrics of accepted / dropped spans.
  • 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.

  • [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/1.3.x/multi/multi__sending_spans_to_zipkin.html b/1.3.x/multi/multi__sending_spans_to_zipkin.html index c63c7f4f7..79fca75f1 100644 --- a/1.3.x/multi/multi__sending_spans_to_zipkin.html +++ b/1.3.x/multi/multi__sending_spans_to_zipkin.html @@ -1,7 +1,13 @@ - 10. Sending spans to Zipkin

    10. Sending spans to Zipkin

    By default if you add spring-cloud-starter-zipkin as a dependency to your project, + 10. Sending spans to Zipkin

    10. Sending spans to Zipkin

    [Important]Important

    spring-cloud-sleuth-stream is deprecated and should no longer be used. +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). If you depend +on spring-rabbit or spring-kafka your app will send traces to a broker instead of http.

    By default if you add spring-cloud-starter-zipkin as a dependency to your project, 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/
    \ 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
    \ No newline at end of file diff --git a/1.3.x/multi/multi__span_data_as_messages.html b/1.3.x/multi/multi__span_data_as_messages.html index e2be459fc..6fdedfa0b 100644 --- a/1.3.x/multi/multi__span_data_as_messages.html +++ b/1.3.x/multi/multi__span_data_as_messages.html @@ -8,7 +8,10 @@ adding a Channel Binder implementation spring-cloud-starter-stream-kafka for Kafka). This will automatically turn your app into a producer of messages with payload type Spans. The channel name to which the spans will be sent -is called sleuth.

    11.1 Zipkin Consumer

    There is a special convenience annotation for setting up a message consumer +is called sleuth.

    11.1 Zipkin Consumer

    [Important]Important

    spring-cloud-sleuth-zipkin-stream is deprecated and should no longer be used. +Please use the OpenZipkin’s Zipkin server and set the environment variables +as presented here for rabbit (Zipkin 2.4.6) +or here for kafka (Zipkin 2.4.6)

    There is a special convenience annotation for setting up a message consumer for the Span data and pushing it into a Zipkin SpanStore. This application

    @SpringBootApplication
     @EnableZipkinStreamServer
     public class Consumer {
    diff --git a/1.3.x/single/spring-cloud-sleuth.html b/1.3.x/single/spring-cloud-sleuth.html
    index 0906970a7..8ce78ce46 100644
    --- a/1.3.x/single/spring-cloud-sleuth.html
    +++ b/1.3.x/single/spring-cloud-sleuth.html
    @@ -244,7 +244,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.
  • Provides simple metrics of accepted / dropped spans.
  • 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.
  • Provides simple metrics of accepted / dropped spans.
  • 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.
  • [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 @@ -563,11 +563,17 @@ SpanAdjuster customSpanAdjuster()

    If you have the discovery client enabled and prefer to retrieve the host address from the registered instance in a service registry then you have to set the property (it’s applicable for both HTTP and -Stream based span reporting).

    spring.zipkin.locator.discovery.enabled: true

    10. Sending spans to Zipkin

    By default if you add spring-cloud-starter-zipkin as a dependency to your project, +Stream based span reporting).

    spring.zipkin.locator.discovery.enabled: true

    10. Sending spans to Zipkin

    [Important]Important

    spring-cloud-sleuth-stream is deprecated and should no longer be used. +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). If you depend +on spring-rabbit or spring-kafka your app will send traces to a broker instead of http.

    By default if you add spring-cloud-starter-zipkin as a dependency to your project, 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/

    11. Span Data as Messages

    You can accumulate and send span data over +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

    11. Span Data as Messages

    You can accumulate and send span data over Spring Cloud Stream by including the spring-cloud-sleuth-stream jar as a dependency, and adding a Channel Binder implementation @@ -575,7 +581,10 @@ adding a Channel Binder implementation spring-cloud-starter-stream-kafka for Kafka). This will automatically turn your app into a producer of messages with payload type Spans. The channel name to which the spans will be sent -is called sleuth.

    11.1 Zipkin Consumer

    There is a special convenience annotation for setting up a message consumer +is called sleuth.

    11.1 Zipkin Consumer

    [Important]Important

    spring-cloud-sleuth-zipkin-stream is deprecated and should no longer be used. +Please use the OpenZipkin’s Zipkin server and set the environment variables +as presented here for rabbit (Zipkin 2.4.6) +or here for kafka (Zipkin 2.4.6)

    There is a special convenience annotation for setting up a message consumer for the Span data and pushing it into a Zipkin SpanStore. This application

    @SpringBootApplication
     @EnableZipkinStreamServer
     public class Consumer {
    diff --git a/1.3.x/spring-cloud-sleuth.xml b/1.3.x/spring-cloud-sleuth.xml
    index a04a0493c..679242d48 100644
    --- a/1.3.x/spring-cloud-sleuth.xml
    +++ b/1.3.x/spring-cloud-sleuth.xml
    @@ -637,7 +637,7 @@ a baggage element then it will be sent downstream either via HTTP or messaging t
     Provides simple metrics of accepted / dropped spans.
     
     
    -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.
     
    @@ -1290,6 +1290,12 @@ Stream based span reporting).
     
     
     Sending spans to Zipkin
    +
    +spring-cloud-sleuth-stream is deprecated and should no longer be used.
    +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). If you depend
    +on spring-rabbit or spring-kafka your app will send traces to a broker instead of http.
    +
     By default if you add spring-cloud-starter-zipkin as a dependency to your project,
     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
    @@ -1298,6 +1304,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
     
     
     Span Data as Messages
    @@ -1312,6 +1323,12 @@ type Spans. The channel name to which the spans will be sent
     is called sleuth.
     
    Zipkin Consumer + +spring-cloud-sleuth-zipkin-stream is deprecated and should no longer be used. +Please use the OpenZipkin’s Zipkin server and set the environment variables +as presented here for rabbit (Zipkin 2.4.6) +or here for kafka (Zipkin 2.4.6) + There is a special convenience annotation for setting up a message consumer for the Span data and pushing it into a Zipkin SpanStore. This application @SpringBootApplication