Move Akka and Armeria virtual fields to helpers

custom-checks/src/main/java/io/opentelemetry/javaagent/customchecks/OtelPrivateConstructorForUtilityClass.java

@@ -15,6 +15,7 @@
 import com.google.errorprone.bugpatterns.PrivateConstructorForUtilityClass;
 import com.google.errorprone.matchers.Description;
 import com.sun.source.tree.ClassTree;
+import com.sun.source.tree.Tree;
 
 @AutoService(BugChecker.class)
 @BugPattern(
@@ -31,7 +32,7 @@ public class OtelPrivateConstructorForUtilityClass extends BugChecker
 
   @Override
   public Description matchClass(ClassTree tree, VisitorState state) {
-    if (tree.getSimpleName().toString().endsWith("Advice")) {
+    if (isAdviceOrAdviceNestedClass(tree, state)) {
       return NO_MATCH;
     }
     Description description = delegate.matchClass(tree, state);
@@ -40,4 +41,17 @@ public Description matchClass(ClassTree tree, VisitorState state) {
     }
     return describeMatch(tree);
   }
+
+  private static boolean isAdviceOrAdviceNestedClass(ClassTree tree, VisitorState state) {
+    if (tree.getSimpleName().toString().endsWith("Advice")) {
+      return true;
+    }
+    for (Tree parent : state.getPath()) {
+      if (parent instanceof ClassTree
+          && ((ClassTree) parent).getSimpleName().toString().endsWith("Advice")) {
+        return true;
+      }
+    }
+    return false;
+  }
 }

instrumentation/akka/akka-actor-2.3/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/akkaactor/AkkaActorCellInstrumentation.java

@@ -11,8 +11,6 @@
 import akka.dispatch.Envelope;
 import akka.dispatch.sysmsg.SystemMessage;
 import io.opentelemetry.context.Scope;
-import io.opentelemetry.instrumentation.api.util.VirtualField;
-import io.opentelemetry.javaagent.bootstrap.executors.PropagatedContext;
 import io.opentelemetry.javaagent.bootstrap.executors.TaskAdviceHelper;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
@@ -42,9 +40,8 @@ public static class InvokeAdvice {
 
     @Advice.OnMethodEnter(suppress = Throwable.class)
     public static Scope enter(@Advice.Argument(0) Envelope envelope) {
-      VirtualField<Envelope, PropagatedContext> virtualField =
-          VirtualField.find(Envelope.class, PropagatedContext.class);
-      return TaskAdviceHelper.makePropagatedContextCurrent(virtualField, envelope);
+      return TaskAdviceHelper.makePropagatedContextCurrent(
+          VirtualFields.ENVELOPE_PROPAGATED_CONTEXT, envelope);
     }
 
     @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
@@ -60,9 +57,8 @@ public static class SystemInvokeAdvice {
 
     @Advice.OnMethodEnter(suppress = Throwable.class)
     public static Scope enter(@Advice.Argument(0) SystemMessage systemMessage) {
-      VirtualField<SystemMessage, PropagatedContext> virtualField =
-          VirtualField.find(SystemMessage.class, PropagatedContext.class);
-      return TaskAdviceHelper.makePropagatedContextCurrent(virtualField, systemMessage);
+      return TaskAdviceHelper.makePropagatedContextCurrent(
+          VirtualFields.SYSTEM_MESSAGE_PROPAGATED_CONTEXT, systemMessage);
     }
 
     @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)

instrumentation/akka/akka-actor-2.3/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/akkaactor/AkkaDefaultSystemMessageQueueInstrumentation.java

@@ -12,7 +12,6 @@
 
 import akka.dispatch.sysmsg.SystemMessage;
 import io.opentelemetry.context.Context;
-import io.opentelemetry.instrumentation.api.util.VirtualField;
 import io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge;
 import io.opentelemetry.javaagent.bootstrap.executors.ExecutorAdviceHelper;
 import io.opentelemetry.javaagent.bootstrap.executors.PropagatedContext;
@@ -49,9 +48,8 @@ public static class DispatchSystemAdvice {
     public static PropagatedContext enter(@Advice.Argument(1) SystemMessage systemMessage) {
       Context context = Java8BytecodeBridge.currentContext();
       if (ExecutorAdviceHelper.shouldPropagateContext(context, systemMessage)) {
-        VirtualField<SystemMessage, PropagatedContext> virtualField =
-            VirtualField.find(SystemMessage.class, PropagatedContext.class);
-        return ExecutorAdviceHelper.attachContextToTask(context, virtualField, systemMessage);
+        return ExecutorAdviceHelper.attachContextToTask(
+            context, VirtualFields.SYSTEM_MESSAGE_PROPAGATED_CONTEXT, systemMessage);
       }
       return null;
     }
@@ -61,10 +59,11 @@ public static void exit(
         @Advice.Argument(1) SystemMessage systemMessage,
         @Advice.Enter PropagatedContext propagatedContext,
         @Advice.Thrown Throwable throwable) {
-      VirtualField<SystemMessage, PropagatedContext> virtualField =
-          VirtualField.find(SystemMessage.class, PropagatedContext.class);
       ExecutorAdviceHelper.cleanUpAfterSubmit(
-          propagatedContext, throwable, virtualField, systemMessage);
+          propagatedContext,
+          throwable,
+          VirtualFields.SYSTEM_MESSAGE_PROPAGATED_CONTEXT,
+          systemMessage);
     }
   }
 }

