Add support for gRPC 1.33.0 (#175)

Signed-off-by: Pavol Loffay <[email protected]>

Author: pavolloffay

README.md

@@ -15,7 +15,7 @@ List of supported frameworks with additional capabilities:
 | Library/Framework                                                                                      | Versions        |
 |--------------------------------------------------------------------------------------------------------|-----------------|
 | [Apache HttpClient](https://hc.apache.org/index.html)                                                  | 4.0+            |
-| [gRPC](https://github.com/grpc/grpc-java)                                                              | 1.5+ to [1.32.0](https://github.com/hypertrace/javaagent/issues/70)        |
+| [gRPC](https://github.com/grpc/grpc-java)                                                              | 1.5+            |
 | [JAX-RS Client](https://javaee.github.io/javaee-spec/javadocs/javax/ws/rs/client/package-summary.html) | 2.0+            |
 | [OkHttp](https://github.com/square/okhttp/)                                                            | 3.0+            |
 | [Servlet](https://javaee.github.io/javaee-spec/javadocs/javax/servlet/package-summary.html)            | 2.3+            |

instrumentation/grpc-1.5/build.gradle.kts

@@ -13,7 +13,7 @@ muzzle {
     pass {
         group = "io.grpc"
         module = "grpc-core"
-        versions = "[1.5.0, 1.33.0)" // see https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/1453
+        versions = "[1.5.0,)"
         // for body capture via com.google.protobuf.util.JsonFormat
         extraDependency("io.grpc:grpc-protobuf:1.5.0")
         extraDependency("io.grpc:grpc-netty:1.5.0")

instrumentation/grpc-1.5/src/main/java/io/opentelemetry/instrumentation/hypertrace/grpc/v1_5/GrpcBodyInstrumentationModule.java renamed to instrumentation/grpc-1.5/src/main/java/io/opentelemetry/instrumentation/hypertrace/grpc/v1_5/client/GrpcClientBodyInstrumentationModule.java

@@ -14,20 +14,19 @@
  * limitations under the License.
  */
 
-package io.opentelemetry.instrumentation.hypertrace.grpc.v1_5;
+package io.opentelemetry.instrumentation.hypertrace.grpc.v1_5.client;
 
 import com.google.auto.service.AutoService;
-import io.opentelemetry.instrumentation.hypertrace.grpc.v1_5.client.GrpcClientBodyInstrumentation;
-import io.opentelemetry.instrumentation.hypertrace.grpc.v1_5.server.GrpcServerBodyInstrumentation;
+import io.opentelemetry.instrumentation.hypertrace.grpc.v1_5.GrpcInstrumentationName;
 import io.opentelemetry.javaagent.tooling.InstrumentationModule;
 import io.opentelemetry.javaagent.tooling.TypeInstrumentation;
-import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
 
 @AutoService(InstrumentationModule.class)
-public class GrpcBodyInstrumentationModule extends InstrumentationModule {
+public class GrpcClientBodyInstrumentationModule extends InstrumentationModule {
 
-  public GrpcBodyInstrumentationModule() {
+  public GrpcClientBodyInstrumentationModule() {
     super(GrpcInstrumentationName.PRIMARY, GrpcInstrumentationName.OTHER);
   }
 
@@ -38,6 +37,6 @@ public int getOrder() {
 
   @Override
   public List<TypeInstrumentation> typeInstrumentations() {
-    return Arrays.asList(new GrpcClientBodyInstrumentation(), new GrpcServerBodyInstrumentation());
+    return Collections.singletonList(new GrpcClientBodyInstrumentation());
   }
 }

instrumentation/grpc-1.5/src/main/java/io/opentelemetry/instrumentation/hypertrace/grpc/v1_5/server/GrpcServerBodyInstrumentation.java

@@ -16,13 +16,17 @@
 
 package io.opentelemetry.instrumentation.hypertrace.grpc.v1_5.server;
 
+import static io.opentelemetry.javaagent.tooling.ClassLoaderMatcher.hasClassesNamed;
+import static io.opentelemetry.javaagent.tooling.bytebuddy.matcher.AgentElementMatchers.safeHasSuperType;
 import static java.util.Collections.singletonMap;
 import static net.bytebuddy.matcher.ElementMatchers.isMethod;
+import static net.bytebuddy.matcher.ElementMatchers.isPublic;
 import static net.bytebuddy.matcher.ElementMatchers.named;
+import static net.bytebuddy.matcher.ElementMatchers.takesArguments;
 
-import io.grpc.ServerInterceptor;
+import io.grpc.ServerBuilder;
+import io.opentelemetry.javaagent.instrumentation.api.CallDepthThreadLocalMap;
 import io.opentelemetry.javaagent.tooling.TypeInstrumentation;
-import java.util.List;
 import java.util.Map;
 import net.bytebuddy.asm.Advice;
 import net.bytebuddy.description.method.MethodDescription;
@@ -31,34 +35,35 @@
 
 public class GrpcServerBodyInstrumentation implements TypeInstrumentation {
 
+  @Override
+  public ElementMatcher<ClassLoader> classLoaderOptimization() {
+    return hasClassesNamed("io.grpc.ServerBuilder");
+  }
+
   @Override
   public ElementMatcher<TypeDescription> typeMatcher() {
-    return named("io.grpc.internal.AbstractServerImplBuilder");
+    return safeHasSuperType(named("io.grpc.ServerBuilder"));
   }
 
   @Override
   public Map<? extends ElementMatcher<? super MethodDescription>, String> transformers() {
     return singletonMap(
-        isMethod().and(named("build")),
+        isMethod().and(isPublic()).and(named("build")).and(takesArguments(0)),
         GrpcServerBodyInstrumentation.class.getName() + "$AddInterceptorAdvice");
   }
 
   public static class AddInterceptorAdvice {
     @Advice.OnMethodEnter(suppress = Throwable.class)
-    public static void addInterceptor(
-        @Advice.FieldValue("interceptors") List<ServerInterceptor> interceptors) {
-      boolean shouldRegister = true;
-      for (ServerInterceptor interceptor : interceptors) {
-        if (interceptor instanceof GrpcServerInterceptor) {
-          shouldRegister = false;
-          break;
-        }
-      }
-      if (shouldRegister) {
-        // Interceptors run in the reverse order in which they are added
-        // OTEL interceptor is last
-        interceptors.add(interceptors.size() - 1, new GrpcServerInterceptor());
+    public static void onEnter(@Advice.This ServerBuilder<?> serverBuilder) {
+      int callDepth = CallDepthThreadLocalMap.incrementCallDepth(GrpcServerInterceptor.class);
+      if (callDepth == 0) {
+        serverBuilder.intercept(new GrpcServerInterceptor());
       }
     }
+
+    @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
+    public static void onExit() {
+      CallDepthThreadLocalMap.decrementCallDepth(GrpcServerInterceptor.class);
+    }
   }
 }

instrumentation/grpc-1.5/src/main/java/io/opentelemetry/instrumentation/hypertrace/grpc/v1_5/server/GrpcServerBodyInstrumentationModule.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright The Hypertrace Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.opentelemetry.instrumentation.hypertrace.grpc.v1_5.server;
+
+import com.google.auto.service.AutoService;
+import io.opentelemetry.instrumentation.hypertrace.grpc.v1_5.GrpcInstrumentationName;
+import io.opentelemetry.javaagent.tooling.InstrumentationModule;
+import io.opentelemetry.javaagent.tooling.TypeInstrumentation;
+import java.util.Collections;
+import java.util.List;
+
+@AutoService(InstrumentationModule.class)
+public class GrpcServerBodyInstrumentationModule extends InstrumentationModule {
+
+  public GrpcServerBodyInstrumentationModule() {
+    super(GrpcInstrumentationName.PRIMARY, GrpcInstrumentationName.OTHER);
+  }
+
+  @Override
+  public int getOrder() {
+    return -1;
+  }
+
+  @Override
+  public List<TypeInstrumentation> typeInstrumentations() {
+    return Collections.singletonList(new GrpcServerBodyInstrumentation());
+  }
+}