Skip to content

Commit fe4d087

Browse files
authored
Merge branch 'main' into cartermp/go-attributes
2 parents 2142da6 + 031d52c commit fe4d087

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+368
-79
lines changed

.gitmodules

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
[submodule "content-modules/community"]
1010
path = content-modules/community
1111
url = https://github.com/open-telemetry/community
12-
community-pin = 4e0d748
12+
community-pin = f16a58e
1313
[submodule "content-modules/opentelemetry-proto"]
1414
path = content-modules/opentelemetry-proto
1515
url = https://github.com/open-telemetry/opentelemetry-proto

.htmltest.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ IgnoreDirs:
99
- ^blog/(\d+/)?page/\d+
1010
IgnoreInternalURLs: # list of paths
1111
IgnoreURLs: # list of regexs of paths or URLs to be ignored
12-
- ^/docs/languages/\w+/(api|examples)/$
12+
- ^/docs/languages/\w+/(api|examples|registry)/$
13+
- ^/docs/collector/registry/$
1314
- ^/docs/languages/net/(metrics-api|traces-api)/
1415
- ^/community/end-user/feedback-survey/$
1516
- ^(/docs/migration/)?opencensus/$

content/en/docs/collector/registry.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Registry
3+
description:
4+
Exporters, processors, receivers and other useful components for the
5+
OpenTelemetry Collector
6+
redirect: /ecosystem/registry/?language=collector
7+
_build: { render: link }
8+
weight: 300
9+
---

content/en/docs/concepts/signals/metrics.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: A measurement captured at runtime
77
A **metric** is a **measurement** of a service captured at runtime. The moment
88
of capturing a measurements is known as a **metric event**, which consists not
99
only of the measurement itself, but also the time at which it was captured and
10-
associated metadata.d
10+
associated metadata.
1111

1212
Application and request metrics are important indicators of availability and
1313
performance. Custom metrics can provide insights into how availability

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

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Registry
3+
description:
4+
Instrumentation libraries, exporters and other useful components for
5+
OpenTelemetry C++
6+
redirect: /ecosystem/registry/?language=cpp
7+
_build: { render: link }
8+
weight: 300
9+
---

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

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Registry
3+
description:
4+
Instrumentation libraries, exporters and other useful components for
5+
OpenTelemetry Erlang/Elixir
6+
redirect: /ecosystem/registry/?language=erlang
7+
_build: { render: link }
8+
weight: 300
9+
---

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

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Registry
3+
description:
4+
Instrumentation libraries, exporters and other useful components for
5+
OpenTelemetry Go
6+
redirect: /ecosystem/registry/?language=go
7+
_build: { render: link }
8+
weight: 300
9+
---

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

+14-10
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Resources should be assigned to a tracer provider at its initialization, and are
1010
created much like attributes:
1111

1212
```go
13-
resources := resource.NewWithAttributes(
13+
res := resource.NewWithAttributes(
1414
semconv.SchemaURL,
1515
semconv.ServiceNameKey.String("myService"),
1616
semconv.ServiceVersionKey.String("1.0.0"),
@@ -19,7 +19,7 @@ resources := resource.NewWithAttributes(
1919

2020
provider := sdktrace.NewTracerProvider(
2121
...
22-
sdktrace.WithResource(resources),
22+
sdktrace.WithResource(res),
2323
)
2424
```
2525

@@ -36,13 +36,17 @@ hosting that operating system instance, or any number of other resource
3636
attributes.
3737

3838
```go
39-
resources := resource.New(context.Background(),
40-
resource.WithFromEnv(), // pull attributes from OTEL_RESOURCE_ATTRIBUTES and OTEL_SERVICE_NAME environment variables
41-
resource.WithProcess(), // This option configures a set of Detectors that discover process information
42-
resource.WithOS(), // This option configures a set of Detectors that discover OS information
43-
resource.WithContainer(), // This option configures a set of Detectors that discover container information
44-
resource.WithHost(), // This option configures a set of Detectors that discover host information
45-
resource.WithDetectors(thirdparty.Detector{}), // Bring your own external Detector implementation
46-
resource.WithAttributes(attribute.String("foo", "bar")), // Or specify resource attributes directly
39+
res, err := resource.New(context.Background(),
40+
resource.WithFromEnv(), // Pull attributes from OTEL_RESOURCE_ATTRIBUTES and OTEL_SERVICE_NAME environment variables.
41+
resource.WithTelemetrySDK(), // Provide information about the OpenTelemetry SDK used.
42+
resource.WithProcess(), // Discover and provide process information.
43+
resource.WithOS(), // Discover and provide OS information.
44+
resource.WithContainer(), // Discover and provide container information.
45+
resource.WithHost(), // Discover and provide information.
46+
resource.WithAttributes(attribute.String("foo", "bar")), // Add custom resource attributes.
47+
// resource.WithDetectors(thirdparty.Detector{}), // Bring your own external Detector implementation.
4748
)
49+
if err != nil {
50+
log.Println(err) // Log issues during resource creation. Note that resource.New still returns a resource.
51+
}
4852
```

content/en/docs/languages/java/automatic/spring-boot.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ with the OpenTelemetry
231231
## Automatic instrumentation
232232

233233
Autoconfigures OpenTelemetry instrumentation for
234-
[spring-web](#spring-web-autoconfiguration) ,
234+
[spring-web](#spring-web-autoconfiguration),
235235
[spring-webmvc](#spring-web-mvc-autoconfiguration), and
236236
[spring-webflux](#spring-webflux-autoconfiguration). Leverages Spring Aspect
237237
Oriented Programming, dependency injection, and bean post-processing to trace
@@ -476,7 +476,7 @@ autoconfiguration features with an annotation or the Zipkin starter.
476476

477477
### Spring support
478478

479-
Autoconfiguration is natively supported by Springboot applications. To enable
479+
Autoconfiguration is natively supported by Spring Boot applications. To enable
480480
these features in "vanilla" use `@EnableOpenTelemetry` to complete a component
481481
scan of this package.
482482

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,49 +263,31 @@ 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>
280-
</dependency>
281-
<dependency>
282-
<groupId>io.opentelemetry</groupId>
283-
<artifactId>opentelemetry-sdk-metrics</artifactId>
284291
</dependency>
285292
<dependency>
286293
<groupId>io.opentelemetry</groupId>
@@ -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

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Registry
3+
description:
4+
Instrumentation libraries, exporters and other useful components for
5+
OpenTelemetry Java
6+
redirect: /ecosystem/registry/?language=java
7+
_build: { render: link }
8+
weight: 300
9+
---

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

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Registry
3+
description:
4+
Instrumentation libraries, exporters and other useful components for
5+
OpenTelemetry JavaScript
6+
redirect: /ecosystem/registry/?language=js
7+
_build: { render: link }
8+
weight: 300
9+
---

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

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Registry
3+
description:
4+
Instrumentation libraries, exporters and other useful components for
5+
OpenTelemetry .NET
6+
redirect: /ecosystem/registry/?language=dotnet
7+
_build: { render: link }
8+
weight: 300
9+
---

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

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Registry
3+
description:
4+
Instrumentation libraries, exporters and other useful components for
5+
OpenTelemetry PHP
6+
redirect: /ecosystem/registry/?language=php
7+
_build: { render: link }
8+
weight: 300
9+
---

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

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Registry
3+
description:
4+
Instrumentation libraries, exporters and other useful components for
5+
OpenTelemetry Python
6+
redirect: /ecosystem/registry/?language=python
7+
_build: { render: link }
8+
weight: 300
9+
---

0 commit comments

Comments
 (0)