SpringCloud/spring-cloud-sleuth
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixed properties and wrong images in the docs

Browse Source
This commit is contained in:
Marcin Grzejszczak
2020-11-25 07:47:48 +01:00
parent a21c33f841
commit 16a9d3633e
13 changed files with 32 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/src/main/asciidoc/getting-started.adoc
View File

@@ -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`.

2
spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/SleuthBaggageProperties.java
View File

@@ -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;

5
spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/SleuthOpentracingProperties.java
View File

@@ -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() {

2
spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/SleuthSpanFilterProperties.java
View File

@@ -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

4
spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/brave/SleuthPropagationProperties.java
View File

@@ -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<PropagationType> type = Collections.singletonList(PropagationType.B3);

2
spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/brave/SleuthProperties.java
View File

@@ -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

3
spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/instrument/async/SleuthAsyncProperties.java
View File

@@ -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() {

3
spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/instrument/web/SleuthHttpProperties.java
View File

@@ -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() {

2
spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/otel/OtelExporterProperties.java
View File

@@ -43,7 +43,7 @@ public class OtelExporterProperties {
public static class SleuthSpanFilter {
/**
* This application service name.
* Enables Sleuth span filter.
*/
private boolean enabled = true;

4
spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/otel/OtelLogProperties.java
View File

@@ -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;

6
spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/otel/OtelPropagationProperties.java
View File

@@ -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;

4
spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/otel/SleuthPropagationProperties.java
View File

@@ -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<PropagationType> type = Collections.singletonList(PropagationType.B3);

4
spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/zipkin2/ZipkinAutoConfiguration.java
View File

@@ -127,7 +127,7 @@ public class ZipkinAutoConfiguration {
@Bean(REPORTER_BEAN_NAME)
@ConditionalOnMissingBean(name = REPORTER_BEAN_NAME)
public Reporter<Span> reporter(ReporterMetrics reporterMetrics, ZipkinProperties zipkin,
Reporter<Span> 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);
}