Add instrumentation for opensearch-rest-3.0 (#13823)

Author: laurit

.fossa.yml

@@ -724,6 +724,9 @@ targets:
     - type: gradle
       path: ./
       target: ':instrumentation:opensearch:opensearch-rest-1.0:javaagent'
+    - type: gradle
+      path: ./
+      target: ':instrumentation:opensearch:opensearch-rest-3.0:javaagent'
     - type: gradle
       path: ./
       target: ':instrumentation:opensearch:opensearch-rest-common:javaagent'

instrumentation/apache-httpclient/apache-httpclient-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/apachehttpclient/v5_0/ApacheHttpAsyncClientInstrumentation.java

@@ -264,6 +264,9 @@ private void cancelDelegate() {
 
     @Nullable
     private HttpResponse getResponseFromHttpContext() {
+      if (httpContext instanceof HttpCoreContext) {
+        return ((HttpCoreContext) httpContext).getResponse();
+      }
       return (HttpResponse) httpContext.getAttribute(HttpCoreContext.HTTP_RESPONSE);
     }
   }

instrumentation/opensearch/opensearch-rest-1.0/javaagent/build.gradle.kts

@@ -6,7 +6,7 @@ muzzle {
   pass {
     group.set("org.opensearch.client")
     module.set("opensearch-rest-client")
-    versions.set("[1.0,)")
+    versions.set("[1.0,3.0)")
     assertInverse.set(true)
   }
 
@@ -26,14 +26,17 @@ dependencies {
 
   implementation(project(":instrumentation:opensearch:opensearch-rest-common:javaagent"))
 
+  testInstrumentation(project(":instrumentation:opensearch:opensearch-rest-3.0:javaagent"))
   testInstrumentation(project(":instrumentation:apache-httpclient:apache-httpclient-4.0:javaagent"))
   testInstrumentation(project(":instrumentation:apache-httpasyncclient-4.1:javaagent"))
 
   testImplementation("org.apache.logging.log4j:log4j-core:2.18.0")
   testImplementation("org.apache.logging.log4j:log4j-api:2.18.0")
   testImplementation("org.apache.commons:commons-lang3:3.12.0")
   testImplementation("commons-io:commons-io:2.11.0")
-  testImplementation("org.opensearch:opensearch-testcontainers:2.0.0")
+  testImplementation(project(":instrumentation:opensearch:opensearch-rest-common:testing"))
+
+  latestDepTestLibrary("org.opensearch.client:opensearch-rest-client:2.+") // see opensearch-rest-3.0 module
 }
 
 tasks {

instrumentation/opensearch/opensearch-rest-1.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/opensearch/rest/v1_0/OpenSearchRestInstrumentationModule.java

@@ -7,6 +7,7 @@
 
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
 import static java.util.Collections.singletonList;
+import static net.bytebuddy.matcher.ElementMatchers.not;
 
 import com.google.auto.service.AutoService;
 import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
@@ -23,7 +24,9 @@ public OpenSearchRestInstrumentationModule() {
   @Override
   public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
     // class introduced in 1.0.0
-    return hasClassesNamed("org.opensearch.client.RestClient$InternalRequest");
+    return hasClassesNamed("org.opensearch.client.RestClient$InternalRequest")
+        // class introduced in 3.0.0
+        .and(not(hasClassesNamed("org.opensearch.client.http.HttpUriRequestProducer")));
   }
 
   @Override

instrumentation/opensearch/opensearch-rest-1.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/opensearch/rest/v1_0/OpenSearchRestSingletons.java

@@ -8,16 +8,33 @@
 import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter;
 import io.opentelemetry.javaagent.instrumentation.opensearch.rest.OpenSearchRestInstrumenterFactory;
 import io.opentelemetry.javaagent.instrumentation.opensearch.rest.OpenSearchRestRequest;
+import io.opentelemetry.javaagent.instrumentation.opensearch.rest.OpenSearchRestResponse;
+import java.net.InetAddress;
 import org.opensearch.client.Response;
 
 public final class OpenSearchRestSingletons {
 
-  private static final Instrumenter<OpenSearchRestRequest, Response> INSTRUMENTER =
+  private static final Instrumenter<OpenSearchRestRequest, OpenSearchRestResponse> INSTRUMENTER =
       OpenSearchRestInstrumenterFactory.create("io.opentelemetry.opensearch-rest-1.0");
 
-  public static Instrumenter<OpenSearchRestRequest, Response> instrumenter() {
+  public static Instrumenter<OpenSearchRestRequest, OpenSearchRestResponse> instrumenter() {
     return INSTRUMENTER;
   }
 
+  public static OpenSearchRestResponse convertResponse(Response response) {
+    return new OpenSearchRestResponse() {
+
+      @Override
+      public int getStatusCode() {
+        return response.getStatusLine().getStatusCode();
+      }
+
+      @Override
+      public InetAddress getAddress() {
+        return response.getHost().getAddress();
+      }
+    };
+  }
+
   private OpenSearchRestSingletons() {}
 }

instrumentation/opensearch/opensearch-rest-1.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/opensearch/rest/v1_0/RestClientInstrumentation.java

@@ -6,6 +6,8 @@
 package io.opentelemetry.javaagent.instrumentation.opensearch.rest.v1_0;
 
 import static io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge.currentContext;
+import static io.opentelemetry.javaagent.instrumentation.opensearch.rest.v1_0.OpenSearchRestSingletons.convertResponse;
+import static io.opentelemetry.javaagent.instrumentation.opensearch.rest.v1_0.OpenSearchRestSingletons.instrumenter;
 import static net.bytebuddy.matcher.ElementMatchers.isMethod;
 import static net.bytebuddy.matcher.ElementMatchers.named;
 import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
@@ -59,11 +61,11 @@ public static void onEnter(
 
       Context parentContext = currentContext();
       otelRequest = OpenSearchRestRequest.create(request.getMethod(), request.getEndpoint());
-      if (!OpenSearchRestSingletons.instrumenter().shouldStart(parentContext, otelRequest)) {
+      if (!instrumenter().shouldStart(parentContext, otelRequest)) {
         return;
       }
 
-      context = OpenSearchRestSingletons.instrumenter().start(parentContext, otelRequest);
+      context = instrumenter().start(parentContext, otelRequest);
       scope = context.makeCurrent();
     }
 
@@ -80,7 +82,7 @@ public static void stopSpan(
       }
       scope.close();
 
-      OpenSearchRestSingletons.instrumenter().end(context, otelRequest, response, throwable);
+      instrumenter().end(context, otelRequest, convertResponse(response), throwable);
     }
   }
 
@@ -97,20 +99,21 @@ public static void onEnter(
 
       Context parentContext = currentContext();
       otelRequest = OpenSearchRestRequest.create(request.getMethod(), request.getEndpoint());
-      if (!OpenSearchRestSingletons.instrumenter().shouldStart(parentContext, otelRequest)) {
+      if (!instrumenter().shouldStart(parentContext, otelRequest)) {
         return;
       }
 
-      context = OpenSearchRestSingletons.instrumenter().start(parentContext, otelRequest);
+      context = instrumenter().start(parentContext, otelRequest);
       scope = context.makeCurrent();
 
       responseListener =
           new RestResponseListener(
               responseListener,
               parentContext,
-              OpenSearchRestSingletons.instrumenter(),
+              instrumenter(),
               context,
-              otelRequest);
+              otelRequest,
+              OpenSearchRestSingletons::convertResponse);
     }
 
     @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
@@ -126,7 +129,7 @@ public static void stopSpan(
       scope.close();
 
       if (throwable != null) {
-        OpenSearchRestSingletons.instrumenter().end(context, otelRequest, null, throwable);
+        instrumenter().end(context, otelRequest, null, throwable);
       }
       // span ended in RestResponseListener
     }