diff --git a/reference/html/README.html b/reference/html/README.html index cf6eb95ec..1ebde52f9 100644 --- a/reference/html/README.html +++ b/reference/html/README.html @@ -497,7 +497,7 @@ An example from Kibana would resemble the following image:

filter {
   # pattern matching logback pattern
   grok {
-    match => { "message" => "%{TIMESTAMP_ISO8601:timestamp}\s+%{LOGLEVEL:severity}\s+\[%{DATA:service},%{DATA:trace},%{DATA:span},%{DATA:exportable}\]\s+%{DATA:pid}\s+---\s+\[%{DATA:thread}\]\s+%{DATA:class}\s+:\s+%{GREEDYDATA:rest}" }
+    match => { "message" => "%{TIMESTAMP_ISO8601:timestamp}\s+%{LOGLEVEL:severity}\s+\[%{DATA:service},%{DATA:trace},%{DATA:span}\]\s+%{DATA:pid}\s+---\s+\[%{DATA:thread}\]\s+%{DATA:class}\s+:\s+%{GREEDYDATA:rest}" }
   }
   date {
     match => ["timestamp", "ISO8601"]
@@ -525,7 +525,7 @@ If you want to use Grok together with the logs from Cloud Foundry, you have to u
 
filter {
   # pattern matching logback pattern
   grok {
-    match => { "message" => "(?m)OUT\s+%{TIMESTAMP_ISO8601:timestamp}\s+%{LOGLEVEL:severity}\s+\[%{DATA:service},%{DATA:trace},%{DATA:span},%{DATA:exportable}\]\s+%{DATA:pid}\s+---\s+\[%{DATA:thread}\]\s+%{DATA:class}\s+:\s+%{GREEDYDATA:rest}" }
+    match => { "message" => "(?m)OUT\s+%{TIMESTAMP_ISO8601:timestamp}\s+%{LOGLEVEL:severity}\s+\[%{DATA:service},%{DATA:trace},%{DATA:span}\]\s+%{DATA:pid}\s+---\s+\[%{DATA:thread}\]\s+%{DATA:class}\s+:\s+%{GREEDYDATA:rest}" }
   }
   date {
     match => ["timestamp", "ISO8601"]
diff --git a/reference/html/appendix.html b/reference/html/appendix.html
index bf24f8ef0..ff9e93a7e 100644
--- a/reference/html/appendix.html
+++ b/reference/html/appendix.html
@@ -176,27 +176,27 @@ Also, you can define your own properties.
 
 

spring.sleuth.baggage.correlation-enabled

true

-

Enable a {@link Slf4jScopeDecorator} that prints tracing information in the logs.

+

Adds a {@link CorrelationScopeDecorator} to put baggage values into the correlation context.

spring.sleuth.baggage.correlation-fields

-

A list of keys to be put from baggage to MDC.

+

A list of {@link BaggageField#name() fields} to add to correlation (MDC) context. @see CorrelationScopeConfig.SingleCorrelationField#create(BaggageField)

spring.sleuth.baggage.local-fields

-

Same as {@link #remoteKeys} except that this field is not propagated to remote services. @see brave.baggage.BaggagePropagationConfig.SingleBaggageField#local(BaggageField)

+

Same as {@link #remoteFields} except that this field is not propagated to remote services. @see BaggagePropagationConfig.SingleBaggageField#local(BaggageField)

spring.sleuth.baggage.remote-fields

-

List of fields that are referenced the same in-process as it is on the wire. For example, the name "x-vcap-request-id" would be set as-is including the prefix. <p> Note: {@code fieldName} will be implicitly lower-cased. @see brave.baggage.BaggagePropagationConfig.SingleBaggageField#remote(BaggageField)

+

List of fields that are referenced the same in-process as it is on the wire. For example, the field "x-vcap-request-id" would be set as-is including the prefix. @see BaggagePropagationConfig.SingleBaggageField#remote(BaggageField) @see BaggagePropagationConfig.SingleBaggageField.Builder#addKeyName(String)

spring.sleuth.baggage.tag-fields

-

A list of baggage field names which are tagged when a span finishes.

+

A list of {@link BaggageField#name() fields} to tag into the span. @see Tags#BAGGAGE_FIELD

spring.sleuth.circuitbreaker.enabled

diff --git a/reference/html/index.html b/reference/html/index.html index e0f74d240..3e0de2a5b 100644 --- a/reference/html/index.html +++ b/reference/html/index.html @@ -475,7 +475,7 @@ An example from Kibana would resemble the following image:

filter {
   # pattern matching logback pattern
   grok {
-    match => { "message" => "%{TIMESTAMP_ISO8601:timestamp}\s+%{LOGLEVEL:severity}\s+\[%{DATA:service},%{DATA:trace},%{DATA:span},%{DATA:exportable}\]\s+%{DATA:pid}\s+---\s+\[%{DATA:thread}\]\s+%{DATA:class}\s+:\s+%{GREEDYDATA:rest}" }
+    match => { "message" => "%{TIMESTAMP_ISO8601:timestamp}\s+%{LOGLEVEL:severity}\s+\[%{DATA:service},%{DATA:trace},%{DATA:span}\]\s+%{DATA:pid}\s+---\s+\[%{DATA:thread}\]\s+%{DATA:class}\s+:\s+%{GREEDYDATA:rest}" }
   }
   date {
     match => ["timestamp", "ISO8601"]
@@ -503,7 +503,7 @@ If you want to use Grok together with the logs from Cloud Foundry, you have to u
 
filter {
   # pattern matching logback pattern
   grok {
-    match => { "message" => "(?m)OUT\s+%{TIMESTAMP_ISO8601:timestamp}\s+%{LOGLEVEL:severity}\s+\[%{DATA:service},%{DATA:trace},%{DATA:span},%{DATA:exportable}\]\s+%{DATA:pid}\s+---\s+\[%{DATA:thread}\]\s+%{DATA:class}\s+:\s+%{GREEDYDATA:rest}" }
+    match => { "message" => "(?m)OUT\s+%{TIMESTAMP_ISO8601:timestamp}\s+%{LOGLEVEL:severity}\s+\[%{DATA:service},%{DATA:trace},%{DATA:span}\]\s+%{DATA:pid}\s+---\s+\[%{DATA:thread}\]\s+%{DATA:class}\s+:\s+%{GREEDYDATA:rest}" }
   }
   date {
     match => ["timestamp", "ISO8601"]
@@ -1300,7 +1300,7 @@ are some pointers.

5. Sampling

-

By default Spring Cloud Sleuth sets all spans to non-exportable. +

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.

@@ -1337,7 +1337,7 @@ public Sampler defaultSampler() { You can set the HTTP header b3 to 1, or, when doing messaging, you can set the spanFlags header to 1. -Doing so forces the current span to be exportable regardless of the sampling decision. +Doing so forces the current request to be sampled regardless of configuration. diff --git a/reference/html/intro.html b/reference/html/intro.html index 5b1574136..a930f1e9a 100644 --- a/reference/html/intro.html +++ b/reference/html/intro.html @@ -397,7 +397,7 @@ An example from Kibana would resemble the following image:

filter {
   # pattern matching logback pattern
   grok {
-    match => { "message" => "%{TIMESTAMP_ISO8601:timestamp}\s+%{LOGLEVEL:severity}\s+\[%{DATA:service},%{DATA:trace},%{DATA:span},%{DATA:exportable}\]\s+%{DATA:pid}\s+---\s+\[%{DATA:thread}\]\s+%{DATA:class}\s+:\s+%{GREEDYDATA:rest}" }
+    match => { "message" => "%{TIMESTAMP_ISO8601:timestamp}\s+%{LOGLEVEL:severity}\s+\[%{DATA:service},%{DATA:trace},%{DATA:span}\]\s+%{DATA:pid}\s+---\s+\[%{DATA:thread}\]\s+%{DATA:class}\s+:\s+%{GREEDYDATA:rest}" }
   }
   date {
     match => ["timestamp", "ISO8601"]
@@ -425,7 +425,7 @@ If you want to use Grok together with the logs from Cloud Foundry, you have to u
 
filter {
   # pattern matching logback pattern
   grok {
-    match => { "message" => "(?m)OUT\s+%{TIMESTAMP_ISO8601:timestamp}\s+%{LOGLEVEL:severity}\s+\[%{DATA:service},%{DATA:trace},%{DATA:span},%{DATA:exportable}\]\s+%{DATA:pid}\s+---\s+\[%{DATA:thread}\]\s+%{DATA:class}\s+:\s+%{GREEDYDATA:rest}" }
+    match => { "message" => "(?m)OUT\s+%{TIMESTAMP_ISO8601:timestamp}\s+%{LOGLEVEL:severity}\s+\[%{DATA:service},%{DATA:trace},%{DATA:span}\]\s+%{DATA:pid}\s+---\s+\[%{DATA:thread}\]\s+%{DATA:class}\s+:\s+%{GREEDYDATA:rest}" }
   }
   date {
     match => ["timestamp", "ISO8601"]
diff --git a/reference/html/spring-cloud-sleuth.html b/reference/html/spring-cloud-sleuth.html
index e0f74d240..3e0de2a5b 100644
--- a/reference/html/spring-cloud-sleuth.html
+++ b/reference/html/spring-cloud-sleuth.html
@@ -475,7 +475,7 @@ An example from Kibana would resemble the following image:

filter {
   # pattern matching logback pattern
   grok {
-    match => { "message" => "%{TIMESTAMP_ISO8601:timestamp}\s+%{LOGLEVEL:severity}\s+\[%{DATA:service},%{DATA:trace},%{DATA:span},%{DATA:exportable}\]\s+%{DATA:pid}\s+---\s+\[%{DATA:thread}\]\s+%{DATA:class}\s+:\s+%{GREEDYDATA:rest}" }
+    match => { "message" => "%{TIMESTAMP_ISO8601:timestamp}\s+%{LOGLEVEL:severity}\s+\[%{DATA:service},%{DATA:trace},%{DATA:span}\]\s+%{DATA:pid}\s+---\s+\[%{DATA:thread}\]\s+%{DATA:class}\s+:\s+%{GREEDYDATA:rest}" }
   }
   date {
     match => ["timestamp", "ISO8601"]
@@ -503,7 +503,7 @@ If you want to use Grok together with the logs from Cloud Foundry, you have to u
 
filter {
   # pattern matching logback pattern
   grok {
-    match => { "message" => "(?m)OUT\s+%{TIMESTAMP_ISO8601:timestamp}\s+%{LOGLEVEL:severity}\s+\[%{DATA:service},%{DATA:trace},%{DATA:span},%{DATA:exportable}\]\s+%{DATA:pid}\s+---\s+\[%{DATA:thread}\]\s+%{DATA:class}\s+:\s+%{GREEDYDATA:rest}" }
+    match => { "message" => "(?m)OUT\s+%{TIMESTAMP_ISO8601:timestamp}\s+%{LOGLEVEL:severity}\s+\[%{DATA:service},%{DATA:trace},%{DATA:span}\]\s+%{DATA:pid}\s+---\s+\[%{DATA:thread}\]\s+%{DATA:class}\s+:\s+%{GREEDYDATA:rest}" }
   }
   date {
     match => ["timestamp", "ISO8601"]
@@ -1300,7 +1300,7 @@ are some pointers.

5. Sampling

-

By default Spring Cloud Sleuth sets all spans to non-exportable. +

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.

@@ -1337,7 +1337,7 @@ public Sampler defaultSampler() { You can set the HTTP header b3 to 1, or, when doing messaging, you can set the spanFlags header to 1. -Doing so forces the current span to be exportable regardless of the sampling decision. +Doing so forces the current request to be sampled regardless of configuration.