Add support gRPC 1.59.x and 1.70.x server interceptor trace (#764)

Root cause, grpc/grpc-java@050ae18 made changes to AbstractServerImplBuilder, which causes a functional issue with the gRPC tracing plugin.

Author: huicunjun

.github/workflows/plugins-test.0.yaml

@@ -80,6 +80,8 @@ jobs:
           - gateway-2.1.x-scenario
           - gateway-2.0.x-scenario
           - grpc-scenario
+          - grpc-1.59.x-1.70.x-scenario
+          - grpc-1.30.x-1.39.x-scenario
           - gson-scenario
           - guava-cache-scenario
           - elasticjob-3.x-scenario

CHANGES.md

@@ -16,6 +16,7 @@ Release Notes.
 * Fix RabbitMQ Consumer could not receive handleCancelOk callback.
 * Support for tracking in lettuce versions 6.5.x and above.
 * Upgrade byte-buddy version to 1.17.6.
+* Support gRPC 1.59.x and 1.70.x server interceptor trace
 
 All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/236?closed=1)
 

apm-sniffer/apm-sdk-plugin/grpc-1.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/grpc/v1/define/AbstractServerImplBuilderInstrumentation.java

@@ -24,14 +24,13 @@
 import org.apache.skywalking.apm.agent.core.plugin.interceptor.InstanceMethodsInterceptPoint;
 import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.ClassInstanceMethodsEnhancePluginDefine;
 import org.apache.skywalking.apm.agent.core.plugin.match.ClassMatch;
+import org.apache.skywalking.apm.agent.core.plugin.match.MultiClassNameMatch;
 
 import static net.bytebuddy.matcher.ElementMatchers.named;
 import static net.bytebuddy.matcher.ElementMatchers.takesNoArguments;
-import static org.apache.skywalking.apm.agent.core.plugin.match.NameMatch.byName;
 
 public class AbstractServerImplBuilderInstrumentation extends ClassInstanceMethodsEnhancePluginDefine {
 
-    public static final String ENHANCE_CLASS = "io.grpc.internal.AbstractServerImplBuilder";
     public static final String ENHANCE_METHOD = "build";
     public static final String INTERCEPT_CLASS = "org.apache.skywalking.apm.plugin.grpc.v1.server.AbstractServerImplBuilderInterceptor";
 
@@ -64,6 +63,9 @@ public boolean isOverrideArgs() {
 
     @Override
     protected ClassMatch enhanceClass() {
-        return byName(ENHANCE_CLASS);
+        return MultiClassNameMatch.byMultiClassMatch(
+                "io.grpc.internal.AbstractServerImplBuilder", //grpc version <= 1.58.1
+                "io.grpc.internal.ServerImplBuilder" //grpc version >= 1.59.0
+        );
     }
 }

apm-sniffer/apm-sdk-plugin/grpc-1.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/grpc/v1/server/AbstractServerImplBuilderInterceptor.java

@@ -20,7 +20,11 @@
 
 import io.grpc.ServerBuilder;
 
+import java.lang.reflect.Field;
 import java.lang.reflect.Method;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
 
 import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedInstance;
 import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.InstanceMethodsAroundInterceptor;
@@ -30,14 +34,26 @@
  * {@link AbstractServerImplBuilderInterceptor} add the {@link ServerInterceptor} interceptor for every ServerService.
  */
 public class AbstractServerImplBuilderInterceptor implements InstanceMethodsAroundInterceptor {
+    private final static Map<Class<?>, Field> FIELD_CACHE = new HashMap<>();
+
     @Override
     public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allArguments, Class<?>[] argumentsTypes,
-        MethodInterceptResult result) {
+                             MethodInterceptResult result) throws Throwable {
         if (objInst.getSkyWalkingDynamicField() == null) {
             ServerBuilder<?> builder = (ServerBuilder) objInst;
-            ServerInterceptor interceptor = new ServerInterceptor();
-            builder.intercept(interceptor);
-            objInst.setSkyWalkingDynamicField(interceptor);
+            Field field = findField(builder.getClass());
+            if (field != null) {
+                List<?> interceptors = (List<?>) field.get(builder);
+                boolean hasCustomInterceptor = interceptors.stream()
+                        .anyMatch(i -> i.getClass() == ServerInterceptor.class);
+
+                if (!hasCustomInterceptor) {
+                    ServerInterceptor interceptor = new ServerInterceptor();
+                    builder.intercept(interceptor);
+                    objInst.setSkyWalkingDynamicField(interceptor);
+                }
+
+            }
         }
     }
 
@@ -52,4 +68,31 @@ public void handleMethodException(EnhancedInstance objInst, Method method, Objec
         Class<?>[] argumentsTypes, Throwable t) {
 
     }
+
+    private static Field findField(Class<?> clazz) {
+        if (FIELD_CACHE.containsKey(clazz)) {
+            return FIELD_CACHE.get(clazz);
+        }
+        synchronized (AbstractServerImplBuilderInterceptor.class) {
+            if (FIELD_CACHE.containsKey(clazz)) {
+                return FIELD_CACHE.get(clazz);
+            }
+            Field field = doFindField(clazz);
+            FIELD_CACHE.put(clazz, field);
+            return field;
+        }
+    }
+
+    private static Field doFindField(Class<?> clazz) {
+        while (clazz != null) {
+            for (Field f : clazz.getDeclaredFields()) {
+                if (f.getName().equals("interceptors")) {
+                    f.setAccessible(true);
+                    return f;
+                }
+            }
+            clazz = clazz.getSuperclass();
+        }
+        return null;
+    }
 }

test/plugin/scenarios/grpc-1.30.x-1.39.x-scenario/bin/startup.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+
+home="$(cd "$(dirname $0)"; pwd)"
+
+java -jar ${agent_opts} ${home}/../libs/grpc-1.30.x-1.39.x-scenario.jar &