From b97ab150e026a3fcd2e9a5b25310b4a7e44ee82e Mon Sep 17 00:00:00 2001 From: buildmaster Date: Sat, 4 Apr 2020 06:41:10 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- reference/html/README.html | 2 +- reference/html/appendix.html | 7 +----- reference/html/features.html | 2 +- reference/html/index.html | 30 +++++++------------------ reference/html/sagan-index.html | 2 +- reference/html/spring-cloud-sleuth.html | 30 +++++++------------------ 6 files changed, 20 insertions(+), 53 deletions(-) diff --git a/reference/html/README.html b/reference/html/README.html index 05718a5cf..4a5b55468 100644 --- a/reference/html/README.html +++ b/reference/html/README.html @@ -1177,7 +1177,7 @@ To that end, Sleuth:

  • -

    Instruments common ingress and egress points from Spring applications (servlet filter, async endpoints, rest template, scheduled actions, message channels, Zuul filters, and Feign client).

    +

    Instruments common ingress and egress points from Spring applications (servlet filter, async endpoints, rest template, scheduled actions, message channels, and Feign client).

  • Sleuth includes default logic to join a trace across HTTP or messaging boundaries. diff --git a/reference/html/appendix.html b/reference/html/appendix.html index bc20c3128..28edaffb9 100644 --- a/reference/html/appendix.html +++ b/reference/html/appendix.html @@ -350,7 +350,7 @@ Also, you can define your own properties.

    spring.sleuth.scheduled.skip-pattern

    -

    org.springframework.cloud.netflix.hystrix.stream.HystrixStreamTask

    +

    Pattern for the fully qualified name of a class that should be skipped.

    @@ -409,11 +409,6 @@ Also, you can define your own properties.

    Pattern for URLs that should be skipped in tracing.

    -

    spring.sleuth.zuul.enabled

    -

    true

    -

    Enable span information propagation when using Zuul.

    - -

    spring.zipkin.activemq.message-max-bytes

    100000

    Maximum number of bytes for a given message with spans sent to Zipkin over ActiveMQ.

    diff --git a/reference/html/features.html b/reference/html/features.html index f39f339ee..22956e045 100644 --- a/reference/html/features.html +++ b/reference/html/features.html @@ -184,7 +184,7 @@ To that end, Sleuth:

  • -

    Instruments common ingress and egress points from Spring applications (servlet filter, async endpoints, rest template, scheduled actions, message channels, Zuul filters, and Feign client).

    +

    Instruments common ingress and egress points from Spring applications (servlet filter, async endpoints, rest template, scheduled actions, message channels, and Feign client).

  • Sleuth includes default logic to join a trace across HTTP or messaging boundaries. diff --git a/reference/html/index.html b/reference/html/index.html index cccec3ea0..f87d57094 100644 --- a/reference/html/index.html +++ b/reference/html/index.html @@ -199,10 +199,9 @@ $(globalSwitch);

  • 15.8. gRPC
  • 15.9. Asynchronous Communication
  • 15.10. Messaging
    • -
  • 15.11. Zuul
    • -
  • 15.12. Redis
    • -
  • 15.13. Quartz
    • -
  • 15.14. Project Reactor
    • +
  • 15.11. Redis
    • +
  • 15.12. Quartz
    • +
  • 15.13. Project Reactor
  • 16. Configuration properties
    • @@ -1168,7 +1167,7 @@ To that end, Sleuth:

  • -

    Instruments common ingress and egress points from Spring applications (servlet filter, async endpoints, rest template, scheduled actions, message channels, Zuul filters, and Feign client).

    +

    Instruments common ingress and egress points from Spring applications (servlet filter, async endpoints, rest template, scheduled actions, message channels, and Feign client).

  • Sleuth includes default logic to join a trace across HTTP or messaging boundaries. @@ -2155,10 +2154,6 @@ situation might be as follows:

  • AOP: If there was already a span created before an aspect was reached, you might not want to create a new span.

    • -
  • -

    Hystrix: Executing a Hystrix command is most likely a logical part of the current processing. -It is in fact merely a technical implementation detail that you would not necessarily want to reflect in tracing as a separate being.

    -
    • @@ -3441,9 +3436,7 @@ You can disable this behavior by setting the value of spring.sleuth.schedu
    -

    If you want to skip span creation for some @Scheduled annotated classes, you can set the spring.sleuth.scheduled.skipPattern with a regular expression that matches the fully qualified name of the @Scheduled annotated class. -If you use spring-cloud-sleuth-stream and spring-cloud-netflix-hystrix-stream together, a span is created for each Hystrix metrics and sent to Zipkin. -This behavior may be annoying. That’s why, by default, spring.sleuth.scheduled.skipPattern=org.springframework.cloud.netflix.hystrix.stream.HystrixStreamTask.

    +

    If you want to skip span creation for some @Scheduled annotated classes, you can set the spring.sleuth.scheduled.skipPattern with a regular expression that matches the fully qualified name of the @Scheduled annotated class.

    @@ -3644,21 +3637,14 @@ so that tracing headers get extracted from the message and a trace gets put into
    -

    15.11. Zuul

    -
    -

    We instrument the Zuul Ribbon integration by enriching the Ribbon requests with tracing information. -To disable Zuul support, set the spring.sleuth.zuul.enabled property to false.

    -
    -
    -
    -

    15.12. Redis

    +

    15.11. Redis

    We set tracing property to Lettcue ClientResources instance to enable Brave tracing built in Lettuce . To disable Redis support, set the spring.sleuth.redis.enabled property to false.

    -

    15.13. Quartz

    +

    15.12. Quartz

    We instrument quartz jobs by adding Job/Trigger listeners to the Quartz Scheduler.

    @@ -3667,7 +3653,7 @@ To disable Redis support, set the spring.sleuth.redis.enabled prope
    -

    15.14. Project Reactor

    +

    15.13. Project Reactor

    For projects depending on Project Reactor such as Spring Cloud Gateway, we suggest turning the spring.sleuth.reactor.decorate-on-each option to false. That way an increased performance gain should be observed in comparison to the standard instrumentation mechanism. What this option does is it will wrap decorate onLast operator instead of onEach which will result in creation of far fewer objects. The downside of this is that when Project Reactor will change threads, the trace propagation will continue without issues, however anything relying on the ThreadLocal such as e.g. MDC entries can be buggy.

    diff --git a/reference/html/sagan-index.html b/reference/html/sagan-index.html index 0709c7e8d..d5eb8a2e9 100644 --- a/reference/html/sagan-index.html +++ b/reference/html/sagan-index.html @@ -144,7 +144,7 @@ $(globalSwitch);

    Provides an abstraction over common distributed tracing data models: traces, spans (forming a DAG), annotations, key-value annotations. Loosely based on HTrace, but Zipkin (Dapper) compatible.

  • -

    Instruments common ingress and egress points from Spring applications (servlet filter, rest template, scheduled actions, message channels, zuul filters, feign client).

    +

    Instruments common ingress and egress points from Spring applications (servlet filter, rest template, scheduled actions, message channels, feign client).

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

    diff --git a/reference/html/spring-cloud-sleuth.html b/reference/html/spring-cloud-sleuth.html index cccec3ea0..f87d57094 100644 --- a/reference/html/spring-cloud-sleuth.html +++ b/reference/html/spring-cloud-sleuth.html @@ -199,10 +199,9 @@ $(globalSwitch);
  • 15.8. gRPC
  • 15.9. Asynchronous Communication
  • 15.10. Messaging
    • -
  • 15.11. Zuul
    • -
  • 15.12. Redis
    • -
  • 15.13. Quartz
    • -
  • 15.14. Project Reactor
    • +
  • 15.11. Redis
    • +
  • 15.12. Quartz
    • +
  • 15.13. Project Reactor
  • 16. Configuration properties
    • @@ -1168,7 +1167,7 @@ To that end, Sleuth:

  • -

    Instruments common ingress and egress points from Spring applications (servlet filter, async endpoints, rest template, scheduled actions, message channels, Zuul filters, and Feign client).

    +

    Instruments common ingress and egress points from Spring applications (servlet filter, async endpoints, rest template, scheduled actions, message channels, and Feign client).

  • Sleuth includes default logic to join a trace across HTTP or messaging boundaries. @@ -2155,10 +2154,6 @@ situation might be as follows:

  • AOP: If there was already a span created before an aspect was reached, you might not want to create a new span.

    • -
  • -

    Hystrix: Executing a Hystrix command is most likely a logical part of the current processing. -It is in fact merely a technical implementation detail that you would not necessarily want to reflect in tracing as a separate being.

    -
    • @@ -3441,9 +3436,7 @@ You can disable this behavior by setting the value of spring.sleuth.schedu
    -

    If you want to skip span creation for some @Scheduled annotated classes, you can set the spring.sleuth.scheduled.skipPattern with a regular expression that matches the fully qualified name of the @Scheduled annotated class. -If you use spring-cloud-sleuth-stream and spring-cloud-netflix-hystrix-stream together, a span is created for each Hystrix metrics and sent to Zipkin. -This behavior may be annoying. That’s why, by default, spring.sleuth.scheduled.skipPattern=org.springframework.cloud.netflix.hystrix.stream.HystrixStreamTask.

    +

    If you want to skip span creation for some @Scheduled annotated classes, you can set the spring.sleuth.scheduled.skipPattern with a regular expression that matches the fully qualified name of the @Scheduled annotated class.

    @@ -3644,21 +3637,14 @@ so that tracing headers get extracted from the message and a trace gets put into
    -

    15.11. Zuul

    -
    -

    We instrument the Zuul Ribbon integration by enriching the Ribbon requests with tracing information. -To disable Zuul support, set the spring.sleuth.zuul.enabled property to false.

    -
    -
    -
    -

    15.12. Redis

    +

    15.11. Redis

    We set tracing property to Lettcue ClientResources instance to enable Brave tracing built in Lettuce . To disable Redis support, set the spring.sleuth.redis.enabled property to false.

    -

    15.13. Quartz

    +

    15.12. Quartz

    We instrument quartz jobs by adding Job/Trigger listeners to the Quartz Scheduler.

    @@ -3667,7 +3653,7 @@ To disable Redis support, set the spring.sleuth.redis.enabled prope
    -

    15.14. Project Reactor

    +

    15.13. Project Reactor

    For projects depending on Project Reactor such as Spring Cloud Gateway, we suggest turning the spring.sleuth.reactor.decorate-on-each option to false. That way an increased performance gain should be observed in comparison to the standard instrumentation mechanism. What this option does is it will wrap decorate onLast operator instead of onEach which will result in creation of far fewer objects. The downside of this is that when Project Reactor will change threads, the trace propagation will continue without issues, however anything relying on the ThreadLocal such as e.g. MDC entries can be buggy.