Skip to content

Commit 957334d

Browse files
marcingrzejszczakmarcingrzejszczak
committed
Updated docs
1 parent 43772b1 commit 957334d

File tree

4 files changed

+277
-11
lines changed

4 files changed

+277
-11
lines changed

‎docs/src/main/asciidoc/getting-started.adoc‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,19 @@ Open your favorite text editor and add the following:
6262
<type>pom</type>
6363
<scope>import</scope>
6464
</dependency>
65+
<!-- Spring Cloud Sleuth OTel requires a Spring Cloud Sleuth OTel BOM -->
66+
<dependency>
67+
<groupId>org.springframework.cloud</groupId>
68+
<artifactId>spring-cloud-sleuth-otel-dependencies</artifactId>
69+
<!-- Provide the version of the Spring Cloud Sleuth OpenTelemetry project -->
70+
<version>${spring-cloud-sleuth-otel.version}</version>
71+
<scope>import</scope>
72+
<type>pom</type>
73+
</dependency>
6574
</dependencies>
6675
</dependencyManagement>
6776
68-
<!-- (you don't need this if you are using a GA version) -->
77+
<!-- You 'll need those to add OTel support -->
6978
<repositories>
7079
<repository>
7180
<id>spring-snapshots</id>
@@ -114,7 +123,7 @@ To add the necessary dependencies, edit your `pom.xml` and add the `spring-boot-
114123
<groupId>org.springframework.cloud</groupId>
115124
<artifactId>spring-cloud-starter-sleuth</artifactId>
116125
<exclusions>
117-
<!-- Exclude Brave -->
126+
<!-- Exclude Brave (the default) -->
118127
<exclusion>
119128
<groupId>org.springframework.cloud</groupId>
120129
<artifactId>spring-cloud-sleuth-brave</artifactId>

‎docs/src/main/asciidoc/howto.adoc‎

Lines changed: 197 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,29 @@ Add the Sleuth starter, exclude Brave and add OpenTelemetry dependency to the cl
5757
<groupId>org.springframework.cloud</groupId>
5858
<artifactId>spring-cloud-sleuth-otel-autoconfigure</artifactId>
5959
</dependency>
60+
61+
<!-- You 'll need those to add OTel support -->
62+
<repositories>
63+
<repository>
64+
<id>spring-snapshots</id>
65+
<url>https://repo.spring.io/snapshot</url>
66+
<snapshots><enabled>true</enabled></snapshots>
67+
</repository>
68+
<repository>
69+
<id>spring-milestones</id>
70+
<url>https://repo.spring.io/milestone</url>
71+
</repository>
72+
</repositories>
73+
<pluginRepositories>
74+
<pluginRepository>
75+
<id>spring-snapshots</id>
76+
<url>https://repo.spring.io/snapshot</url>
77+
</pluginRepository>
78+
<pluginRepository>
79+
<id>spring-milestones</id>
80+
<url>https://repo.spring.io/milestone</url>
81+
</pluginRepository>
82+
</pluginRepositories>
6083
----
6184
6285
[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"]
@@ -65,13 +88,28 @@ Add the Sleuth starter, exclude Brave and add OpenTelemetry dependency to the cl
6588
dependencyManagement {
6689
imports {
6790
mavenBom "org.springframework.cloud:spring-cloud-dependencies:${releaseTrainVersion}"
91+
mavenBom "org.springframework.cloud:spring-cloud-sleuth-otel-dependencies:${springCloudSleuthOtelVersion}"
6892
}
6993
}
7094
7195
dependencies {
7296
implementation("org.springframework.cloud:spring-cloud-starter-sleuth") {
7397
exclude group: 'org.springframework.cloud', module: 'spring-cloud-sleuth-brave'
7498
}
99+
implementation "org.springframework.cloud:spring-cloud-sleuth-otel-autoconfigure"
100+
}
101+
102+
repositories {
103+
mavenCentral()
104+
maven {
105+
url "https://repo.spring.io/snapshot"
106+
}
107+
maven {
108+
url "https://repo.spring.io/milestone"
109+
}
110+
maven {
111+
url "https://repo.spring.io/release"
112+
}
75113
}
76114
----
77115
====
@@ -124,6 +162,30 @@ Add the Sleuth starter, exclude Brave, add OTel and Zipkin to the classpath.
124162
<groupId>org.springframework.cloud</groupId>
125163
<artifactId>spring-cloud-sleuth-zipkin</artifactId>
126164
</dependency>
165+
166+
167+
<!-- You 'll need those to add OTel support -->
168+
<repositories>
169+
<repository>
170+
<id>spring-snapshots</id>
171+
<url>https://repo.spring.io/snapshot</url>
172+
<snapshots><enabled>true</enabled></snapshots>
173+
</repository>
174+
<repository>
175+
<id>spring-milestones</id>
176+
<url>https://repo.spring.io/milestone</url>
177+
</repository>
178+
</repositories>
179+
<pluginRepositories>
180+
<pluginRepository>
181+
<id>spring-snapshots</id>
182+
<url>https://repo.spring.io/snapshot</url>
183+
</pluginRepository>
184+
<pluginRepository>
185+
<id>spring-milestones</id>
186+
<url>https://repo.spring.io/milestone</url>
187+
</pluginRepository>
188+
</pluginRepositories>
127189
----
128190
129191
[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"]
@@ -132,15 +194,31 @@ Add the Sleuth starter, exclude Brave, add OTel and Zipkin to the classpath.
132194
dependencyManagement {
133195
imports {
134196
mavenBom "org.springframework.cloud:spring-cloud-dependencies:${releaseTrainVersion}"
197+
mavenBom "org.springframework.cloud:spring-cloud-sleuth-otel-dependencies:${springCloudSleuthOtelVersion}"
135198
}
136199
}
137200
138201
dependencies {
139202
implementation("org.springframework.cloud:spring-cloud-starter-sleuth") {
140203
exclude group: 'org.springframework.cloud', module: 'spring-cloud-sleuth-brave'
141204
}
205+
implementation "org.springframework.cloud:spring-cloud-sleuth-otel-autoconfigure"
142206
implementation "org.springframework.cloud:spring-cloud-sleuth-zipkin"
143207
}
208+
209+
repositories {
210+
mavenCentral()
211+
maven {
212+
url "https://repo.spring.io/snapshot"
213+
}
214+
maven {
215+
url "https://repo.spring.io/milestone"
216+
}
217+
maven {
218+
url "https://repo.spring.io/release"
219+
}
220+
}
221+
144222
----
145223
====
146224

@@ -199,6 +277,30 @@ If using Kafka, you must add the Kafka dependency.
199277
<groupId>org.springframework.kafka</groupId>
200278
<artifactId>spring-kafka</artifactId>
201279
</dependency>
280+
281+
282+
<!-- You 'll need those to add OTel support -->
283+
<repositories>
284+
<repository>
285+
<id>spring-snapshots</id>
286+
<url>https://repo.spring.io/snapshot</url>
287+
<snapshots><enabled>true</enabled></snapshots>
288+
</repository>
289+
<repository>
290+
<id>spring-milestones</id>
291+
<url>https://repo.spring.io/milestone</url>
292+
</repository>
293+
</repositories>
294+
<pluginRepositories>
295+
<pluginRepository>
296+
<id>spring-snapshots</id>
297+
<url>https://repo.spring.io/snapshot</url>
298+
</pluginRepository>
299+
<pluginRepository>
300+
<id>spring-milestones</id>
301+
<url>https://repo.spring.io/milestone</url>
302+
</pluginRepository>
303+
</pluginRepositories>
202304
----
203305
204306
[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"]
@@ -207,16 +309,31 @@ If using Kafka, you must add the Kafka dependency.
207309
dependencyManagement {
208310
imports {
209311
mavenBom "org.springframework.cloud:spring-cloud-dependencies:${releaseTrainVersion}"
312+
mavenBom "org.springframework.cloud:spring-cloud-sleuth-otel-dependencies:${springCloudSleuthOtelVersion}"
210313
}
211314
}
212315
213316
dependencies {
214317
implementation("org.springframework.cloud:spring-cloud-starter-sleuth") {
215318
exclude group: 'org.springframework.cloud', module: 'spring-cloud-sleuth-brave'
216319
}
320+
implementation "org.springframework.cloud:spring-cloud-sleuth-otel-autoconfigure"
217321
implementation "org.springframework.cloud:spring-cloud-sleuth-zipkin"
218322
implementation "org.springframework.kafka:spring-kafka"
219323
}
324+
325+
repositories {
326+
mavenCentral()
327+
maven {
328+
url "https://repo.spring.io/snapshot"
329+
}
330+
maven {
331+
url "https://repo.spring.io/milestone"
332+
}
333+
maven {
334+
url "https://repo.spring.io/release"
335+
}
336+
}
220337
----
221338
====
222339

@@ -266,6 +383,30 @@ If you want Sleuth over RabbitMQ, add the `spring-cloud-sleuth-otel` (exclude `s
266383
<groupId>org.springframework.amqp</groupId>
267384
<artifactId>spring-rabbit</artifactId>
268385
</dependency>
386+
387+
388+
<!-- You 'll need those to add OTel support -->
389+
<repositories>
390+
<repository>
391+
<id>spring-snapshots</id>
392+
<url>https://repo.spring.io/snapshot</url>
393+
<snapshots><enabled>true</enabled></snapshots>
394+
</repository>
395+
<repository>
396+
<id>spring-milestones</id>
397+
<url>https://repo.spring.io/milestone</url>
398+
</repository>
399+
</repositories>
400+
<pluginRepositories>
401+
<pluginRepository>
402+
<id>spring-snapshots</id>
403+
<url>https://repo.spring.io/snapshot</url>
404+
</pluginRepository>
405+
<pluginRepository>
406+
<id>spring-milestones</id>
407+
<url>https://repo.spring.io/milestone</url>
408+
</pluginRepository>
409+
</pluginRepositories>
269410
----
270411
271412
[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"]
@@ -274,14 +415,30 @@ If you want Sleuth over RabbitMQ, add the `spring-cloud-sleuth-otel` (exclude `s
274415
dependencyManagement {
275416
imports {
276417
mavenBom "org.springframework.cloud:spring-cloud-dependencies:${releaseTrainVersion}"
418+
mavenBom "org.springframework.cloud:spring-cloud-sleuth-otel-dependencies:${springCloudSleuthOtelVersion}"
277419
}
278420
}
279421
280422
dependencies {
281-
implementation "org.springframework.cloud:spring-cloud-starter-sleuth"
423+
implementation("org.springframework.cloud:spring-cloud-starter-sleuth") {
424+
exclude group: 'org.springframework.cloud', module: 'spring-cloud-sleuth-brave'
425+
}
282426
implementation "org.springframework.cloud:spring-cloud-sleuth-zipkin"
283427
implementation "org.springframework.amqp:spring-rabbit"
284428
}
429+
430+
repositories {
431+
mavenCentral()
432+
maven {
433+
url "https://repo.spring.io/snapshot"
434+
}
435+
maven {
436+
url "https://repo.spring.io/milestone"
437+
}
438+
maven {
439+
url "https://repo.spring.io/release"
440+
}
441+
}
285442
----
286443
====
287444

@@ -334,6 +491,30 @@ If you want Sleuth over RabbitMQ, add the `spring-cloud-sleuth-otel` (exclude `s
334491
<groupId>org.apache.activemq</groupId>
335492
<artifactId>activemq-client</artifactId>
336493
</dependency>
494+
495+
496+
<!-- You 'll need those to add OTel support -->
497+
<repositories>
498+
<repository>
499+
<id>spring-snapshots</id>
500+
<url>https://repo.spring.io/snapshot</url>
501+
<snapshots><enabled>true</enabled></snapshots>
502+
</repository>
503+
<repository>
504+
<id>spring-milestones</id>
505+
<url>https://repo.spring.io/milestone</url>
506+
</repository>
507+
</repositories>
508+
<pluginRepositories>
509+
<pluginRepository>
510+
<id>spring-snapshots</id>
511+
<url>https://repo.spring.io/snapshot</url>
512+
</pluginRepository>
513+
<pluginRepository>
514+
<id>spring-milestones</id>
515+
<url>https://repo.spring.io/milestone</url>
516+
</pluginRepository>
517+
</pluginRepositories>
337518
----
338519
339520
[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"]
@@ -342,16 +523,31 @@ If you want Sleuth over RabbitMQ, add the `spring-cloud-sleuth-otel` (exclude `s
342523
dependencyManagement {
343524
imports {
344525
mavenBom "org.springframework.cloud:spring-cloud-dependencies:${releaseTrainVersion}"
526+
mavenBom "org.springframework.cloud:spring-cloud-sleuth-otel-dependencies:${springCloudSleuthOtelVersion}"
345527
}
346528
}
347529
348530
dependencies {
349531
implementation("org.springframework.cloud:spring-cloud-starter-sleuth") {
350532
exclude group: 'org.springframework.cloud', module: 'spring-cloud-sleuth-brave'
351533
}
534+
implementation "org.springframework.cloud:spring-cloud-sleuth-otel-autoconfigure"
352535
implementation "org.springframework.cloud:spring-cloud-sleuth-zipkin"
353536
implementation "org.apache.activemq:activemq-client"
354537
}
538+
539+
repositories {
540+
mavenCentral()
541+
maven {
542+
url "https://repo.spring.io/snapshot"
543+
}
544+
maven {
545+
url "https://repo.spring.io/milestone"
546+
}
547+
maven {
548+
url "https://repo.spring.io/release"
549+
}
550+
}
355551
----
356552
====
357553

0 commit comments

Comments
 (0)