From c2a031fca4b842a2b9477bca2419f973db76a9ab Mon Sep 17 00:00:00 2001 From: buildmaster Date: Thu, 23 Apr 2020 11:44:15 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- reference/html/README.html | 1 + reference/html/features.html | 1 + reference/html/index.html | 31 ++++++++----------------- reference/html/spring-cloud-sleuth.html | 31 ++++++++----------------- 4 files changed, 22 insertions(+), 42 deletions(-) diff --git a/reference/html/README.html b/reference/html/README.html index 3998a2f39..95a9b6871 100644 --- a/reference/html/README.html +++ b/reference/html/README.html @@ -434,6 +434,7 @@ like so:

spring:
   sleuth:
     baggage:
+      foo: bar
       remoteFields:
         - country-code
         - x-vcap-request-id
diff --git a/reference/html/features.html b/reference/html/features.html
index 0485bef0f..4a89c2268 100644
--- a/reference/html/features.html
+++ b/reference/html/features.html
@@ -277,6 +277,7 @@ like so:

 
spring:
   sleuth:
     baggage:
+      foo: bar
       remoteFields:
         - country-code
         - x-vcap-request-id
diff --git a/reference/html/index.html b/reference/html/index.html
index ba3a6f4b0..6cbbdae93 100644
--- a/reference/html/index.html
+++ b/reference/html/index.html
@@ -403,6 +403,7 @@ like so:

 
spring:
   sleuth:
     baggage:
+      foo: bar
       remoteFields:
         - country-code
         - x-vcap-request-id
@@ -810,26 +811,17 @@ are some pointers.

 
5. Sampling

 

 

-
By default Spring Cloud Sleuth doesn’t sample spans.
-That means that traces appear in logs but not in any remote store.
-For testing the default is often enough, and it probably is all you need if you use only the logs (for example, with an ELK aggregator).
-If you export span data to Zipkin, there is also an Sampler.ALWAYS_SAMPLE setting that exports everything, RateLimitingSampler setting that samples X transactions per second (defaults to 1000) or ProbabilityBasedSampler setting that samples a fixed fraction of spans.

-

-

-
-
-
-
-
-

-
-
-The RateLimitingSampler is the default if you use spring-cloud-sleuth-zipkin.
-You can configure the rate limit by setting spring.sleuth.sampler.rate.
-

+
Sampling only applies to tracing backends, such as Zipkin. Trace IDs appear in logs regardless of
+sample rate. Sampling is a way to prevent overloading the system, by consistently tracing some, but
+not all requests.

 

 

-
A sampler can be installed by creating a bean definition, as shown in the following example:

+
The default rate of 10 traces per second is controlled by the spring.sleuth.sampler.rate
+property and applies when we know Sleuth is used for reasons besides logging. Use a rate above 100
+traces per second with extreme caution as it can overload your tracing system.

+

+

+
The sampler can be set by Java Config also, as shown in the following example:

 

 

 

@@ -852,9 +844,6 @@ Doing so forces the current request to be sampled regardless of configuration.
 
 
 

-

-
In order to use the rate-limited sampler set the spring.sleuth.sampler.rate property to choose an amount of traces to accept on a per-second interval. The minimum number is 0 and the max is 2,147,483,647 (max int).

-

 

 

 

diff --git a/reference/html/spring-cloud-sleuth.html b/reference/html/spring-cloud-sleuth.html
index ba3a6f4b0..6cbbdae93 100644
--- a/reference/html/spring-cloud-sleuth.html
+++ b/reference/html/spring-cloud-sleuth.html
@@ -403,6 +403,7 @@ like so:

 
spring:
   sleuth:
     baggage:
+      foo: bar
       remoteFields:
         - country-code
         - x-vcap-request-id
@@ -810,26 +811,17 @@ are some pointers.

 
5. Sampling

 

 

-
By default Spring Cloud Sleuth doesn’t sample spans.
-That means that traces appear in logs but not in any remote store.
-For testing the default is often enough, and it probably is all you need if you use only the logs (for example, with an ELK aggregator).
-If you export span data to Zipkin, there is also an Sampler.ALWAYS_SAMPLE setting that exports everything, RateLimitingSampler setting that samples X transactions per second (defaults to 1000) or ProbabilityBasedSampler setting that samples a fixed fraction of spans.

-

-

-
-
-
-
-
-

-
-
-The RateLimitingSampler is the default if you use spring-cloud-sleuth-zipkin.
-You can configure the rate limit by setting spring.sleuth.sampler.rate.
-

+
Sampling only applies to tracing backends, such as Zipkin. Trace IDs appear in logs regardless of
+sample rate. Sampling is a way to prevent overloading the system, by consistently tracing some, but
+not all requests.

 

 

-
A sampler can be installed by creating a bean definition, as shown in the following example:

+
The default rate of 10 traces per second is controlled by the spring.sleuth.sampler.rate
+property and applies when we know Sleuth is used for reasons besides logging. Use a rate above 100
+traces per second with extreme caution as it can overload your tracing system.

+

+

+
The sampler can be set by Java Config also, as shown in the following example:

 

 

 

@@ -852,9 +844,6 @@ Doing so forces the current request to be sampled regardless of configuration.
 
 
 

-

-
In order to use the rate-limited sampler set the spring.sleuth.sampler.rate property to choose an amount of traces to accept on a per-second interval. The minimum number is 0 and the max is 2,147,483,647 (max int).

-