使用Byte Buddy for Java Agent

时间:2015-10-26 13:09:28

标签: java bytecode instrumentation byte-buddy

我希望创建一个代理人来附加我们的直播Tomcat& Weblogic服务器将拦截对我公司包中声明的所有类的所有方法调用,并对执行时间等指标进行一些记录。

我遇到了Byte Buddy图书馆,似乎很适合这个。但是,我并不是100%明确使用Byte Buddy创建代理的方法:

我选择创建自己的代理并使用Maven将其打包,将Byte Buddy包含为 fat jar (以便Byte Buddy代码在类路径上),我参考了来自我的catalina.bat

编辑:我已经下载了源代码,并发现AgentBuilder依赖于byte-buddy-agent软件包,因此上述问题无关紧要。

Tomcat启动正常,我可以看到代理被调用,因为我看到了"进入了premain" System.out

然而,我从未见过" Intercepted" System.out当我在部署到Tomcat的单独war文件上执行代码时。 编辑:以下代码根据Rafael的回复进行了更新,现在正在运行。

有人可以告诉我这里可能做错了什么吗?我已经在下面列出了代理商代码。

另外,有人可以告诉我哪个ElementMatchers最适合打包匹配吗?我尝试nameStartsWith但它没有效果,API文档没有说明它是否是完全限定的类名。

*编辑:nameStartsWith会检查包。 *

无论如何,提前感谢您的帮助!

package com.mycompany.agent;

import java.lang.instrument.Instrumentation;
import java.util.concurrent.Callable;

import net.bytebuddy.agent.builder.AgentBuilder;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.dynamic.DynamicType;
import net.bytebuddy.implementation.MethodDelegation;
import net.bytebuddy.implementation.bind.annotation.RuntimeType;
import net.bytebuddy.implementation.bind.annotation.SuperCall;
import net.bytebuddy.matcher.ElementMatchers;

public class MyAgent {

public static void premain(String agentArgument, Instrumentation instrumentation) {
    System.out.println("Entered premain");
    try{
        new AgentBuilder.Default()
                .withListener( new AgentBuilder.Listener() {

                    public void onComplete(String arg0) {
                        System.out.println("Completed - " + arg0);
                    }

                    public void onError(String arg0, Throwable arg1) {
                        System.out.println("Error - " + arg0+", "+arg1.getMessage());
                        arg1.printStackTrace();
                    }

                    public void onIgnored(String arg0) {
                        System.out.println("Ignored - " + arg0);
                    }

                    public void onTransformation(TypeDescription arg0, DynamicType arg1) {
                        System.out.println("Transformed - " + arg0+", type = "+arg1);
                    }

                })
                .rebase(ElementMatchers.nameStartsWith("com.mycompany"))
                .transform(new AgentBuilder.Transformer() {
                    public DynamicType.Builder transform(DynamicType.Builder builder, TypeDescription typeDescription) {
                        return builder.method(ElementMatchers.any()).intercept(MethodDelegation.to(new Interceptor()));
                    }
                }).installOn(instrumentation);
    }
    catch (RuntimeException e) {
        System.out.println("Exception instrumenting code : "+e);
        e.printStackTrace();
    }

}



package com.mycompany.agent;

import java.lang.reflect.Method;
import java.util.concurrent.Callable;

import net.bytebuddy.implementation.bind.annotation.AllArguments;
import net.bytebuddy.implementation.bind.annotation.Origin;
import net.bytebuddy.implementation.bind.annotation.RuntimeType;
import net.bytebuddy.implementation.bind.annotation.SuperCall;

@SuppressWarnings("rawtypes")
public class Interceptor {

@RuntimeType
public Object intercept( @SuperCall Callable<?> callable, @AllArguments Object[] allArguments, @Origin Method method, @Origin Class clazz) throws Exception {
    long startTime = System.currentTimeMillis();
    Object response;
    try{
        response = callable.call();
    }
    catch(Exception e) {
        System.out.println("Exception occurred in method call: " + methodName(clazz, method, allArguments) + " Exception = " + e);
        throw e;
    }
    finally{
        System.out.println("Method " + methodName(clazz, method) + " completed in " + (System.currentTimeMillis() - startTime) + " miliseconds");
    }
    return response;
}

private String methodName(Class clazz, Method method){
    return methodName(clazz, method, null);
}

private String methodName(Class clazz, Method method, Object[] allArguments){
    StringBuilder builder = new StringBuilder();
    builder.append(clazz.getName());
    builder.append(".");
    builder.append(method.getName());
    builder.append("(");
    for(int i = 0; i < method.getParameters().length; i++) {

        builder.append(method.getParameters()[i].getName());
        if(allArguments != null) {
            Object arg = allArguments[i];
            builder.append("=");
            builder.append(arg != null ? arg.toString() : "null");              
        }

        if(i < method.getParameters().length - 1) {
            builder.append(", ");
        }
    }
    builder.append(")");
    return builder.toString();
}

1 个答案:

答案 0 :(得分:2)

一切似乎都是对的。你应该总是尝试注册一个Interceptor,如果Byte Buddy导致异常信号指示非法的仪器尝试,它将暴露不成功的仪器的堆栈痕迹。

我认为您的<TypeScriptToolsVersion>类的包的私有定义是导致此异常的原因。您的拦截器必须对所有已检测的代码可见。否则,该类不可调用。