Skip to content

Commit 303d10f

Browse files
Updated readme
1 parent c094878 commit 303d10f

File tree

2 files changed

+10
-24
lines changed

2 files changed

+10
-24
lines changed

README.adoc

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,18 @@ Edit the files in the src/main/asciidoc/ directory instead.
88
:jdkversion: 1.8
99

1010
image::https://github.com/spring-cloud-incubator/spring-cloud-sleuth-otel/workflows/Build/badge.svg?style=svg["Build",link="https://github.com/spring-cloud-incubator/spring-cloud-sleuth-otel/actions"]
11-
image::https://badges.gitter.im/spring-cloud-incubator/spring-cloud-sleuth-otel.svg[Gitter,link="https://gitter.im/spring-cloud-incubator/spring-cloud-sleuth-otel?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"]
11+
image::https://badges.gitter.im/spring-cloud/spring-cloud-sleuth.svg[Gitter,link="https://gitter.im/spring-cloud/spring-cloud-sleuth?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"]
1212

13-
== Spring Cloud Sleuth
13+
== Spring Cloud Sleuth OTel
1414

15-
Spring Cloud Sleuth provides Spring Boot auto-configuration for distributed tracing.
15+
Spring Cloud Sleuth provides Spring Boot auto-configuration for OpenTelemetry based distributed tracing.
1616

1717
Sleuth configures everything you need to get started.
1818
This includes where trace data (spans) are reported to, how many traces to keep (sampling), if remote fields (baggage) are sent, and which libraries are traced.
1919

2020
=== Quick Start
2121

2222
Add Spring Cloud Sleuth to the classpath of a Spring Boot application (together with a Tracer implementation) and you will see trace IDs in logs.
23-
Example of Sleuth with Brave tracer:
2423

2524
[source,xml,indent=0,subs="verbatim,quotes,attributes"]
2625
----
@@ -44,13 +43,7 @@ Example of Sleuth with Brave tracer:
4443
<groupId>org.springframework.boot</groupId>
4544
<artifactId>spring-boot-starter-web</artifactId>
4645
</dependency>
47-
<!-- Sleuth with Brave tracer implementation -->
48-
<dependency>
49-
<groupId>org.springframework.cloud</groupId>
50-
<artifactId>spring-cloud-starter-sleuth</artifactId>
51-
</dependency>
5246
<!-- Sleuth with OpenTelemetry tracer implementation -->
53-
<!--
5447
<dependency>
5548
<groupId>org.springframework.cloud</groupId>
5649
<artifactId>spring-cloud-starter-sleuth</artifactId>
@@ -61,11 +54,11 @@ Example of Sleuth with Brave tracer:
6154
</exclusion>
6255
</exclusions>
6356
</dependency>
57+
<!-- This dependency adds OTel support -->
6458
<dependency>
6559
<groupId>org.springframework.cloud</groupId>
6660
<artifactId>spring-cloud-sleuth-otel</artifactId>
6761
</dependency>
68-
-->
6962
</dependencies>
7063
----
7164

@@ -99,7 +92,7 @@ NOTE: Set `spring.application.name=myService` (for instance) to see the service
9992

10093
== Documentation
10194

102-
Please visit the https://docs.spring.io/spring-cloud-sleuth/docs/[documentation page] to read more about the project.
95+
Please visit the https://docs.spring.io/spring-cloud-sleuth/docs/[Spring Cloud Sleuth documentation page] to read more about the Spring Cloud Sleuth project.
10396

10497
== Building
10598

docs/src/main/asciidoc/README.adoc

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
:jdkversion: 1.8
22

33
image::https://github.com/spring-cloud-incubator/spring-cloud-sleuth-otel/workflows/Build/badge.svg?style=svg["Build",link="https://github.com/spring-cloud-incubator/spring-cloud-sleuth-otel/actions"]
4-
image::https://badges.gitter.im/spring-cloud-incubator/spring-cloud-sleuth-otel.svg[Gitter,link="https://gitter.im/spring-cloud-incubator/spring-cloud-sleuth-otel?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"]
4+
image::https://badges.gitter.im/spring-cloud/spring-cloud-sleuth.svg[Gitter,link="https://gitter.im/spring-cloud/spring-cloud-sleuth?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"]
55

6-
== Spring Cloud Sleuth
6+
== Spring Cloud Sleuth OTel
77

8-
Spring Cloud Sleuth provides Spring Boot auto-configuration for distributed tracing.
8+
Spring Cloud Sleuth provides Spring Boot auto-configuration for OpenTelemetry based distributed tracing.
99

1010
Sleuth configures everything you need to get started.
1111
This includes where trace data (spans) are reported to, how many traces to keep (sampling), if remote fields (baggage) are sent, and which libraries are traced.
1212

1313
=== Quick Start
1414

1515
Add Spring Cloud Sleuth to the classpath of a Spring Boot application (together with a Tracer implementation) and you will see trace IDs in logs.
16-
Example of Sleuth with Brave tracer:
1716

1817
[source,xml,indent=0,subs="verbatim,quotes,attributes"]
1918
----
@@ -37,13 +36,7 @@ Example of Sleuth with Brave tracer:
3736
<groupId>org.springframework.boot</groupId>
3837
<artifactId>spring-boot-starter-web</artifactId>
3938
</dependency>
40-
<!-- Sleuth with Brave tracer implementation -->
41-
<dependency>
42-
<groupId>org.springframework.cloud</groupId>
43-
<artifactId>spring-cloud-starter-sleuth</artifactId>
44-
</dependency>
4539
<!-- Sleuth with OpenTelemetry tracer implementation -->
46-
<!--
4740
<dependency>
4841
<groupId>org.springframework.cloud</groupId>
4942
<artifactId>spring-cloud-starter-sleuth</artifactId>
@@ -54,11 +47,11 @@ Example of Sleuth with Brave tracer:
5447
</exclusion>
5548
</exclusions>
5649
</dependency>
50+
<!-- This dependency adds OTel support -->
5751
<dependency>
5852
<groupId>org.springframework.cloud</groupId>
5953
<artifactId>spring-cloud-sleuth-otel</artifactId>
6054
</dependency>
61-
-->
6255
</dependencies>
6356
----
6457

@@ -92,7 +85,7 @@ NOTE: Set `spring.application.name=myService` (for instance) to see the service
9285

9386
== Documentation
9487

95-
Please visit the https://docs.spring.io/spring-cloud-sleuth/docs/[documentation page] to read more about the project.
88+
Please visit the https://docs.spring.io/spring-cloud-sleuth/docs/[Spring Cloud Sleuth documentation page] to read more about the Spring Cloud Sleuth project.
9689

9790
== Building
9891

0 commit comments

Comments
 (0)