Skip to content

Commit e7ee8c2

Browse files
committed
Merge branch 'theletterf-3929-add-collector-config-path' of github.com:open-telemetry/opentelemetry.io into theletterf-3929-add-collector-config-path
2 parents c2d1acf + 7961ce5 commit e7ee8c2

12 files changed

+59
-54
lines changed

content/en/docs/languages/cpp/instrumentation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ cSpell:ignore: decltype labelkv nostd nullptr
99

1010
<!-- markdownlint-disable no-duplicate-heading -->
1111

12-
{{% docs/languages/manual-intro %}}
12+
{{% docs/languages/instrumentation-intro %}}
1313

1414
## Setup
1515

content/en/docs/languages/erlang/instrumentation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ weight: 30
55
description: Instrumentation for OpenTelemetry Erlang/Elixir
66
---
77

8-
{{% docs/languages/manual-intro %}}
8+
{{% docs/languages/instrumentation-intro %}}
99

1010
## Setup
1111

content/en/docs/languages/go/instrumentation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: Manual instrumentation for OpenTelemetry Go
88
cSpell:ignore: fatalf otlptrace sdktrace sighup
99
---
1010

11-
{{% docs/languages/manual-intro %}}
11+
{{% docs/languages/instrumentation-intro %}}
1212

1313
## Setup
1414

content/en/docs/languages/java/instrumentation.md

+49-44
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ cSpell:ignore: Autowired customizer logback loggable multivalued rolldice spring
1313

1414
<!-- markdownlint-disable no-duplicate-heading -->
1515

16-
{{% docs/languages/manual-intro %}}
16+
{{% docs/languages/instrumentation-intro %}}
1717

1818
{{% alert title="Note" color="info" %}}
1919

@@ -190,22 +190,47 @@ You should get a list of 12 numbers in your browser window, for example:
190190
For both library and app instrumentation, the first step is to install the
191191
dependencies for the OpenTelemetry API.
192192

