Java诊断工具 - btrace

https://github.com/btraceio/btrace/releases

打印慢调用

创建一个java类

// MethodDuration_redis.java
import com.sun.btrace.annotations.*;
import static com.sun.btrace.BTraceUtils.*;
import java.util.Date;

@BTrace
public class MethodDuration_redis{
    private static int i=0;
    @OnMethod(clazz = "com.wiloon.package0.Class0",method = "method0",location=@Location(Kind.RETURN))
    public static void printMethodRunTime(@ProbeClassName String probeClassName,@Duration long duration){
        long d=duration / 1000000;
        if (d>9){ //大于9毫秒的调用
            i++;
            println("index: "+ i +", timestamp:"+timestamp("HH:mm:ss")+", "+probeClassName + ", duration: " + d + " ms");
        }
    }
}

找到 java 进程并执行 btrace

# 打印java进程
jcmd -l
# 执行btrace, ctrl-c 退出
/bin/btrace <PID> MethodDuration_redis.java

Btrace

BTrace 是检查和解决线上的问题的杀器，BTrace 可以通过编写脚本的方式，获取程序执行过程中的一切信息，并且，注意了，不用重启服务，是的，不用重启服务。写好脚本，直接用命令执行即可，不用动原程序的代码。

原理

总体来说，BTrace 是基于动态字节码修改技术(Hotswap)来实现运行时 java 程序的跟踪和替换。大体的原理可以用下面的公式描述：Client(Java compile api + attach api) + Agent (脚本解析引擎 + ASM + JDK6 Instumentation） + Socket其实 BTrace 就是使用了 java attach api 附加 agent.jar ，然后使用脚本解析引擎+asm来重写指定类的字节码，再使用 instrument 实现对原有类的替换。

BTrace是sun公司推出的一款Java 动态、安全追踪 (监控) 工具,可以在不用重启的情况下监控系统运行情况,方便的获取程序运行时的数据信息,如方法参数、返回值、全局变量和堆栈信息等,并且做到最少的侵入,占用最少的系统资源。

由于Btrace会把脚本逻辑直接侵入到运行的代码中,所以在使用上做很多限制:

不能创建对象
不能使用数组
不能抛出或捕获异常
不能使用循环
不能使用synchronized关键字
属性和方法必须使用static修饰

根据官方声明,不恰当的使用BTrace可能导致JVM崩溃,如在BTrace脚本使用错误的class文件,所以在上生产环境之前,务必在本地充分的验证脚本的正确性。

Btrace可以做什么？

接口性能变慢,分析每个方法的耗时情况；
当在Map中插入大量数据,分析其扩容情况；
分析哪个方法调用了System.gc(),调用栈如何；
执行某个方法抛出异常时,分析运行时参数；
….

Btrace第一个例子

package com.metty.rpc.common;
import java.util.Random;

/**
 * Created by j_zhan on 2016/11/28.
 */
public class BtraceCase {
    public static Random random = new Random();
    public int size;

    public static void main(String[] args) throws Exception {
        new BtraceCase().run();
    }

    public void run() throws Exception {
        while (true) {
            add(random.nextInt(10), random.nextInt(10));
        }
    }

    public int add(int a, int b) throws Exception {
        Thread.sleep(random.nextInt(10) * 100);
        return a + b;
    }
}

执行add方法时,对传入参数、返回值以及执行耗时进行分析,btrace脚本:

通过jps命令获取pid为8454

执行btrace 8454 Debug.java实现对运行代码的监控,输出结果如下:

可以发现,Btrace可以获取每次执行add方法时的数据,当然Btrace能做的远远不止这些,比如获取当前jvm堆使用情况、当前线程的执行栈等等。

参数说明

@OnMethod

Btrace使用@OnMethod注解定义需要分析的方法入口

在@OnMethod注解中,需要指定class、method以及location等,class表明需要监控的类,method表明需要监控的方法,指定方式如下:

使用全限定名: clazz=“com.metty.rpc.common.BtraceCase”, method=“add”
使用正则表达式: clazz="/javax\.swing\../", method="/./"
使用接口: clazz="+com.ctrip.demo.Filter", method=“doFilter”
使用注解: clazz="@javax.jws.WebService", method=""@javax.jws.WebMethod"
如果需要分析构造方法,需要指定method=""

@Location

定义Btrace对方法的拦截位置,通过@Location注解指定,默认为Kind.ENTRY

Kind.ENTRY: 在进入方法时,调用Btrace脚本
Kind.RETURN: 方法执行完时,调用Btrace脚本,只有把拦截位置定义为Kind.RETURN,才能获取方法的返回结果@Return和执行时间@Duration
Kind.CALL: 分析方法中调用其它方法的执行情况,比如在execute方法中,想获取add方法的执行耗时,必须把where设置成Where.AFTER
Kind.LINE: 通过设置line,可以监控代码是否执行到指定的位置
Kind.ERROR, Kind.THROW, Kind.CATCH

用于对某些异常情况的跟踪,包括异常抛出,异常被捕获,异常未捕获被抛出方法之外

如何使用Btrace定位问题