I've added a new module, but I'm having trouble getting it to instrument all methods of a specific class. What should I do?

[JangCool]

I want to instrument all methods of a specific class in an application implemented with a Spring project.

I have specified the class using the typeMatcher method and used typeTransformer.applyAdviceToMethod in the transform function. However, it seems like not all methods are being instrumented, even though I declared any() for all methods. None of the methods are being executed.

When I specify particular methods, the Advice class I added gets called. Is there a solution for this?

public class ControllerInstrumentation implements TypeInstrumentation {

    public static final String CLASS_NAME = "kr.co.pionnet.hamonica2.ha.system.controllers.CodesController";

    @Override
    public ElementMatcher<TypeDescription> typeMatcher() {

        System.out.println(" call typeMatcher" + named(CLASS_NAME));
        return named(CLASS_NAME);

    }

    @Override
    public void transform(TypeTransformer typeTransformer) {

        System.out.println(" call transform");

        typeTransformer.applyAdviceToMethod(
                any(),
            this.getClass().getName() + "$ControllerAdvice"
        );

    }

    @SuppressWarnings("unused")
    public static class ControllerAdvice {

        @Advice.OnMethodEnter(suppress = Throwable.class)
        public static void onEnter() {

            System.out.println("controller enter");
        }

        @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
        public static void onExit(@Advice.Thrown Throwable throwable) {

            System.out.println("controller exit");

        }
    }
}

/**
 * This is a demo instrumentation which hooks into servlet invocation and modifies the http
 * response.
 */
@AutoService(InstrumentationModule.class)
public final class ControllerInstrumentationModule extends InstrumentationModule {

  public ControllerInstrumentationModule() {

    super("hamonica2-agent-otel", "hamonica2");
  }


  @Override
  public List<TypeInstrumentation> typeInstrumentations() {
    System.out.println(" call ControllerInstrumentationModule.typeInstrumentations");

    return List.of(new ControllerInstrumentation());
  }

//  @Override
//  public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
//    System.out.println(" call ControllerInstrumentationModule.classLoaderMatcher");
//
//    return AgentElementMatchers.hasClassesNamed("kr.co.pionnet.hamonica2.ha.system.controllers.CodesController");
//  }

  @Override
  public int order() {
    return super.order();
  }

[JangCool]

I've resolved the issue, so I'll provide a self-answered consultation.

I had tried using nameMatches(".*"), but it didn't work, so I was considering other methods. It turned out that the issue was with the regular expression.

.* -> +*

ElementMatchers.nameMatches(".+")

    @Override
    public void transform(TypeTransformer typeTransformer) {

        System.out.println(" call transform");

        typeTransformer.applyAdviceToMethod(
               ElementMatchers.nameMatches(".+"),
            this.getClass().getName() + "$ControllerAdvice"
        );

    }

[laurit]

Turn on debug logging. You'll probably see something like

[otel.javaagent 2024-07-23 09:28:06:230 +0300] [Test worker] ERROR io.opentelemetry.javaagent.testing.bytebuddy.TestAgentListener - Unexpected instrumentation error when instrumenting org.apache.http.impl.client.AbstractHttpClient on jdk.internal.loader.ClassLoaders$AppClassLoader@5679c6c6
java.lang.IllegalStateException: Cannot catch exception during constructor call for protected org.apache.http.impl.client.AbstractHttpClient(org.apache.http.conn.ClientConnectionManager,org.apache.http.params.HttpParams)
	at net.bytebuddy.asm.Advice.doWrap(Advice.java:614)
	at net.bytebuddy.asm.Advice.wrap(Advice.java:569)
	at net.bytebuddy.asm.AsmVisitorWrapper$ForDeclaredMethods$Entry.wrap(AsmVisitorWrapper.java:575)
	at net.bytebuddy.asm.AsmVisitorWrapper$ForDeclaredMethods$DispatchingVisitor.visitMethod(AsmVisitorWrapper.java:657)
	at org.objectweb.asm.ClassVisitor.visitMethod(ClassVisitor.java:384)
	at net.bytebuddy.utility.visitor.MetadataAwareClassVisitor.onVisitMethod(MetadataAwareClassVisitor.java:317)
	at net.bytebuddy.utility.visitor.MetadataAwareClassVisitor.visitMethod(MetadataAwareClassVisitor.java:302)
	at org.objectweb.asm.ClassReader.readMethod(ClassReader.java:1354)
	at org.objectweb.asm.ClassReader.accept(ClassReader.java:745)
	at org.objectweb.asm.ClassReader.accept(ClassReader.java:425)
	at net.bytebuddy.dynamic.scaffold.TypeWriter$Default$ForInlining.create(TypeWriter.java:4014)
	at net.bytebuddy.dynamic.scaffold.TypeWriter$Default.make(TypeWriter.java:2224)
	at net.bytebuddy.dynamic.DynamicType$Builder$AbstractBase$UsingTypeWriter.make(DynamicType.java:4062)
	at net.bytebuddy.agent.builder.AgentBuilder$Default$ExecutingTransformer.doTransform(AgentBuilder.java:12529)
	at net.bytebuddy.agent.builder.AgentBuilder$Default$ExecutingTransformer.transform(AgentBuilder.java:12464)
	at net.bytebuddy.agent.builder.AgentBuilder$Default$ExecutingTransformer.access$1800(AgentBuilder.java:12173)
	at net.bytebuddy.agent.builder.AgentBuilder$Default$ExecutingTransformer$Java9CapableVmDispatcher.run(AgentBuilder.java:12955)
	at net.bytebuddy.agent.builder.AgentBuilder$Default$ExecutingTransformer$Java9CapableVmDispatcher.run(AgentBuilder.java:12885)
	at java.base/java.security.AccessController.doPrivileged(AccessController.java:400)
	at net.bytebuddy.agent.builder.AgentBuilder$Default$ExecutingTransformer.doPrivileged(AgentBuilder.java)
	at net.bytebuddy.agent.builder.AgentBuilder$Default$ExecutingTransformer.transform(AgentBuilder.java:12407)
	at net.bytebuddy.agent.builder.AgentBuilder$Default$ExecutingTransformer$ByteBuddy$ModuleSupport.transform(Unknown Source)
	at java.instrument/sun.instrument.TransformerManager.transform(TransformerManager.java:188)
	at java.instrument/sun.instrument.InstrumentationImpl.transform(InstrumentationImpl.java:610)

any() also includes constructors and catching exceptions for constructors is not allowed. You could use isMethod() instead.

[JangCool]

Thank you for answer. ;)

        typeTransformer.applyAdviceToMethod(
               any().and(isMethod()),
            this.getClass().getName() + "$ControllerAdvice"
        );