instrumentation/akka/akka-actor-2.3/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/akkaactor/AkkaDispatcherInstrumentation.java

@@ -10,7 +10,6 @@
 
 import akka.dispatch.Envelope;
 import io.opentelemetry.context.Context;
-import io.opentelemetry.instrumentation.api.util.VirtualField;
 import io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge;
 import io.opentelemetry.javaagent.bootstrap.executors.ExecutorAdviceHelper;
 import io.opentelemetry.javaagent.bootstrap.executors.PropagatedContext;
@@ -43,9 +42,8 @@ public static class DispatchEnvelopeAdvice {
     public static PropagatedContext enterDispatch(@Advice.Argument(1) Envelope envelope) {
       Context context = Java8BytecodeBridge.currentContext();
       if (ExecutorAdviceHelper.shouldPropagateContext(context, envelope.message())) {
-        VirtualField<Envelope, PropagatedContext> virtualField =
-            VirtualField.find(Envelope.class, PropagatedContext.class);
-        return ExecutorAdviceHelper.attachContextToTask(context, virtualField, envelope);
+        return ExecutorAdviceHelper.attachContextToTask(
+            context, VirtualFields.ENVELOPE_PROPAGATED_CONTEXT, envelope);
       }
       return null;
     }
@@ -55,9 +53,8 @@ public static void exitDispatch(
         @Advice.Argument(1) Envelope envelope,
         @Advice.Enter PropagatedContext propagatedContext,
         @Advice.Thrown Throwable throwable) {
-      VirtualField<Envelope, PropagatedContext> virtualField =
-          VirtualField.find(Envelope.class, PropagatedContext.class);
-      ExecutorAdviceHelper.cleanUpAfterSubmit(propagatedContext, throwable, virtualField, envelope);
+      ExecutorAdviceHelper.cleanUpAfterSubmit(
+          propagatedContext, throwable, VirtualFields.ENVELOPE_PROPAGATED_CONTEXT, envelope);
     }
   }
 }

instrumentation/akka/akka-actor-2.3/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/akkaactor/VirtualFields.java

@@ -0,0 +1,22 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.akkaactor;
+
+import akka.dispatch.Envelope;
+import akka.dispatch.sysmsg.SystemMessage;
+import io.opentelemetry.instrumentation.api.util.VirtualField;
+import io.opentelemetry.javaagent.bootstrap.executors.PropagatedContext;
+
+public class VirtualFields {
+
+  private VirtualFields() {}
+
+  public static final VirtualField<Envelope, PropagatedContext> ENVELOPE_PROPAGATED_CONTEXT =
+      VirtualField.find(Envelope.class, PropagatedContext.class);
+  public static final VirtualField<SystemMessage, PropagatedContext>
+      SYSTEM_MESSAGE_PROPAGATED_CONTEXT =
+          VirtualField.find(SystemMessage.class, PropagatedContext.class);
+}

instrumentation/akka/akka-actor-fork-join-2.5/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/akkaactor/AkkaForkJoinPoolInstrumentation.java

@@ -10,7 +10,6 @@
 
 import akka.dispatch.forkjoin.ForkJoinTask;
 import io.opentelemetry.context.Context;
-import io.opentelemetry.instrumentation.api.util.VirtualField;
 import io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge;
 import io.opentelemetry.javaagent.bootstrap.executors.ExecutorAdviceHelper;
 import io.opentelemetry.javaagent.bootstrap.executors.PropagatedContext;
