Merge branch 'main' into opentelemetrybot/auto-update-opentelemetry-j…

…ava-instrumentation-v2.2.0

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

@@ -4,7 +4,7 @@ linkTitle: Spring Boot
 weight: 30
 description: Spring Boot instrumentation for OpenTelemetry Java
 # prettier-ignore
-cSpell:ignore: autoconfigurations autoconfigures datasource logback springboot webflux webmvc
+cSpell:ignore: autoconfigurations autoconfigures customizer datasource distro logback springboot webflux webmvc
 ---
 
 ## How to instrument Spring Boot with OpenTelemetry
@@ -132,9 +132,6 @@ Add the dependency given below to enable the OpenTelemetry starter.
 
 The OpenTelemetry starter uses OpenTelemetry Spring Boot
 [autoconfiguration](https://docs.spring.io/spring-boot/docs/current/reference/html/using.html#using.auto-configuration).
-For details concerning supported libraries and features of the OpenTelemetry
-autoconfiguration, see the configuration
-[README](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/spring/spring-boot-autoconfigure/README.md#features).
 
 {{< tabpane text=true >}} {{% tab header="Maven (`pom.xml`)" lang=Maven %}}
 
@@ -164,68 +161,207 @@ This spring starter supports
 which means that you can see and autocomplete all available properties in your
 IDE.
 
-#### Disable the OpenTelemetry Starter
+#### General configuration
+
+The OpenTelemetry Starter supports all the
+[SDK Autoconfiguration](/docs/languages/java/automatic/configuration/#sdk-autoconfiguration)
+(since 2.2.0). You can set properties in the `application.properties` or the
+`application.yaml` file, or use environment variables.
+
+`application.properties` example:
+
+```properties
+otel.propagators=tracecontext,b3
+otel.resource.attributes=environment=dev,xyz=foo
+```
+
+`application.yaml` example:
+
+```yaml
+otel:
+  propagators:
+    - tracecontext
+    - b3
+  resource:
+    attributes:
+      environment: dev
+      xyz: foo
+```
+
+Environment variables example:
+
+```shell
+export OTEL_PROPAGATORS="tracecontext,b3"
+export OTEL_RESOURCE_ATTRIBUTES="environment=dev,xyz=foo"
+```
+
+Disable the OpenTelemetry Starter:
 
 {{% config_option name="otel.sdk.disabled" %}}
 
 Set the value to `true` to disable the starter, e.g. for testing purposes.
 
 {{% /config_option %}}
 
-#### OpenTelemetry Data Exporters
+#### Programmatic configuration
 
-This package provides autoconfiguration the following exporters:
+You can use the `AutoConfigurationCustomizerProvider` for programmatic
+configuration. Programmatic configuration is recommended for advanced use cases,
+which are not configurable using properties.
 
-- OTLP
-- Logging
+##### Exclude actuator endpoints from tracing
 
-All available properties are listed in the
-[Configuration](/docs/languages/java/automatic/configuration/) page.
+As an example, you can customize the sampler to exclude health check endpoints
+from tracing:
 
-The only difference is that the OpenTelemetry Spring Boot starter uses
-`http/protobuf` as the default protocol for the OTLP exporter (as of 2.0.0+).
+{{< tabpane text=true >}} {{% tab header="Maven (`pom.xml`)" lang=Maven %}}
 
-#### Tracer Properties
+```xml
+<dependencies>
+	<dependency>
+		<groupId>io.opentelemetry.contrib</groupId>
+		<artifactId>opentelemetry-samplers</artifactId>
+    <version>1.33.0-alpha</version>
+	</dependency>
+</dependencies>
+```
 
-| Feature | Property                          | Default Value |
-| ------- | --------------------------------- | ------------- |
-| Tracer  | `otel.traces.sampler.probability` | 1.0           |
+{{% /tab %}} {{% tab header="Gradle (`gradle.build`)" lang=Gradle %}}
 
-#### Resource Properties
+```kotlin
+dependencies {
+  implementation("io.opentelemetry.contrib:opentelemetry-samplers:1.33.0-alpha")
+}
+```
 
-| Feature  | Property                           | Default Value |
-| -------- | ---------------------------------- | ------------- |
-| Resource | `otel.springboot.resource.enabled` | true          |
-|          | `otel.resource.attributes`         | empty map     |
+{{% /tab %}} {{< /tabpane>}}
 
-`otel.resource.attributes` supports a pattern-based resource configuration in
-the application.properties like this:
+```java
+import io.opentelemetry.api.trace.SpanKind;
+import io.opentelemetry.contrib.sampler.RuleBasedRoutingSampler;
+import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider;
+import io.opentelemetry.semconv.SemanticAttributes;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
 
-```properties
-otel.resource.attributes.environment=dev
-otel.resource.attributes.xyz=foo
+@Configuration
+public class Application {
+
+  @Bean
+  public AutoConfigurationCustomizerProvider otelCustomizer() {
+    return p ->
+        p.addSamplerCustomizer(
+            (fallback, config) ->
+                RuleBasedRoutingSampler.builder(SpanKind.SERVER, fallback)
+                    .drop(SemanticAttributes.URL_PATH, "^/actuator")
+                    .build());
+  }
+}
 ```
 
-It's also possible to specify the resource attributes in `application.yaml`:
+#### Resource Providers
 
-```yaml
-otel:
-  resource:
-    attributes:
-      environment: dev
-      xyz: foo
+The OpenTelemetry Starter includes
+[common Resource Providers](https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/resources/library)
+and the following Spring Boot specific Resource Providers:
+
+##### Distribution Resource Provider
+
+FQN:
+`io.opentelemetry.instrumentation.spring.autoconfigure.resources.DistroVersionResourceProvider`
+
+| Attribute                  | Value                               |
+| -------------------------- | ----------------------------------- |
+| `telemetry.distro.name`    | `opentelemetry-spring-boot-starter` |
+| `telemetry.distro.version` | version of the starter              |
+
+##### Spring Resource Provider
+
+FQN:
+`io.opentelemetry.instrumentation.spring.autoconfigure.resources.SpringResourceProvider`
+
+| Attribute         | Value                                                                                                         |
+| ----------------- | ------------------------------------------------------------------------------------------------------------- |
+| `service.name`    | `spring.application.name` or `build.version` from `build-info.properties` (see [Service name](#service-name)) |
+| `service.version` | `build.name` from `build-info.properties`                                                                     |
+
+##### AWS Resource Provider
+
+The
+[AWS Resource Provider](https://github.com/open-telemetry/opentelemetry-java-contrib/tree/main/aws-resources)
+can be added as a dependency:
+
+{{< tabpane text=true >}} {{% tab header="Maven (`pom.xml`)" lang=Maven %}}
+
+```xml
+<dependencies>
+	<dependency>
+		<groupId>io.opentelemetry.contrib</groupId>
+		<artifactId>opentelemetry-aws-resources</artifactId>
+    <version>1.33.0-alpha</version>
+    <exclusions>
+      <exclusion>
+        <groupId>com.fasterxml.jackson.core</groupId>
+        <artifactId>jackson-core</artifactId>
+      </exclusion>
+      <exclusion>
+        <groupId>com.squareup.okhttp3</groupId>
+        <artifactId>okhttp</artifactId>
+      </exclusion>
+    </exclusions>
+	</dependency>
+</dependencies>
+```
+
+{{% /tab %}} {{% tab header="Gradle (`gradle.build`)" lang=Gradle %}}
+
+```kotlin
+implementation("io.opentelemetry.contrib:opentelemetry-aws-resources:1.33.0-alpha") {
+    exclude("com.fasterxml.jackson.core", "jackson-core")
+    exclude("com.squareup.okhttp3", "okhttp")
+}
 ```
 
-Finally, the resource attributes can be specified as a comma-separated list, as
-described in the
-[specification](/docs/languages/sdk-configuration/general/#otel_resource_attributes):
+{{% /tab %}} {{< /tabpane>}}
 
-```shell
-export OTEL_RESOURCE_ATTRIBUTES="key1=value1,key2=value2"
+##### GCP Resource Provider
+
+The
+[GCP Resource Provider](https://github.com/open-telemetry/opentelemetry-java-contrib/tree/main/gcp-resources)
+can be added as a dependency:
+
+{{< tabpane text=true >}} {{% tab header="Maven (`pom.xml`)" lang=Maven %}}
+
+```xml
+<dependencies>
+	<dependency>
+		<groupId>io.opentelemetry.contrib</groupId>
+		<artifactId>opentelemetry-gcp-resources</artifactId>
+    <version>1.33.0-alpha</version>
+    <exclusions>
+      <exclusion>
+        <groupId>com.fasterxml.jackson.core</groupId>
+        <artifactId>jackson-core</artifactId>
+      </exclusion>
+    </exclusions>
+	</dependency>
+</dependencies>
 ```
 
-The service name is determined by the following precedence rules, in accordance
-with the OpenTelemetry
+{{% /tab %}} {{% tab header="Gradle (`gradle.build`)" lang=Gradle %}}
+
+```kotlin
+implementation("io.opentelemetry.contrib:opentelemetry-gcp-resources:1.33.0-alpha") {
+    exclude("com.fasterxml.jackson.core", "jackson-core")
+}
+```
+
+{{% /tab %}} {{< /tabpane>}}
+
+#### Service name
+
+Using these resource providers, the service name is determined by the following
+precedence rules, in accordance with the OpenTelemetry
 [specification](/docs/languages/sdk-configuration/general/#otel_service_name):
 
 1. `otel.service.name` spring property or `OTEL_SERVICE_NAME` environment
@@ -420,38 +556,6 @@ span by annotating the method parameters with `@SpanAttribute`.
 | ----------- | ------------------------------------------ | ------------- | ------------------ |
 | `@WithSpan` | `otel.instrumentation.annotations.enabled` | true          | WithSpan, Aspect   |
 
-##### Dependency
-
-{{< tabpane text=true >}} {{% tab header="Maven (`pom.xml`)" lang=Maven %}}
-
-```xml
-<dependencies>
-  <dependency>
-    <groupId>org.springframework</groupId>
-    <artifactId>spring-aop</artifactId>
-    <version>SPRING_VERSION</version>
-  </dependency>
-  <dependency>
-    <groupId>io.opentelemetry</groupId>
-    <artifactId>opentelemetry-instrumentation-annotations</artifactId>
-    <version>{{% param vers.instrumentation %}}</version>
-  </dependency>
-</dependencies>
-```
-
-{{% /tab %}} {{% tab header="Gradle (`gradle.build`)" lang=Gradle %}}
-
-```kotlin
-dependencies {
-  implementation("org.springframework:spring-aop:SPRING_VERSION")
-  implementation("io.opentelemetry:opentelemetry-extension-annotations:{{% param vers.otel %}}")
-}
-```
-
-{{% /tab %}} {{< /tabpane>}}
-
-##### Usage
-
 ```java
 import org.springframework.stereotype.Component;
 

data/ecosystem/vendors.yaml

@@ -1,4 +1,4 @@
-# cSpell:ignore Coralogix Cribl ITRS Kloud Logz Crowdstrike Humio Lumigo observ Uptrace Greptime KloudMate qryn ClickHouse Tracetest opensource OneUptime
+# cSpell:ignore Causely Coralogix Cribl ITRS Kloud Logz Crowdstrike Humio Lumigo observ Uptrace Greptime KloudMate qryn ClickHouse Tracetest opensource OneUptime
 - name: AppDynamics (Cisco)
   nativeOTLP: true
   url: 'https://docs.appdynamics.com/latest/en/application-monitoring/appdynamics-for-opentelemetry'
@@ -35,6 +35,13 @@
   contact: '[email protected]'
   oss: false
   commercial: true
+- name: Causely
+  distribution: false
+  nativeOTLP: true
+  url: 'https://github.com/Causely/documentation'
+  contact: '[email protected]'
+  oss: false
+  commercial: true
 - name: Control Plane
   nativeOTLP: true
   url: 'https://docs.controlplane.com/reference/org#tracing'

data/registry/exporter-dotnet-console.yml

@@ -15,4 +15,4 @@ createdAt: 2022-11-07
 package:
   registry: nuget
   name: OpenTelemetry.Exporter.Console
-  version: 1.7.0
+  version: 1.8.0-beta.1

data/registry/exporter-dotnet-inmemory.yml

@@ -17,4 +17,4 @@ createdAt: 2022-11-07
 package:
   registry: nuget
   name: OpenTelemetry.Exporter.InMemory
-  version: 1.7.0
+  version: 1.8.0-beta.1

data/registry/exporter-dotnet-opentelemetryprotocol.yml

@@ -19,4 +19,4 @@ createdAt: 2020-02-05
 package:
   registry: nuget
   name: OpenTelemetry.Exporter.OpenTelemetryProtocol
-  version: 1.7.0
+  version: 1.8.0-beta.1

data/registry/exporter-dotnet-prometheus-aspnetcore.yml

@@ -21,4 +21,4 @@ createdAt: 2022-11-07
 package:
   registry: nuget
   name: OpenTelemetry.Exporter.Prometheus.AspNetCore
-  version: 1.7.0-rc.1
+  version: 1.8.0-beta.1

data/registry/exporter-dotnet-prometheus-httplistener.yml

@@ -18,4 +18,4 @@ createdAt: 2022-11-07
 package:
   registry: nuget
   name: OpenTelemetry.Exporter.Prometheus.HttpListener
-  version: 1.7.0-rc.1
+  version: 1.8.0-beta.1

data/registry/exporter-dotnet-zipkin.yml

@@ -12,7 +12,7 @@ authors:
 package:
   name: OpenTelemetry.Exporter.Zipkin
   registry: nuget
-  version: 1.7.0
+  version: 1.8.0-beta.1
 urls:
   repo: https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/src/OpenTelemetry.Exporter.Zipkin
 createdAt: 2022-11-07

data/registry/instrumentation-dotnet-kafkaflow.yml

@@ -20,4 +20,4 @@ isFirstParty: true
 package:
   name: KafkaFlow.OpenTelemetry
   registry: nuget
-  version: 3.0.4
+  version: 3.0.5

data/registry/tools-ruby-sentry.yml

@@ -23,4 +23,4 @@ createdAt: 2023-01-31
 package:
   registry: gems
   name: sentry-opentelemetry
-  version: 5.17.0
+  version: 5.17.1

static/refcache.json

@@ -2051,6 +2051,10 @@
     "StatusCode": 200,
     "LastSeen": "2024-01-30T05:18:56.239248-05:00"
   },
+  "https://github.com/Causely/documentation": {
+    "StatusCode": 200,
+    "LastSeen": "2024-03-15T20:34:22.210208944Z"
+  },
   "https://github.com/DataDog/dd-opentelemetry-exporter-ruby": {
     "StatusCode": 200,
     "LastSeen": "2024-01-18T19:10:56.414699-05:00"