Merge branch 'main' into grpc-req-res-size

Author: laurit

conventions/build.gradle.kts

@@ -58,7 +58,7 @@ dependencies {
   implementation("com.google.guava:guava:33.4.8-jre")
   implementation("com.gradleup.shadow:shadow-gradle-plugin:9.1.0")
   implementation("org.apache.httpcomponents:httpclient:4.5.14")
-  implementation("com.gradle.develocity:com.gradle.develocity.gradle.plugin:4.1.1")
+  implementation("com.gradle.develocity:com.gradle.develocity.gradle.plugin:4.2")
   implementation("org.owasp:dependency-check-gradle:12.1.3")
   implementation("ru.vyarus:gradle-animalsniffer-plugin:2.0.1")
   implementation("org.spdx:spdx-gradle-plugin:0.9.0")

conventions/src/main/kotlin/otel.nullaway-conventions.gradle.kts

@@ -18,10 +18,19 @@ nullaway {
 
 tasks {
   withType<JavaCompile>().configureEach {
-    if (!name.contains("test", ignoreCase = true)) {
+    if (name.contains("test", ignoreCase = true)) {
+      options.errorprone.nullaway {
+        enabled = false
+      }
+    } else {
       options.errorprone.nullaway {
         severity.set(CheckSeverity.ERROR)
       }
     }
+    options.errorprone.nullaway {
+      customInitializerAnnotations.add("org.openjdk.jmh.annotations.Setup")
+      excludedFieldAnnotations.add("org.mockito.Mock")
+      excludedFieldAnnotations.add("org.mockito.InjectMocks")
+    }
   }
 }

dependencyManagement/build.gradle.kts

@@ -89,7 +89,7 @@ val DEPENDENCIES = listOf(
   "com.github.stefanbirkner:system-lambda:1.2.1",
   "com.github.stefanbirkner:system-rules:1.19.0",
   "uk.org.webcompere:system-stubs-jupiter:2.0.3",
-  "com.uber.nullaway:nullaway:0.12.9",
+  "com.uber.nullaway:nullaway:0.12.10",
   "commons-beanutils:commons-beanutils:1.11.0",
   "commons-cli:commons-cli:1.10.0",
   "commons-codec:commons-codec:1.19.0",
@@ -107,6 +107,7 @@ val DEPENDENCIES = listOf(
   "io.opentelemetry.contrib:opentelemetry-gcp-resources:${otelContribVersion}",
   "io.opentelemetry.contrib:opentelemetry-cloudfoundry-resources:${otelContribVersion}",
   "io.opentelemetry.contrib:opentelemetry-baggage-processor:${otelContribVersion}",
+  "io.opentelemetry.contrib:opentelemetry-samplers:${otelContribVersion}",
   "io.opentelemetry.proto:opentelemetry-proto:1.8.0-alpha",
   "io.opentelemetry:opentelemetry-extension-annotations:1.18.0", // deprecated, no longer part of bom
   "org.assertj:assertj-core:3.27.4",

docs/contributing/documenting-instrumentation.md

@@ -84,6 +84,10 @@ Example:
 
 ```yaml
 description: "This instrumentation enables..."
+semantic_conventions:
+  - HTTP_CLIENT_SPANS
+  - DATABASE_CLIENT_SPANS
+  - JVM_RUNTIME_METRICS
 disabled_by_default: true
 classification: library
 library_link: https://github.com/...
@@ -128,6 +132,32 @@ Some notes when writing descriptions:
 * It is not usually necessary to include specific library or framework version numbers in the
   description, unless that context is significant in some way.
 
+
+### Semantic Conventions
+
+If the instrumentation adheres to one or more specific semantic conventions, include a
+`semantic_conventions` field with a list of the relevant semantic convention categories.
+
+List of possible options:
+
+* [HTTP_CLIENT_SPANS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#http-client)
+* [HTTP_CLIENT_METRICS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-metrics.md#http-client)
+* [HTTP_SERVER_SPANS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#http-server)
+* [HTTP_SERVER_METRICS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-metrics.md#http-server)
+* [RPC_CLIENT_SPANS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-spans.md#client-attributes)
+* [RPC_CLIENT_METRICS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-metrics.md#rpc-client)
+* [RPC_SERVER_SPANS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-spans.md#server-attributes)
+* [RPC_SERVER_METRICS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-metrics.md#rpc-server)
+* [MESSAGING_SPANS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/messaging/messaging-spans.md)
+* [DATABASE_CLIENT_SPANS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md)
+* [DATABASE_CLIENT_METRICS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-metrics.md)
+* [DATABASE_POOL_METRICS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-metrics.md)
+* [JVM_RUNTIME_METRICS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/runtime/jvm-metrics.md)
+* [GRAPHQL_SERVER_SPANS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/graphql/graphql-spans.md)
+* [FAAS_SERVER_SPANS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/faas/faas-spans.md)
+* [GENAI_CLIENT_SPANS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/gen-ai/gen-ai-spans.md)
+* [GENAI_CLIENT_METRICS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/gen-ai/gen-ai-metrics.md#generative-ai-client-metrics)
+
 ### Library Link
 
 For library instrumentations, include a `library_link` field with a URL to the library or framework's
@@ -190,8 +220,22 @@ within 24 hours.
 
 ## opentelemetry.io
 
-All of our instrumentation modules are listed on the opentelemetry.io website in the context of how
-to [suppress specific instrumentation](https://opentelemetry.io/docs/zero-code/java/agent/disable/#suppressing-specific-agent-instrumentation).
+All of our instrumentation modules are listed on the opentelemetry.io website in two places:
+
+### Supported Libraries
+
+The [Supported Libraries](https://opentelemetry.io/docs/zero-code/java/agent/supported-libraries/)
+page lists all the library instrumentations that are included in the OpenTelemetry Java agent. It
+mostly mirrors the information from the [supported libraries](../supported-libraries.md) page in
+this repo, and should be updated when adding or removing library instrumentations.
+
+This page may be automatically generated in the future, but for now it is manually maintained.
+
+### Suppressing Instrumentation
+
+The [Suppressing instrumentation](https://opentelemetry.io/docs/zero-code/java/agent/disable/#suppressing-specific-agent-instrumentation)
+page lists the instrumentations in the context of the keys needed for using
+the `otel.instrumentation.[name].enabled` configuration.
 
 All new instrumentations should be added to this list. There is a
 [Github action](../../.github/workflows/documentation-disable-list-audit.yml) that runs nightly to check

docs/instrumentation-list.yaml

@@ -10,6 +10,9 @@ libraries:
     display_name: ActiveJ
     description: This instrumentation enables HTTP server spans and HTTP server metrics
       for the ActiveJ HTTP server.
+    semantic_conventions:
+    - HTTP_SERVER_SPANS
+    - HTTP_SERVER_METRICS
     library_link: https://activej.io/
     source_path: instrumentation/activej-http-6.0
     minimum_java_version: 17
@@ -92,6 +95,11 @@ libraries:
     display_name: Akka HTTP
     description: |
       This instrumentation enables HTTP client spans and metrics for the Akka HTTP client, and HTTP server spans and metrics for the Akka HTTP server.
+    semantic_conventions:
+    - HTTP_CLIENT_SPANS
+    - HTTP_CLIENT_METRICS
+    - HTTP_SERVER_SPANS
+    - HTTP_SERVER_METRICS
     library_link: https://doc.akka.io/docs/akka-http/current/index.html
     source_path: instrumentation/akka/akka-http-10.0
     scope:
@@ -181,6 +189,8 @@ libraries:
   - name: alibaba-druid-1.0
     description: |
       The Alibaba Druid instrumentation generates database connection pool metrics for druid data sources.
+    semantic_conventions:
+    - DATABASE_POOL_METRICS
     library_link: https://github.com/alibaba/druid
     source_path: instrumentation/alibaba-druid-1.0
     scope:
@@ -274,9 +284,12 @@ libraries:
           type: STRING
   apache:
   - name: apache-dbcp-2.0
+    display_name: Apache DBCP
     description: |
       This instrumentation enables database connection pools metrics for Apache DBCP.
       The instrumentation uses `MBeanRegistration` methods for lifecycle detection, therefore it only activates if the `BasicDataSource` is registered to an `MBeanServer`. If using Spring Boot, this happens automatically as all Spring beans that support JMX registration are automatically registered by default.
+    semantic_conventions:
+    - DATABASE_POOL_METRICS
     library_link: https://commons.apache.org/proper/commons-dbcp/
     source_path: instrumentation/apache-dbcp-2.0
     scope:
@@ -354,10 +367,14 @@ libraries:
         - name: db.client.connection.pool.name
           type: STRING
   - name: apache-dubbo-2.7
+    display_name: Apache Dubbo
     description: The Apache Dubbo instrumentation provides RPC client spans and RPC
       server spans for Apache Dubbo RPC calls. Each call produces a span named after
       the Dubbo method, enriched with standard RPC attributes (system, service, method),
       network attributes, and error details if an exception occurs.
+    semantic_conventions:
+    - RPC_CLIENT_SPANS
+    - RPC_SERVER_SPANS
     library_link: https://github.com/apache/dubbo/
     source_path: instrumentation/apache-dubbo-2.7
     scope:
@@ -399,8 +416,12 @@ libraries:
         - name: rpc.system
           type: STRING
   - name: apache-httpasyncclient-4.1
+    display_name: Apache HttpAsyncClient
     description: This instrumentation enables HTTP client spans and HTTP client metrics
       for the Apache HttpAsyncClient.
+    semantic_conventions:
+    - HTTP_CLIENT_SPANS
+    - HTTP_CLIENT_METRICS
     library_link: https://hc.apache.org/index.html
     source_path: instrumentation/apache-httpasyncclient-4.1
     scope:
@@ -446,8 +467,12 @@ libraries:
         - name: url.full
           type: STRING
   - name: apache-httpclient-2.0
+    display_name: Apache HttpClient
     description: This instrumentation enables HTTP client spans and HTTP client metrics
       for versions 2 and 3 of the Apache HttpClient.
+    semantic_conventions:
+    - HTTP_CLIENT_SPANS
+    - HTTP_CLIENT_METRICS
     library_link: https://hc.apache.org/index.html
     source_path: instrumentation/apache-httpclient/apache-httpclient-2.0
     scope:
@@ -491,8 +516,12 @@ libraries:
         - name: url.full
           type: STRING
   - name: apache-httpclient-4.0
+    display_name: Apache HttpClient
     description: This instrumentation enables HTTP client spans and HTTP client metrics
       for version 4 of the Apache HttpClient.
+    semantic_conventions:
+    - HTTP_CLIENT_SPANS
+    - HTTP_CLIENT_METRICS
     library_link: https://hc.apache.org/index.html
     source_path: instrumentation/apache-httpclient/apache-httpclient-4.0
     scope:
@@ -539,8 +568,12 @@ libraries:
         - name: url.full
           type: STRING
   - name: apache-httpclient-4.3
+    display_name: Apache HttpClient
     description: This instrumentation provides a library integration that enables
       HTTP client spans and HTTP client metrics for the Apache HttpClient.
+    semantic_conventions:
+    - HTTP_CLIENT_SPANS
+    - HTTP_CLIENT_METRICS
     library_link: https://hc.apache.org/index.html
     source_path: instrumentation/apache-httpclient/apache-httpclient-4.3
     scope:
@@ -588,8 +621,12 @@ libraries:
         - name: url.full
           type: STRING
   - name: apache-httpclient-5.0
+    display_name: Apache HttpClient
     description: This instrumentation enables HTTP client spans and HTTP client metrics
       for version 5 of the Apache HttpClient.
+    semantic_conventions:
+    - HTTP_CLIENT_SPANS
+    - HTTP_CLIENT_METRICS
     library_link: https://hc.apache.org/index.html
     source_path: instrumentation/apache-httpclient/apache-httpclient-5.0
     scope:
@@ -635,8 +672,12 @@ libraries:
         - name: url.full
           type: STRING
   - name: apache-httpclient-5.2
+    display_name: Apache HttpClient
     description: This instrumentation provides a library integration that enables
       HTTP client spans and HTTP client metrics for the Apache HttpClient.
+    semantic_conventions:
+    - HTTP_CLIENT_SPANS
+    - HTTP_CLIENT_METRICS
     library_link: https://hc.apache.org/index.html
     source_path: instrumentation/apache-httpclient/apache-httpclient-5.2
     scope:

instrumentation-api/build.gradle.kts

@@ -7,6 +7,7 @@ plugins {
   id("otel.japicmp-conventions")
   id("otel.publish-conventions")
   id("otel.jmh-conventions")
+  id("otel.nullaway-conventions")
 }
 
 group = "io.opentelemetry.instrumentation"

instrumentation-api/src/jmh/java/io/opentelemetry/instrumentation/api/instrumenter/InstrumenterBenchmark.java

@@ -33,8 +33,10 @@
 @State(Scope.Thread)
 public class InstrumenterBenchmark {
 
-  private static final Instrumenter<Void, Void> INSTRUMENTER =
-      Instrumenter.<Void, Void>builder(
+  private static final Object REQUEST = new Object();
+
+  private static final Instrumenter<Object, Void> INSTRUMENTER =
+      Instrumenter.<Object, Void>builder(
               OpenTelemetry.noop(),
               "benchmark",
               HttpSpanNameExtractor.create(ConstantHttpAttributesGetter.INSTANCE))
@@ -44,75 +46,76 @@ public class InstrumenterBenchmark {
 
   @Benchmark
   public Context start() {
-    return INSTRUMENTER.start(Context.root(), null);
+    return INSTRUMENTER.start(Context.root(), REQUEST);
   }
 
   @Benchmark
   public Context startEnd() {
-    Context context = INSTRUMENTER.start(Context.root(), null);
-    INSTRUMENTER.end(context, null, null, null);
+    Context context = INSTRUMENTER.start(Context.root(), REQUEST);
+    INSTRUMENTER.end(context, REQUEST, null, null);
     return context;
   }
 
-  enum ConstantHttpAttributesGetter implements HttpClientAttributesGetter<Void, Void> {
+  enum ConstantHttpAttributesGetter implements HttpClientAttributesGetter<Object, Void> {
     INSTANCE;
 
     private static final InetSocketAddress PEER_ADDRESS =
         InetSocketAddress.createUnresolved("localhost", 8080);
 
     @Override
-    public String getUrlFull(Void unused) {
+    public String getUrlFull(Object unused) {
       return "https://opentelemetry.io/benchmark";
     }
 
     @Override
-    public String getHttpRequestMethod(Void unused) {
+    public String getHttpRequestMethod(Object unused) {
       return "GET";
     }
 
     @Override
-    public List<String> getHttpRequestHeader(Void unused, String name) {
+    public List<String> getHttpRequestHeader(Object unused, String name) {
       if (name.equalsIgnoreCase("user-agent")) {
         return Collections.singletonList("OpenTelemetryBot");
       }
       return Collections.emptyList();
     }
 
     @Override
-    public Integer getHttpResponseStatusCode(Void unused, Void unused2, @Nullable Throwable error) {
+    public Integer getHttpResponseStatusCode(
+        Object unused, Void unused2, @Nullable Throwable error) {
       return 200;
     }
 
     @Override
-    public List<String> getHttpResponseHeader(Void unused, Void unused2, String name) {
+    public List<String> getHttpResponseHeader(Object unused, Void unused2, String name) {
       return Collections.emptyList();
     }
 
     @Override
-    public String getNetworkProtocolName(Void unused, @Nullable Void unused2) {
+    public String getNetworkProtocolName(Object unused, @Nullable Void unused2) {
       return "http";
     }
 
     @Override
-    public String getNetworkProtocolVersion(Void unused, @Nullable Void unused2) {
+    public String getNetworkProtocolVersion(Object unused, @Nullable Void unused2) {
       return "2.0";
     }
 
     @Nullable
     @Override
-    public String getServerAddress(Void request) {
+    public String getServerAddress(Object request) {
       return null;
     }
 
     @Nullable
     @Override
-    public Integer getServerPort(Void request) {
+    public Integer getServerPort(Object request) {
       return null;
     }
 
     @Override
     public InetSocketAddress getNetworkPeerInetSocketAddress(
-        Void request, @Nullable Void response) {
+        Object request, @Nullable Void response) {
       return PEER_ADDRESS;
     }
   }