Enforce library instrumentation package names matching their module names (#12957)

Author: trask

.fossa.yml

@@ -426,10 +426,10 @@ targets:
       target: ':instrumentation:elasticsearch:elasticsearch-rest-7.0:library'
     - type: gradle
       path: ./
-      target: ':instrumentation:elasticsearch:elasticsearch-rest-common:javaagent'
+      target: ':instrumentation:elasticsearch:elasticsearch-rest-common-5.0:javaagent'
     - type: gradle
       path: ./
-      target: ':instrumentation:elasticsearch:elasticsearch-rest-common:library'
+      target: ':instrumentation:elasticsearch:elasticsearch-rest-common-5.0:library'
     - type: gradle
       path: ./
       target: ':instrumentation:elasticsearch:elasticsearch-transport-5.0:javaagent'
@@ -694,12 +694,6 @@ targets:
     - type: gradle
       path: ./
       target: ':instrumentation:netty:netty-3.8:javaagent'
-    - type: gradle
-      path: ./
-      target: ':instrumentation:netty:netty-4-common:javaagent'
-    - type: gradle
-      path: ./
-      target: ':instrumentation:netty:netty-4-common:library'
     - type: gradle
       path: ./
       target: ':instrumentation:netty:netty-4.0:javaagent'
@@ -712,6 +706,12 @@ targets:
     - type: gradle
       path: ./
       target: ':instrumentation:netty:netty-common:library'
+    - type: gradle
+      path: ./
+      target: ':instrumentation:netty:netty-common-4.0:javaagent'
+    - type: gradle
+      path: ./
+      target: ':instrumentation:netty:netty-common-4.0:library'
     - type: gradle
       path: ./
       target: ':instrumentation:okhttp:okhttp-2.2:javaagent'
@@ -1014,7 +1014,7 @@ targets:
       target: ':instrumentation:kafka:kafka-clients:kafka-clients-2.6:library'
     - type: gradle
       path: ./
-      target: ':instrumentation:kafka:kafka-clients:kafka-clients-common:library'
+      target: ':instrumentation:kafka:kafka-clients:kafka-clients-common-0.11:library'
     - type: gradle
       path: ./
       target: ':instrumentation:log4j:log4j-context-data:log4j-context-data-2.17:javaagent'

.github/scripts/check-package-names.sh

@@ -0,0 +1,61 @@
+#!/bin/bash -e
+
+# shellcheck disable=SC2001
+
+for dir in $(find instrumentation -name "*.java" | grep library/src/main/java | sed 's#/[^/]*$##' | sort -u); do
+
+  module_name=$(echo "$dir" | sed 's#.*/\([^/]*\)/library/src/main/java/.*#\1#')
+
+  if [[ "$module_name" =~ java-* ]]; then
+    continue
+  fi
+  if [[ "$module_name" == "jdbc" ]]; then
+    continue
+  fi
+  if [[ "$module_name" == "jmx-metrics" ]]; then
+    continue
+  fi
+  if [[ "$module_name" == "resources" ]]; then
+    continue
+  fi
+  if [[ "$module_name" == "oshi" ]]; then
+    continue
+  fi
+
+  # these are possibly problematic
+  if [[ "$dir" == "instrumentation/grpc-1.6/library/src/main/java/io/grpc/override" ]]; then
+    continue
+  fi
+  if [[ "$dir" == "instrumentation/lettuce/lettuce-5.1/library/src/main/java/io/lettuce/core/protocol" ]]; then
+    continue
+  fi
+
+  # some common modules don't have any base version
+  # - lettuce-common
+  # - netty-common
+  if [[ ! "$module_name" =~ [0-9]$ && "$module_name" != "lettuce-common" && "$module_name" != "netty-common" ]]; then
+    echo "module name doesn't have a base version: $dir"
+    exit 1
+  fi
+
+  simple_module_name=$(echo "$module_name" | sed 's/-[0-9.]*$//' | sed 's/-//g')
+  base_version=$(echo "$module_name" | sed 's/.*-\([0-9.]*\)$/\1/' | sed 's/\./_/')
+
+  if [[ ! "$module_name" =~ [0-9]$ && "$module_name" != "lettuce-common" && "$module_name" != "netty-common" ]]; then
+    expected_package_name="io/opentelemetry/instrumentation/$simple_module_name/v$base_version"
+  else
+    expected_package_name="io/opentelemetry/instrumentation/$simple_module_name"
+  fi
+
+  package_name=$(echo "$dir" | sed 's#.*/src/main/java/##')
+
+  # deal with differences like module name elasticsearch-rest and package name elasticsearch.rest
+  expected_package_name_normalized=$(echo "$expected_package_name" | sed 's#/##g')
+  package_name_normalized=$(echo "$package_name" | sed 's#/##g')
+
+  if [[ "$package_name_normalized" != "$expected_package_name_normalized"* ]]; then
+    echo "ERROR: $dir"
+    exit 1
+  fi
+
+done

.github/workflows/build-common.yml

@@ -163,6 +163,13 @@ jobs:
 
       - run: .github/scripts/check-latest-dep-test-overrides.sh
 
+  check-package-names:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - run: .github/scripts/check-package-names.sh
+
   build:
     runs-on: ubuntu-latest
     steps:

CHANGELOG.md

@@ -7,6 +7,8 @@
 - The `java.net.http.HttpClient` instrumentation package
   `io.opentelemetry.instrumentation.httpclient` was deprecated in favor of the new package name
   `io.opentelemetry.instrumentation.javahttpclient`
+- The class `io.opentelemetry.instrumentation.netty.v4.common.HttpRequestAndChannel` was
+  renamed to `io.opentelemetry.instrumentation.netty.common.v4_0.HttpRequestAndChannel`
 
 ## Version 2.13.3 (2025-02-28)
 

instrumentation/elasticsearch/elasticsearch-api-client-7.16/javaagent-unit-tests/build.gradle.kts

@@ -3,6 +3,6 @@ plugins {
 }
 
 dependencies {
-  testImplementation(project(":instrumentation:elasticsearch:elasticsearch-rest-common:javaagent"))
+  testImplementation(project(":instrumentation:elasticsearch:elasticsearch-rest-common-5.0:javaagent"))
   testImplementation(project(":instrumentation:elasticsearch:elasticsearch-api-client-7.16:javaagent"))
 }

instrumentation/elasticsearch/elasticsearch-api-client-7.16/javaagent-unit-tests/src/test/java/io/opentelemetry/javaagent/instrumentation/elasticsearch/rest/ElasticsearchEndpointMapTest.java

@@ -7,7 +7,7 @@
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
-import io.opentelemetry.instrumentation.elasticsearch.rest.internal.ElasticsearchEndpointDefinition;
+import io.opentelemetry.instrumentation.elasticsearch.rest.common.v5_0.internal.ElasticsearchEndpointDefinition;
 import io.opentelemetry.javaagent.instrumentation.elasticsearch.apiclient.ElasticsearchEndpointMap;
 import java.util.ArrayList;
 import java.util.Arrays;

instrumentation/elasticsearch/elasticsearch-api-client-7.16/javaagent/build.gradle.kts

@@ -33,7 +33,7 @@ muzzle {
 dependencies {
   library("co.elastic.clients:elasticsearch-java:7.16.0")
 
-  implementation(project(":instrumentation:elasticsearch:elasticsearch-rest-common:javaagent"))
+  implementation(project(":instrumentation:elasticsearch:elasticsearch-rest-common-5.0:javaagent"))
 
   testInstrumentation(project(":instrumentation:elasticsearch:elasticsearch-rest-7.0:javaagent"))
   testInstrumentation(project(":instrumentation:apache-httpclient:apache-httpclient-4.0:javaagent"))

instrumentation/elasticsearch/elasticsearch-api-client-7.16/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/elasticsearch/apiclient/ElasticsearchEndpointMap.java

@@ -5,7 +5,7 @@
 
 package io.opentelemetry.javaagent.instrumentation.elasticsearch.apiclient;
 
-import io.opentelemetry.instrumentation.elasticsearch.rest.internal.ElasticsearchEndpointDefinition;
+import io.opentelemetry.instrumentation.elasticsearch.rest.common.v5_0.internal.ElasticsearchEndpointDefinition;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.HashMap;

instrumentation/elasticsearch/elasticsearch-api-client-7.16/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/elasticsearch/apiclient/RestClientHttpClientInstrumentation.java

@@ -14,7 +14,7 @@
 import io.opentelemetry.context.Context;
 import io.opentelemetry.context.Scope;
 import io.opentelemetry.instrumentation.api.util.VirtualField;
-import io.opentelemetry.instrumentation.elasticsearch.rest.internal.ElasticsearchEndpointDefinition;
+import io.opentelemetry.instrumentation.elasticsearch.rest.common.v5_0.internal.ElasticsearchEndpointDefinition;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
 import net.bytebuddy.asm.Advice;

instrumentation/elasticsearch/elasticsearch-api-client-7.16/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/elasticsearch/apiclient/RestClientTransportInstrumentation.java

@@ -12,7 +12,7 @@
 
 import co.elastic.clients.transport.Endpoint;
 import io.opentelemetry.instrumentation.api.util.VirtualField;
-import io.opentelemetry.instrumentation.elasticsearch.rest.internal.ElasticsearchEndpointDefinition;
+import io.opentelemetry.instrumentation.elasticsearch.rest.common.v5_0.internal.ElasticsearchEndpointDefinition;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
 import net.bytebuddy.asm.Advice;