@@ -51,9 +50,8 @@ public static class SetAkkaForkJoinStateAdvice {
     public static PropagatedContext enterJobSubmit(@Advice.Argument(0) ForkJoinTask<?> task) {
       Context context = Java8BytecodeBridge.currentContext();
       if (ExecutorAdviceHelper.shouldPropagateContext(context, task)) {
-        VirtualField<ForkJoinTask<?>, PropagatedContext> virtualField =
-            VirtualField.find(ForkJoinTask.class, PropagatedContext.class);
-        return ExecutorAdviceHelper.attachContextToTask(context, virtualField, task);
+        return ExecutorAdviceHelper.attachContextToTask(
+            context, VirtualFields.FORK_JOIN_TASK_PROPAGATED_CONTEXT, task);
       }
       return null;
     }
@@ -63,9 +61,8 @@ public static void exitJobSubmit(
         @Advice.Argument(0) ForkJoinTask<?> task,
         @Advice.Enter PropagatedContext propagatedContext,
         @Advice.Thrown Throwable throwable) {
-      VirtualField<ForkJoinTask<?>, PropagatedContext> virtualField =
-          VirtualField.find(ForkJoinTask.class, PropagatedContext.class);
-      ExecutorAdviceHelper.cleanUpAfterSubmit(propagatedContext, throwable, virtualField, task);
+      ExecutorAdviceHelper.cleanUpAfterSubmit(
+          propagatedContext, throwable, VirtualFields.FORK_JOIN_TASK_PROPAGATED_CONTEXT, task);
     }
   }
 }

instrumentation/akka/akka-actor-fork-join-2.5/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/akkaactor/AkkaForkJoinTaskInstrumentation.java

@@ -15,8 +15,6 @@
 import akka.dispatch.forkjoin.ForkJoinPool;
 import akka.dispatch.forkjoin.ForkJoinTask;
 import io.opentelemetry.context.Scope;
-import io.opentelemetry.instrumentation.api.util.VirtualField;
-import io.opentelemetry.javaagent.bootstrap.executors.PropagatedContext;
 import io.opentelemetry.javaagent.bootstrap.executors.TaskAdviceHelper;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
