Merge branch 'main' into hadoop-jmx-metics-semconv-alignment

Author: robsunday

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

@@ -143,7 +143,7 @@ abstract class NettyAlignmentRule : ComponentMetadataRule {
     with(ctx.details) {
       if (id.group == "io.netty" && id.name != "netty") {
         if (id.version.startsWith("4.1.")) {
-          belongsTo("io.netty:netty-bom:4.1.123.Final", false)
+          belongsTo("io.netty:netty-bom:4.1.124.Final", false)
         } else if (id.version.startsWith("4.0.")) {
           belongsTo("io.netty:netty-bom:4.0.56.Final", false)
         }

docs/instrumentation-list.yaml

@@ -784,6 +784,37 @@ libraries:
     target_versions:
       javaagent:
       - com.linecorp.armeria:armeria-grpc:[1.14.0,)
+    telemetry:
+    - when: default
+      spans:
+      - span_kind: CLIENT
+        attributes:
+        - name: rpc.grpc.status_code
+          type: LONG
+        - name: rpc.method
+          type: STRING
+        - name: rpc.service
+          type: STRING
+        - name: rpc.system
+          type: STRING
+        - name: server.address
+          type: STRING
+        - name: server.port
+          type: LONG
+      - span_kind: SERVER
+        attributes:
+        - name: rpc.grpc.status_code
+          type: LONG
+        - name: rpc.method
+          type: STRING
+        - name: rpc.service
+          type: STRING
+        - name: rpc.system
+          type: STRING
+        - name: server.address
+          type: STRING
+        - name: server.port
+          type: LONG
   async:
   - name: async-http-client-1.9
     description: This instrumentation enables CLIENT spans and metrics for version

docs/supported-libraries.md

@@ -106,7 +106,7 @@ These are the supported libraries and frameworks:
 | [MongoDB Driver](https://mongodb.github.io/mongo-java-driver/)                                                                              | 3.1+                               | [opentelemetry-mongo-3.1](../instrumentation/mongo/mongo-3.1/library)                                                                                                                                                                                                                                                                                                                   | [Database Client Spans], [Database Client Metrics] [6]                                                                                       |
 | [MyBatis](https://mybatis.org/mybatis-3/)                                                                                                   | 3.2+                               | N/A                                                                                                                                                                                                                                                                                                                                                                                     | none                                                                                                                                              |
 | [Netty HTTP codec [5]](https://github.com/netty/netty)                                                                                      | 3.8+                               | [opentelemetry-netty-4.1](../instrumentation/netty/netty-4.1/library)                                                                                                                                                                                                                                                                                                                   | [HTTP Client Spans], [HTTP Client Metrics], [HTTP Server Spans], [HTTP Server Metrics]                                                            |
-| [OpenAI Java SDK](https://github.com/openai/openai-java)                                                                                    | 1.1+                               | [openai-java-1.1](../instrumentation/openai/openai-java-1.1/library)                                                                                                                                                                                                                                                                                                                    | [GenAI Client Spans], [GenAI Client Metrics]                                                                                                      |
+| [OpenAI Java SDK](https://github.com/openai/openai-java)                                                                                    | 1.1+ (not including 3.0+ yet)      | [openai-java-1.1](../instrumentation/openai/openai-java-1.1/library)                                                                                                                                                                                                                                                                                                                    | [GenAI Client Spans], [GenAI Client Metrics]                                                                                                      |
 | [OpenSearch Rest Client](https://github.com/opensearch-project/opensearch-java)                                                             | 1.0+                               |                                                                                                                                                                                                                                                                                                                                                                                         | [Database Client Spans], [Database Client Metrics] [6]                                                                                       |
 | [OkHttp](https://github.com/square/okhttp/)                                                                                                 | 2.2+                               | [opentelemetry-okhttp-3.0](../instrumentation/okhttp/okhttp-3.0/library)                                                                                                                                                                                                                                                                                                                | [HTTP Client Spans], [HTTP Client Metrics]                                                                                                        |
 | [Oracle UCP](https://docs.oracle.com/database/121/JJUCP/)                                                                                   | 11.2+                              | [opentelemetry-oracle-ucp-11.2](../instrumentation/oracle-ucp-11.2/library)                                                                                                                                                                                                                                                                                                             | [Database Pool Metrics]                                                                                                                           |

examples/extension/src/test/java/com/example/javaagent/smoketest/IntegrationTest.java

@@ -65,7 +65,7 @@ protected Map<String, String> getExtraEnv() {
   static void setup() {
     backend =
         new GenericContainer<>(
-                "ghcr.io/open-telemetry/opentelemetry-java-instrumentation/smoke-test-fake-backend:20221127.3559314891")
+                "ghcr.io/open-telemetry/opentelemetry-java-instrumentation/smoke-test-fake-backend:20250811.16876216352")
             .withExposedPorts(8080)
             .waitingFor(Wait.forHttp("/health").forPort(8080))
             .withNetwork(network)

instrumentation-docs/readme.md

@@ -24,7 +24,7 @@ tasks {
 ```
 
 Sometimes instrumentation will behave differently based on configuration options, and we can
-differentiate between these configurations by using the `metaDataConfig` system property. When the
+differentiate between these configurations by using the `metadataConfig` system property. When the
 telemetry is written to a file, the value of this property will be included, or it will default to
 a `default` attribution.
 
@@ -39,7 +39,7 @@ tasks {
     jvmArgs("-Dotel.semconv-stability.opt-in=database")
 
     systemProperty("collectMetadata", collectMetadata)
-    systemProperty("metaDataConfig", "otel.semconv-stability.opt-in=database")
+    systemProperty("metadataConfig", "otel.semconv-stability.opt-in=database")
   }
 
   test {

instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/parsers/MetricParser.java

@@ -109,7 +109,7 @@ public static Map<String, Map<String, AggregatedMetricInfo>> aggregateMetrics(
           aggregatedMetrics.computeIfAbsent(when, k -> new HashMap<>());
 
       for (EmittedMetrics.MetricsByScope metricsByScope : metrics.getMetricsByScope()) {
-        if (metricsByScope.getScope().equals(targetScopeName)) {
+        if (TelemetryParser.scopeIsValid(metricsByScope.getScope(), targetScopeName)) {
           for (EmittedMetrics.Metric metric : metricsByScope.getMetrics()) {
             AggregatedMetricInfo aggInfo =
                 metricKindMap.computeIfAbsent(

instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/parsers/SpanParser.java

@@ -87,7 +87,7 @@ public static Map<String, Map<String, Set<TelemetryAttribute>>> aggregateSpans(
           aggregatedAttributes.computeIfAbsent(when, k -> new HashMap<>());
 
       for (EmittedSpans.SpansByScope spansByScope : spans.getSpansByScope()) {
-        if (spansByScope.getScope().equals(targetScopeName)) {
+        if (TelemetryParser.scopeIsValid(spansByScope.getScope(), targetScopeName)) {
           processSpansForScope(spansByScope, spanKindMap);
         }
       }

instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/parsers/TelemetryParser.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.docs.parsers;
+
+import java.util.Map;
+import java.util.Set;
+
+class TelemetryParser {
+
+  // Key is the scope of the module being analyzed, value is a set of additional allowed scopes.
+  private static final Map<String, Set<String>> scopeAllowList =
+      Map.of("io.opentelemetry.armeria-grpc-1.14", Set.of("io.opentelemetry.grpc-1.6"));
+
+  /**
+   * Checks if the given telemetry scope is valid for the specified module scope.
+   *
+   * <p>If an instrumentation module uses an instrumenter or telemetry class from another module, it
+   * might report telemetry with a different scope name, resulting in us excluding it. There are
+   * cases where we want to include this data, so we provide this way to override that exclusion
+   * filter.
+   *
+   * @param telemetryScope the scope of the telemetry signal
+   * @param moduleScope the scope of the module being analyzed
+   * @return true if the telemetry scope is valid for the module, false otherwise
+   */
+  static boolean scopeIsValid(String telemetryScope, String moduleScope) {
+    return telemetryScope.equals(moduleScope)
+        || scopeAllowList.getOrDefault(moduleScope, Set.of()).contains(telemetryScope);
+  }
+
+  private TelemetryParser() {}
+}

instrumentation-docs/src/test/java/io/opentelemetry/instrumentation/docs/parsers/MetricParserTest.java

@@ -107,6 +107,31 @@ void testPreservesMetricMetadata() {
     assertThat(foundMetric.getUnit()).isEqualTo("unit");
   }
 
+  @Test
+  void testScopeOverrideForGrpc() {
+    String targetScopeName = "io.opentelemetry.armeria-grpc-1.14";
+
+    EmittedMetrics.Metric metric1 =
+        createMetric("my.metric1", "description of my.metric1", "attr1");
+
+    EmittedMetrics.MetricsByScope targetMetricsByScope =
+        new EmittedMetrics.MetricsByScope("io.opentelemetry.grpc-1.6", List.of(metric1));
+
+    EmittedMetrics emittedMetrics = new EmittedMetrics("default", List.of(targetMetricsByScope));
+
+    Map<String, Map<String, MetricParser.MetricAggregator.AggregatedMetricInfo>> metrics =
+        MetricParser.MetricAggregator.aggregateMetrics("default", emittedMetrics, targetScopeName);
+
+    Map<String, List<EmittedMetrics.Metric>> result =
+        MetricParser.MetricAggregator.buildFilteredMetrics(metrics);
+
+    EmittedMetrics.Metric foundMetric = result.get("default").get(0);
+    assertThat(foundMetric.getName()).isEqualTo("my.metric1");
+    assertThat(foundMetric.getDescription()).isEqualTo("description of my.metric1");
+    assertThat(foundMetric.getType()).isEqualTo("gauge");
+    assertThat(foundMetric.getUnit()).isEqualTo("unit");
+  }
+
   private static EmittedMetrics.Metric createMetric(
       String name, String description, String attrName) {
     return new EmittedMetrics.Metric(

instrumentation-docs/src/test/java/io/opentelemetry/instrumentation/docs/parsers/SpanParserTest.java

@@ -195,4 +195,70 @@ void testSpanAggregatorFiltersAndAggregatesCorrectly() {
         .extracting(TelemetryAttribute::getName)
         .containsExactly("my.operation");
   }
+
+  @Test
+  void getSpansFromFilesIncludesAllowListedScopes(@TempDir Path tempDir) throws IOException {
+    Path telemetryDir = Files.createDirectories(tempDir.resolve(".telemetry"));
+
+    String file1Content =
+        """
+        when: default
+        spans_by_scope:
+          - scope: io.opentelemetry.grpc-1.6
+            spans:
+              - span_kind: CLIENT
+                attributes:
+                  - name: rpc.system
+                    type: STRING
+                  - name: rpc.grpc.status_code
+                    type: LONG
+                  - name: server.port
+                    type: LONG
+                  - name: rpc.method
+                    type: STRING
+                  - name: rpc.service
+                    type: STRING
+                  - name: server.address
+                    type: STRING
+              - span_kind: SERVER
+                attributes:
+                  - name: rpc.system
+                    type: STRING
+                  - name: rpc.grpc.status_code
+                    type: LONG
+                  - name: server.port
+                    type: LONG
+                  - name: rpc.method
+                    type: STRING
+                  - name: rpc.service
+                    type: STRING
+                  - name: server.address
+                    type: STRING
+      """;
+
+    Files.writeString(telemetryDir.resolve("spans-1.yaml"), file1Content);
+
+    try (MockedStatic<FileManager> fileManagerMock = mockStatic(FileManager.class)) {
+      fileManagerMock
+          .when(() -> FileManager.readFileToString(telemetryDir.resolve("spans-1.yaml").toString()))
+          .thenReturn(file1Content);
+
+      Map<String, EmittedSpans> fileContents =
+          EmittedSpanParser.getSpansByScopeFromFiles(tempDir.toString(), "");
+
+      EmittedSpans emittedSpans = fileContents.get("default");
+
+      // Aggregate spans - only target scope should be included
+      Map<String, Map<String, Set<TelemetryAttribute>>> spans =
+          SpanParser.SpanAggregator.aggregateSpans(
+              "default", emittedSpans, "io.opentelemetry.armeria-grpc-1.14");
+
+      Map<String, List<EmittedSpans.Span>> result =
+          SpanParser.SpanAggregator.buildFilteredSpans(spans);
+
+      assertThat(result.size()).isEqualTo(1);
+      assertThat(result.get("default")).isNotNull();
+      assertThat(result.get("default").size()).isEqualTo(2);
+    }
+  }
 }