From 16a9d3633e929cdb5e5a1ba30556e42d3ba6c485 Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Wed, 25 Nov 2020 07:47:48 +0100 Subject: [PATCH] Fixed properties and wrong images in the docs --- docs/src/main/asciidoc/getting-started.adoc | 10 +++++----- .../sleuth/autoconfig/SleuthBaggageProperties.java | 2 +- .../sleuth/autoconfig/SleuthOpentracingProperties.java | 5 ++++- .../sleuth/autoconfig/SleuthSpanFilterProperties.java | 2 +- .../autoconfig/brave/SleuthPropagationProperties.java | 4 ++-- .../sleuth/autoconfig/brave/SleuthProperties.java | 2 +- .../instrument/async/SleuthAsyncProperties.java | 3 +++ .../instrument/web/SleuthHttpProperties.java | 3 +++ .../sleuth/autoconfig/otel/OtelExporterProperties.java | 2 +- .../sleuth/autoconfig/otel/OtelLogProperties.java | 4 ++-- .../autoconfig/otel/OtelPropagationProperties.java | 6 +++++- .../autoconfig/otel/SleuthPropagationProperties.java | 4 ++-- .../autoconfig/zipkin2/ZipkinAutoConfiguration.java | 4 ++-- 13 files changed, 32 insertions(+), 19 deletions(-) diff --git a/docs/src/main/asciidoc/getting-started.adoc b/docs/src/main/asciidoc/getting-started.adoc index bb4fc3ed3..de3f57719 100644 --- a/docs/src/main/asciidoc/getting-started.adoc +++ b/docs/src/main/asciidoc/getting-started.adoc @@ -55,7 +55,7 @@ Subtracting the `cs` timestamp from this timestamp reveals the whole time needed The following image shows how *Span* and *Trace* look in a system. -image::{github-raw}/docs/src/main/asciidoc/images/trace-id.png[Trace Info propagation] +image::{github-raw}/docs/src/main/asciidoc/images/trace-id.jpg[Trace Info propagation] Each color of a note signifies a span (there are seven spans - from *A* to *G*). Consider the following note: @@ -87,7 +87,7 @@ You can continue with a created span (example with `no custom span` indication) The following image shows how parent-child relationships of spans look: -image::{github-raw}/docs/src/main/asciidoc/images/parents.png[Parent child relationship] +image::{github-raw}/docs/src/main/asciidoc/images/parents.jpg[Parent child relationship] [[getting-started-first-application]] == Developing Your First Spring Cloud sleuth-based Application @@ -301,11 +301,11 @@ If you check the logs you should see a similar output [indent=0] ---- -2020-10-21 12:01:16.285 INFO [backend,0b6aaf642574edd3,0b6aaf642574edd3,true] 289589 --- [nio-9000-exec-1] Example : Hello world! +2020-10-21 12:01:16.285 INFO [backend,0b6aaf642574edd3,0b6aaf642574edd3] 289589 --- [nio-9000-exec-1] Example : Hello world! ---- -You can notice that the logging format has been updated with the following information `[backend,0b6aaf642574edd3,0b6aaf642574edd3,true]`. -This entry corresponds to `[application name,trace id, span id, whether the trace should be propagated to an external system]`. +You can notice that the logging format has been updated with the following information `[backend,0b6aaf642574edd3,0b6aaf642574edd3`. +This entry corresponds to `[application name,trace id, span id]`. The application name got read from the `SPRING_APPLICATION_NAME` environment variable. NOTE: Instead of logging the request in the handler explicitly, you could set `logging.level.org.springframework.web.servlet.DispatcherServlet=DEBUG`. diff --git a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/SleuthBaggageProperties.java b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/SleuthBaggageProperties.java index a590d1af7..da35ebf8b 100644 --- a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/SleuthBaggageProperties.java +++ b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/SleuthBaggageProperties.java @@ -31,7 +31,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties; public class SleuthBaggageProperties { /** - * context. + * Enables correlating the baggage context with logging contexts. */ private boolean correlationEnabled = true; diff --git a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/SleuthOpentracingProperties.java b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/SleuthOpentracingProperties.java index 1f39984e1..b697c706e 100644 --- a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/SleuthOpentracingProperties.java +++ b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/SleuthOpentracingProperties.java @@ -19,7 +19,7 @@ package org.springframework.cloud.sleuth.autoconfig; import org.springframework.boot.context.properties.ConfigurationProperties; /** - * Sleuth Opentracing settings. + * Sleuth OpenTracing settings. * * @author Marcin Grzejszczak * @since 2.0.0 @@ -27,6 +27,9 @@ import org.springframework.boot.context.properties.ConfigurationProperties; @ConfigurationProperties("spring.sleuth.opentracing") public class SleuthOpentracingProperties { + /** + * Enables OpenTracing support. + */ private boolean enabled = true; public boolean isEnabled() { diff --git a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/SleuthSpanFilterProperties.java b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/SleuthSpanFilterProperties.java index e780c5942..5c53b92c5 100644 --- a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/SleuthSpanFilterProperties.java +++ b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/SleuthSpanFilterProperties.java @@ -23,7 +23,7 @@ import java.util.List; import org.springframework.boot.context.properties.ConfigurationProperties; /** - * Sleuth settings. + * Sleuth settings for span filtering. * * @author Marcin Grzejszczak * @since 1.0.11 diff --git a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/brave/SleuthPropagationProperties.java b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/brave/SleuthPropagationProperties.java index 958742d22..e2ecffea0 100644 --- a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/brave/SleuthPropagationProperties.java +++ b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/brave/SleuthPropagationProperties.java @@ -23,7 +23,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.cloud.sleuth.brave.propagation.PropagationType; /** - * Sleuth settings for OpenTelemetry. + * Sleuth propagation settings. * * @author Marcin Grzejszczak * @since 3.0.0 @@ -32,7 +32,7 @@ import org.springframework.cloud.sleuth.brave.propagation.PropagationType; public class SleuthPropagationProperties { /** - * Type of propagation. + * Tracing context propagation types. */ private List type = Collections.singletonList(PropagationType.B3); diff --git a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/brave/SleuthProperties.java b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/brave/SleuthProperties.java index 9efa97349..39dc6aaa9 100644 --- a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/brave/SleuthProperties.java +++ b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/brave/SleuthProperties.java @@ -19,7 +19,7 @@ package org.springframework.cloud.sleuth.autoconfig.brave; import org.springframework.boot.context.properties.ConfigurationProperties; /** - * Sleuth settings. + * Brave Sleuth settings. * * @author Marcin Grzejszczak * @since 1.0.11 diff --git a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/instrument/async/SleuthAsyncProperties.java b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/instrument/async/SleuthAsyncProperties.java index 5f6033846..2aac2a055 100644 --- a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/instrument/async/SleuthAsyncProperties.java +++ b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/instrument/async/SleuthAsyncProperties.java @@ -30,6 +30,9 @@ import org.springframework.boot.context.properties.ConfigurationProperties; @ConfigurationProperties(prefix = "spring.sleuth.async") public class SleuthAsyncProperties { + /** + * Enable default AsyncConfigurer. + */ private boolean enabled; public boolean isEnabled() { diff --git a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/instrument/web/SleuthHttpProperties.java b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/instrument/web/SleuthHttpProperties.java index 03f7f77ee..8501644d6 100644 --- a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/instrument/web/SleuthHttpProperties.java +++ b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/instrument/web/SleuthHttpProperties.java @@ -27,6 +27,9 @@ import org.springframework.boot.context.properties.ConfigurationProperties; @ConfigurationProperties("spring.sleuth.http") public class SleuthHttpProperties { + /** + * Enables HTTP support. + */ private boolean enabled = true; public boolean isEnabled() { diff --git a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/otel/OtelExporterProperties.java b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/otel/OtelExporterProperties.java index 5a0ae1b25..243e2a31b 100644 --- a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/otel/OtelExporterProperties.java +++ b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/otel/OtelExporterProperties.java @@ -43,7 +43,7 @@ public class OtelExporterProperties { public static class SleuthSpanFilter { /** - * This application service name. + * Enables Sleuth span filter. */ private boolean enabled = true; diff --git a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/otel/OtelLogProperties.java b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/otel/OtelLogProperties.java index 74f1359c9..2021851db 100644 --- a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/otel/OtelLogProperties.java +++ b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/otel/OtelLogProperties.java @@ -50,7 +50,7 @@ public class OtelLogProperties { public static class Exporter { /** - * Enable log support for Otel. + * Enable log exporter for OTel. */ private boolean enabled = false; @@ -67,7 +67,7 @@ public class OtelLogProperties { public static class Slf4j { /** - * Enable log support for Otel. + * Enable slf4j support for OTel. */ private boolean enabled; diff --git a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/otel/OtelPropagationProperties.java b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/otel/OtelPropagationProperties.java index e5a6ed768..b64e9db28 100644 --- a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/otel/OtelPropagationProperties.java +++ b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/otel/OtelPropagationProperties.java @@ -39,7 +39,11 @@ public class OtelPropagationProperties { public static class SleuthBaggage { - private boolean enabled = true; + /** + * Enables default B3 Sleuth Baggage propagation. This will be automatically + * turned on when B3 propagation type gets picked. + */ + private boolean enabled; public boolean isEnabled() { return this.enabled; diff --git a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/otel/SleuthPropagationProperties.java b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/otel/SleuthPropagationProperties.java index 88ac08932..9a9c09469 100644 --- a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/otel/SleuthPropagationProperties.java +++ b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/otel/SleuthPropagationProperties.java @@ -23,7 +23,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.cloud.sleuth.otel.propagation.PropagationType; /** - * Sleuth settings for OpenTelemetry. + * Sleuth propagation types. * * @author Marcin Grzejszczak * @since 3.0.0 @@ -32,7 +32,7 @@ import org.springframework.cloud.sleuth.otel.propagation.PropagationType; public class SleuthPropagationProperties { /** - * Type of propagation. + * Tracing context propagation types. */ private List type = Collections.singletonList(PropagationType.B3); diff --git a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/zipkin2/ZipkinAutoConfiguration.java b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/zipkin2/ZipkinAutoConfiguration.java index 5f14d057b..a124e1f62 100644 --- a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/zipkin2/ZipkinAutoConfiguration.java +++ b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/zipkin2/ZipkinAutoConfiguration.java @@ -127,7 +127,7 @@ public class ZipkinAutoConfiguration { @Bean(REPORTER_BEAN_NAME) @ConditionalOnMissingBean(name = REPORTER_BEAN_NAME) - public Reporter reporter(ReporterMetrics reporterMetrics, ZipkinProperties zipkin, + Reporter reporter(ReporterMetrics reporterMetrics, ZipkinProperties zipkin, @Qualifier(SENDER_BEAN_NAME) Sender sender) { CheckResult checkResult = checkResult(sender, 1_000L); logCheckResult(sender, checkResult); @@ -151,7 +151,7 @@ public class ZipkinAutoConfiguration { @Bean @ConditionalOnMissingBean - public ZipkinRestTemplateCustomizer zipkinRestTemplateCustomizer(ZipkinProperties zipkinProperties) { + ZipkinRestTemplateCustomizer zipkinRestTemplateCustomizer(ZipkinProperties zipkinProperties) { return new DefaultZipkinRestTemplateCustomizer(zipkinProperties); }