@@ -62,14 +60,13 @@ public static class ForkJoinTaskAdvice {
      */
     @Advice.OnMethodEnter(suppress = Throwable.class)
     public static Scope enter(@Advice.This ForkJoinTask<?> thiz) {
-      VirtualField<ForkJoinTask<?>, PropagatedContext> virtualField =
-          VirtualField.find(ForkJoinTask.class, PropagatedContext.class);
-      Scope scope = TaskAdviceHelper.makePropagatedContextCurrent(virtualField, thiz);
+      Scope scope =
+          TaskAdviceHelper.makePropagatedContextCurrent(
+              VirtualFields.FORK_JOIN_TASK_PROPAGATED_CONTEXT, thiz);
       if (thiz instanceof Runnable) {
-        VirtualField<Runnable, PropagatedContext> runnableVirtualField =
-            VirtualField.find(Runnable.class, PropagatedContext.class);
         Scope newScope =
-            TaskAdviceHelper.makePropagatedContextCurrent(runnableVirtualField, (Runnable) thiz);
+            TaskAdviceHelper.makePropagatedContextCurrent(
+                VirtualFields.RUNNABLE_PROPAGATED_CONTEXT, (Runnable) thiz);
         if (null != newScope) {
           if (null != scope) {
             newScope.close();
@@ -79,10 +76,9 @@ public static Scope enter(@Advice.This ForkJoinTask<?> thiz) {
         }
       }
       if (thiz instanceof Callable) {
-        VirtualField<Callable<?>, PropagatedContext> callableVirtualField =
-            VirtualField.find(Callable.class, PropagatedContext.class);
         Scope newScope =
-            TaskAdviceHelper.makePropagatedContextCurrent(callableVirtualField, (Callable<?>) thiz);
+            TaskAdviceHelper.makePropagatedContextCurrent(
+                VirtualFields.CALLABLE_PROPAGATED_CONTEXT, (Callable<?>) thiz);
         if (null != newScope) {
           if (null != scope) {
             newScope.close();

instrumentation/akka/akka-actor-fork-join-2.5/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/akkaactor/VirtualFields.java

@@ -0,0 +1,24 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.akkaactor;
+
+import akka.dispatch.forkjoin.ForkJoinTask;
+import io.opentelemetry.instrumentation.api.util.VirtualField;
+import io.opentelemetry.javaagent.bootstrap.executors.PropagatedContext;
+import java.util.concurrent.Callable;
+
+public class VirtualFields {
+
+  private VirtualFields() {}
+
+  public static final VirtualField<ForkJoinTask<?>, PropagatedContext>
+      FORK_JOIN_TASK_PROPAGATED_CONTEXT =
+          VirtualField.find(ForkJoinTask.class, PropagatedContext.class);
+  public static final VirtualField<Runnable, PropagatedContext> RUNNABLE_PROPAGATED_CONTEXT =
+      VirtualField.find(Runnable.class, PropagatedContext.class);
+  public static final VirtualField<Callable<?>, PropagatedContext> CALLABLE_PROPAGATED_CONTEXT =
+      VirtualField.find(Callable.class, PropagatedContext.class);
+}

instrumentation/akka/akka-http-10.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/akkahttp/server/route/PathMatcherInstrumentation.java

@@ -11,7 +11,6 @@
 
 import akka.http.scaladsl.model.Uri;
 import akka.http.scaladsl.server.PathMatcher;
-import io.opentelemetry.instrumentation.api.util.VirtualField;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
 import net.bytebuddy.asm.Advice;
@@ -41,7 +40,7 @@ public static void onEnter(
         @Advice.Argument(0) Uri.Path prefix, @Advice.Return PathMatcher<?> result) {
       // store the path being matched inside a VirtualField on the given matcher, so it can be used
       // for constructing the route
-      VirtualField.find(PathMatcher.class, String.class).set(result, prefix.toString());
+      VirtualFields.PATH_MATCHER_ROUTE.set(result, prefix.toString());
     }
   }
 }

instrumentation/akka/akka-http-10.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/akkahttp/server/route/PathMatcherStaticInstrumentation.java

@@ -12,7 +12,6 @@
 import akka.http.scaladsl.model.Uri;
 import akka.http.scaladsl.server.PathMatcher;
 import akka.http.scaladsl.server.PathMatchers;
-import io.opentelemetry.instrumentation.api.util.VirtualField;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
 import net.bytebuddy.asm.Advice;
@@ -48,7 +47,7 @@ public static void onExit(
         }
         // if present use the matched path that was remembered in PathMatcherInstrumentation,
         // otherwise just use a *
-        String prefix = VirtualField.find(PathMatcher.class, String.class).get(pathMatcher);
+        String prefix = VirtualFields.PATH_MATCHER_ROUTE.get(pathMatcher);
         if (prefix == null) {
           if (PathMatchers.Slash$.class == pathMatcher.getClass()) {
             prefix = "/";

instrumentation/akka/akka-http-10.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/akkahttp/server/route/VirtualFields.java

@@ -0,0 +1,17 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.akkahttp.server.route;
+
+import akka.http.scaladsl.server.PathMatcher;
+import io.opentelemetry.instrumentation.api.util.VirtualField;
+
+public class VirtualFields {
+
+  private VirtualFields() {}
+
+  public static final VirtualField<PathMatcher<?>, String> PATH_MATCHER_ROUTE =
+      VirtualField.find(PathMatcher.class, String.class);
+}

instrumentation/armeria/armeria-grpc-1.14/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/armeria/grpc/v1_14/ArmeriaServerCallInstrumentation.java

@@ -34,6 +34,11 @@ public void transform(TypeTransformer transformer) {
   @SuppressWarnings("unused")
   public static class ConstructorAdvice {
 
+    public static class VirtualFields {
+      public static final VirtualField<ServerCall<?, ?>, String> SERVER_CALL_AUTHORITY =
+          VirtualField.find(ServerCall.class, String.class);
+    }
+
     @Advice.OnMethodExit(suppress = Throwable.class)
     public static void onExit(
         @Advice.This ServerCall<?, ?> serverCall,
@@ -43,7 +48,7 @@ public static void onExit(
         // ArmeriaServerCall does not implement getAuthority. We will store the value for authority
         // header as virtual field, this field is read in grpc instrumentation in
         // TracingServerInterceptor
-        VirtualField.find(ServerCall.class, String.class).set(serverCall, authority);
+        VirtualFields.SERVER_CALL_AUTHORITY.set(serverCall, authority);
       }
     }
   }