193+
Throughout this documentation you will add dependencies. For a full list of
194+
artifact coordinates, see [releases]. For semantic convention releases, see
195+
[semantic-conventions-java].
196+
197+
[releases]: https://github.com/open-telemetry/opentelemetry-java#releases
198+
[semantic-conventions-java]:
199+
https://github.com/open-telemetry/semantic-conventions-java/releases
200+
201+
### Dependency management
202+
203+
A Bill of Material
204+
([BOM](https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#bill-of-materials-bom-poms))
205+
ensures that versions of dependencies (including transitive ones) are aligned.
206+
Importing the `opentelemetry-bom` BOM is important to ensure version alignment
207+
across all OpenTelemetry dependencies.
208+
193209
{{< tabpane text=true >}} {{% tab Gradle %}}
194210

195-
```kotlin { hl_lines=3 }
211+
```kotlin { hl_lines=["1-5",9] }
212+
dependencyManagement {
213+
imports {
214+
mavenBom("io.opentelemetry:opentelemetry-bom:{{% param vers.otel %}}")
215+
}
216+
}
217+
196218
dependencies {
197219
implementation("org.springframework.boot:spring-boot-starter-web");
198-
implementation("io.opentelemetry:opentelemetry-api:{{% param vers.otel %}}");
220+
implementation("io.opentelemetry:opentelemetry-api");
199221
}
200222
```
201223

202-
Throughout this documentation you will add dependencies. For a full list of
203-
artifact coordinates, see [releases]. For semantic convention releases, see
204-
[semantic-conventions-java].
224+
If you are not using Spring and its `io.spring.dependency-management` dependency
225+
management plugin, install the OpenTelemetry BOM and API using Gradle
226+
dependencies only.
205227

206-
[releases]: https://github.com/open-telemetry/opentelemetry-java#releases
207-
[semantic-conventions-java]:
208-
https://github.com/open-telemetry/semantic-conventions-java/releases
228+
```kotlin
229+
dependencies {
230+
implementation(platform("io.opentelemetry:opentelemetry-bom:{{% param vers.otel %}}"));
231+
implementation("io.opentelemetry:opentelemetry-api");
232+
}
233+
```
209234

210235
{{% /tab %}} {{% tab Maven %}}
211236

@@ -238,50 +263,32 @@ artifact coordinates, see [releases]. For semantic convention releases, see
238263
{{% alert title="Note" color="info" %}} If you’re instrumenting a library,
239264
**skip this step**. {{% /alert %}}
240265

241-
If you instrument a Java app, install the dependencies for the OpenTelemetry
242-
SDK.
266+
The OpenTelemetry API provides a set of interfaces for collecting telemetry, but
267+
the data is dropped without an implementation. The OpenTelemetry SDK is the
268+
implementation of the OpenTelemetry API provided by OpenTelemetry. To use it if
269+
you instrument a Java app, begin by installing dependencies:
243270

244271
{{< tabpane text=true >}} {{% tab Gradle %}}
245272

246-
```kotlin { hl_lines="4-8" }
273+
```kotlin { hl_lines="4-6" }
247274
dependencies {
248275
implementation("org.springframework.boot:spring-boot-starter-web");
249-
implementation("io.opentelemetry:opentelemetry-api:{{% param vers.otel %}}");
250-
implementation("io.opentelemetry:opentelemetry-sdk:{{% param vers.otel %}}");
251-
implementation("io.opentelemetry:opentelemetry-sdk-metrics:{{% param vers.otel %}}");
252-
implementation("io.opentelemetry:opentelemetry-exporter-logging:{{% param vers.otel %}}");
253-
implementation("io.opentelemetry:opentelemetry-semconv:{{% param vers.otel %}}-alpha");
276+
implementation("io.opentelemetry:opentelemetry-api");
277+
implementation("io.opentelemetry:opentelemetry-sdk");
278+
implementation("io.opentelemetry:opentelemetry-exporter-logging");
279+
implementation("io.opentelemetry.semconv:opentelemetry-semconv:{{% param vers.semconv %}}-alpha");
254280
}
255281
```
256282

257283
{{% /tab %}} {{% tab Maven %}}
258284

259285
```xml
260286
<project>
261-
<dependencyManagement>
262-
<dependencies>
263-
<dependency>
264-
<groupId>io.opentelemetry</groupId>
265-
<artifactId>opentelemetry-bom</artifactId>
266-
<version>{{% param vers.otel %}}</version>
267-
<type>pom</type>
268-
<scope>import</scope>
269-
</dependency>
270-
</dependencies>
271-
</dependencyManagement>
272287
<dependencies>
273-
<dependency>
274-
<groupId>io.opentelemetry</groupId>
275-
<artifactId>opentelemetry-api</artifactId>
276-
</dependency>
277288
<dependency>
278289
<groupId>io.opentelemetry</groupId>
279290
<artifactId>opentelemetry-sdk</artifactId>
280291
</dependency>
281-
<dependency>
282-
<groupId>io.opentelemetry</groupId>
283-
<artifactId>opentelemetry-sdk-metrics</artifactId>
284-
</dependency>
285292
<dependency>
286293
<groupId>io.opentelemetry</groupId>
287294
<artifactId>opentelemetry-exporter-logging</artifactId>
@@ -312,16 +319,14 @@ To use autoconfiguration add the following dependency to your application:
312319

313320
{{< tabpane text=true >}} {{% tab Gradle %}}
314321

315-
```kotlin { hl_lines="9-10" }
322+
```kotlin { hl_lines="7" }
316323
dependencies {
317324
implementation("org.springframework.boot:spring-boot-starter-web");
318-
implementation("io.opentelemetry:opentelemetry-api:{{% param vers.otel %}}");
319-
implementation("io.opentelemetry:opentelemetry-sdk:{{% param vers.otel %}}");
320-
implementation("io.opentelemetry:opentelemetry-sdk-metrics:{{% param vers.otel %}}");
321-
implementation("io.opentelemetry:opentelemetry-exporter-logging:{{% param vers.otel %}}");
322-
implementation("io.opentelemetry.semconv:opentelemetry-semconv:{{% param vers.semconv %}}-alpha")
323-
implementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure:{{% param vers.otel %}}");
324-
implementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure-spi:{{% param vers.otel %}}");
325+
implementation("io.opentelemetry:opentelemetry-api");
326+
implementation("io.opentelemetry:opentelemetry-sdk");
327+
implementation("io.opentelemetry:opentelemetry-exporter-logging");
328+
implementation("io.opentelemetry.semconv:opentelemetry-semconv:{{% param vers.semconv %}}-alpha");
329+
implementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure");
325330
}
326331
```
327332

content/en/docs/languages/js/instrumentation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ cSpell:ignore: dicelib Millis rolldice
88
description: Instrumentation for OpenTelemetry JavaScript
99
---
1010

11-
{{% docs/languages/manual-intro %}}
11+
{{% docs/languages/instrumentation-intro %}}
1212

1313
{{% alert title="Note" color="info" %}}
1414

content/en/docs/languages/net/instrumentation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ aliases: [manual]
55
description: Instrumentation for OpenTelemetry .NET
66
---
77

8-
{{% docs/languages/manual-intro %}}
8+
{{% docs/languages/instrumentation-intro %}}
99

1010
## A note on terminology
1111

content/en/docs/languages/php/instrumentation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ cSpell:ignore: guzzlehttp myapp
88

99
<!-- markdownlint-disable no-duplicate-heading -->
1010

11-
{{% docs/languages/manual-intro %}}
11+
{{% docs/languages/instrumentation-intro %}}
1212

1313
## Example app preparation {#example-app}
1414

content/en/docs/languages/python/instrumentation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ cSpell:ignore: millis ottrace textmap
88

99
<!-- markdownlint-disable no-duplicate-heading -->
1010

11-
{{% docs/languages/manual-intro %}}
11+
{{% docs/languages/instrumentation-intro %}}
1212

1313
## Setup
1414

content/en/docs/languages/ruby/instrumentation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: Instrumentation for OpenTelemetry Ruby
1010
cSpell:ignore: SIGHUP
1111
---
1212

13-
{{% docs/languages/manual-intro %}}
13+
{{% docs/languages/instrumentation-intro %}}
1414

1515
## Setup
1616

content/en/docs/languages/swift/instrumentation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ aliases: [manual]
55
description: Instrumentation for OpenTelemetry Swift
66
---
77

8-
{{% docs/languages/manual-intro %}}
8+
{{% docs/languages/instrumentation-intro %}}
99

1010
## Setup
1111

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393
"postcss-cli": "^11.0.0",
9494
"prettier": "^3.0.3",
9595
"require-dir": "^1.2.0",
96-
"textlint": "^13.3.3",
96+
"textlint": "^14.0.1",
9797
"textlint-filter-rule-allowlist": "^4.0.0",
9898
"textlint-filter-rule-comments": "^1.2.2",
9999
"textlint-rule-terminology": "^4.0.1",

0 commit comments

Comments
 (0)