使用Btrace进行代码调试

Btrace简介

Btrace是SUN公司开发的一款动态的Trace工具.Btrace最大的好处是可以自己编写脚本,可以实时应用的调用信息,而不用频繁的重启系统.Btrace目前托管在Github上[https://github.com/btraceio/btrace]。Btrace目前最新版本是1.3.11,可以直接从Release[https://github.com/jbachorik/btrace/releases/latest]下载zip,解压即可使用。

Btrace的应用场景

服务慢，能找出慢在哪一步，哪个函数里么？
谁调用了System.gc()，调用栈如何？
谁构造了一个超大的ArrayList?
什么样的入参或对象属性，导致抛出了这个异常？或进入了这个处理分支？
针对没有异常堆栈的情况,可以将异常实时输出

Btrace命令介绍

btrace.bat
执行trace的启动方法
btracec.bat
预编译命令,把指定的脚本进行编译
btracer.bat
主要执行用btracec编译后的.class文件,语法:btracer

第一个例子

public class MethodCall {
    static final String[] userNames = new String[]{"jerrik","smith","bob","scott","angela","ben","jobs","bill","joe","john","rike"};

    static final Random random = new Random();

    public static void main(String[] args){
        System.out.println("startup...");

        new Thread(new Runnable() {
            @Override
            public void run() {
                while(true){
                    doCall(userNames[random.nextInt(userNames.length-1)],"How are you_" + random.nextInt(100));

                    try {
                        TimeUnit.SECONDS.sleep(2);
                    } catch (InterruptedException e) {
                        e.printStackTrace();
                    }
                }
            }
        }).start();

        System.out.println("end...");
    }

    public static String doCall(String userName,String hints){
        return userName + " ," + hints;
    }

现在我想实时拿到传入doCall()的参数,则可以编写该Btrace脚本（注意:方法必须都是静态的）:

@BTrace
public class GetMethodParams {

    @OnMethod(
            clazz = "com.pingan.btrace.execution.MethodCall",
            method = "doCall",
            location = @Location(Kind.RETURN)
    )
    public static void sayHello(String userName, String hints, @Return String result) {
        println("userName: " + userName);
        println("hints: " + hints);
        println(result);
    }
}

然后进入Btrace_HOME/bin,执行btrace.bat pid GetMethodParams.java即可。
控制台会实时将userName,hints进行输出。

D:\open_source\btrace\btrace-bin-1.3.11\bin>btrace.bat 5400 samples\GetMethodPar
ams.java
userName: jerrik
hints: How are you_56
jerrik ,How are you_56
userName: bill
hints: How are you_45
bill ,How are you_45
userName: bill
hints: How are you_2

拦截方法OnMethod

精准拦截
例如:

@OnMethod(
            clazz = "com.pingan.btrace.execution.MethodCall",
            method = "doCall")
)

Btrace会对MethodCall的doCall()方法进行拦截。

接口拦截
例如:

@BTrace
public class RegexMatcherFilter {

    @OnMethod(clazz = "+com.pingan.btrace.execution.Filter",method = "doFilter")
    public static void onFilter(@ProbeClassName String probeClass, @ProbeMethodName String probeMethod){
        BTraceUtils.println("entered " + probeClass + "."  + probeMethod);
    }
}

clazz是以+开头的,即拦截所有Filter接口的实现类。看一下输出结果:

D:\open_source\btrace\btrace-bin-1.3.11\bin>btrace.bat 8116 samples\RegexMatcher
Filter.java
entered com.pingan.btrace.execution.EncodeFilter.doFilter
entered com.pingan.btrace.execution.LogFilter.doFilter
entered com.pingan.btrace.execution.EncodeFilter.doFilter
entered com.pingan.btrace.execution.LogFilter.doFilter

正则拦截
查看samples下的AllMethodsSampled

@BTrace public class AllMethodsSampled {
    @OnMethod(
        clazz="/javax\\.swing\\..*/",
        method="/.*/"
    )
    @Sampled
    public static void m(@Self Object o, @ProbeClassName String probeClass, @ProbeMethodName String probeMethod) {
        println("this = " + o);
        print("entered " + probeClass);
        println("." + probeMethod);
    }
}

即拦截javax.swing包下的所有方法.在生产上不建议这么做,因为范围比较大,会严重影响性能。

构造方法拦截

@OnMethod(
        clazz="java.net.ServerSocket",
        method=""
    )
    public static void onServerSocket(@Self ServerSocket self,
        int p, int backlog, InetAddress bindAddr) {
        port = p;
        inetAddr = bindAddr;
    }

method指定成,具体可以参考samples\SocketTracker，里面用到了一个@TLS注解,作用就是使用ThreadLocal做拦截函数之间数据的共享。

拦截时机Kind

Kind.Entry与Kind.Return
不写Location，默认就是刚进入函数的时候(Kind.ENTRY)，但如果你想获得函数的返回结果或执行时间，则必须把切入点定在返回(Kind.RETURN)
Kind.Error, Kind.Throw和 Kind.Catch
异常抛出(Throw)，异常被捕获(Catch)，异常没被捕获被抛出函数之外(Error)，主要用于对某些异常情况的跟踪。
Kind.Call与Kind.Line
Kind.Call主要用于统计某个方法内其他函数的调用耗时统计,Kind.Line主要用于统计程序是否到达了指定的行，Kind.Call可以写成这样:

@OnMethod(
            clazz = "com.pingan.btrace.execution.StatisicMethodCostTime",
            method = "execute",
            location = @Location(clazz = "/.*/",method = "/.*/",value = Kind.CALL ,where = Where.AFTER)
)
    public static void onInfo(@Self Object self,@TargetInstance Object instance, @TargetMethodOrField String method, @Duration long duration){
        BTraceUtils.println("method: " + method + " ,costTime: " + duration/1000000.0);
 }

Btrace脚本自定义函数中的参数注解

import com.sun.btrace.AnyType;
@OnMethod(clazz = "java.io.File", method = "createTempFile", location = @Location(value = Kind.RETURN))
public static void o(@Self Object self, String prefix, String suffix, @Return AnyType result)

如果想打印它们，首先按顺序定义用@Self 注释的this，完整的参数列表，以及用@Return 注释的返回值。
需要打印哪个就定义哪个，不需要的就不要定义。但定义一定要按顺序，比如参数列表不能跑到返回值的后面。

Self：
如果是静态函数， self为空。前面提到，如果上述使用了非JDK的类，命令行里要指定classpath。不过，如前所述，因为BTrace里不允许调用类的方法，所以定义具体类很多时候也没意思，所以self定义为Object就够了。
参数：
参数数列表要么不要定义，要定义就要定义完整，否则BTrace无法处理不同参数的同名函数。如果有些参数你实在不想引入非JDK类，又不会造成同名函数不可区分，可以用AnyType来定义（不能用Object）。
如果拦截点用正则表达式中匹配了多个函数，函数之间的参数个数不一样，你又还是想把参数打印出来时，可以用AnyType[] args来定义。
但不知道是不是当前版本的bug，AnyType[] args 不能和 location＝Kind.RETURN 同用，否则会进入一种奇怪的静默状态，只要有一个函数定义错了，整个Btrace就什么都打印不出来。
结果：
同理，结果也可以用AnyType来定义，特别是用正则表达式匹配多个函数的时候，连void都可以表示。

更多实战

由于线上异常默认采用快抛的方式(FastThrow),如果我想在不重启的情况下定位该问题应该怎么办？
1.因为快抛只是在访问量比较多的时候才会产生,肯定也存在完整的异常,往上搜索日志即可
2.使用Btrace解决
显然,我们这里用高逼格的Btrace来解决这个问题:

编写脚本

@BTrace
public class OnThrow {

    @TLS
    static Throwable currentException;

    @OnMethod(
            clazz = "java.lang.Throwable",
            method = ""
    )
    public static void onthrow(@Self Throwable self) {
        currentException = self;
    }

    @OnMethod(
            clazz = "java.lang.Throwable",
            method = ""
    )
    public static void onthrow1(@Self Throwable self, String s) {
        currentException = self;
    }

    @OnMethod(
            clazz = "java.lang.Throwable",
            method = ""
    )
    public static void onthrow1(@Self Throwable self, String s, Throwable cause) {
        currentException = self;
    }

    @OnMethod(
            clazz = "java.lang.Throwable",
            method = ""
    )
    public static void onthrow2(@Self Throwable self, Throwable cause) {
        currentException = self;
    }

    @OnMethod(
            clazz = "java.lang.Throwable",
            method = "",
            location = @Location(Kind.RETURN)
    )
    public static void onThrownReturn() {
        if (currentException != null) {
            Threads.jstack(currentException);
            println("<--------------->");
            currentException = null;
        }
    }
}

获取jvm进程id

jps

执行btrace脚本（Windows上）

btrace.bat pid samples\OnThrow.java

即可将异常打印出来,仔细的童鞋一看便知,是通过Threads的jstack方法输出堆栈信息的。注意:Threads不是java自带的类库。

其它
具体可以参考我的github btrace_samples.里面做了一些基本的Demo,更多需求,可以阅读btrace官网samples里的示例。
btrace:https://github.com/btraceio/btrace
btrace_samples:https://github.com/jerrik123/btrace_samples

总结

合理利用Btrace确实会给线上定位问题提速不少,但是也要谨慎,尽量的将范围缩小,在执行Btrace脚本之前,先到测试环境测试一下,不然有可能让jvm奔溃。所以编写脚本的时候最好还是利用IDE来编写代码。