Btrace 线上调试代码利器-CFANZ编程社区

Btrace 简介

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

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

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

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

Btrace可以做什么？

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

下载

Windows-btrace-bin.zip
Linux-btrace-bin.tar.gz

安装Btrace

# 下载安装包[https://bintray.com/btraceio/releases/btrace/v2.0.0]
https://bintray.com/btraceio/releases/download_file?file_path=btrace-bin.tar.gz

# 解压 
tar -xvf btrace-bin.tar.gz

# 设置环境变量, windows: %BTRACE_HOME%\bin
export BTRACE_HOME=/home/soft/btrace  
export PATH=$PATH:$BTRACE_HOME/bin

Btrace 入门案例

添加 jar包依赖

<dependency>
    <groupId>com.sun.tools.btrace</groupId>
    <artifactId>btrace-agent</artifactId>
    <version>2.0.0</version>
    <scope>system</scope>
    <systemPath>${project.basedir}/lib/btrace-agent.jar</systemPath>
</dependency>
<dependency>
    <groupId>com.sun.tools.btrace</groupId>
    <artifactId>btrace-boot</artifactId>
    <version>2.0.0</version>
    <scope>system</scope>
    <systemPath>${project.basedir}/lib/btrace-boot.jar</systemPath>
</dependency>
<dependency>
    <groupId>com.sun.tools.btrace</groupId>
    <artifactId>btrace-client</artifactId>
    <version>2.0.0</version>
    <scope>system</scope>
    <systemPath>${project.basedir}/lib/btrace-client.jar</systemPath>
</dependency>

Btrace 相关 jar 包在： $BTRACE_HOME/libs 下

BTraceDemo

public class BTraceDemo {
    public static Random random = new Random();
    public int size;

    public static void main(String[] args) throws Exception {
        new BTraceDemo().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;
    }
}

Debug

@BTrace
public class Debug {
    @Export
    static long counter;

    @OnMethod(clazz = "com.answer.btrace.BTraceDemo", method = "add", location = @Location(Kind.RETURN))
    public static void run(@Self Object self, int a, int b, @Return int result, @Duration long time) {
        BTraceUtils.println("parameter a=" + a + ", b=" + b);
        BTraceUtils.println("cost time=" + time);
        BTraceUtils.println();
        counter++;
    }

    @OnTimer(1000)
    public static void run() {
        BTraceUtils.println("execute counter:" + counter);
        BTraceUtils.println();
    }

}

进入 BTrace 脚本所在目录，即： Debug.java 所在目录，执行btrace <PID> Debug.java

参数说明

@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指定该java类为一个btrace脚本文件。

属性注解

@TLS标注的属性可以在追踪脚本的方法中通讯

方法注解

@OnMethod:指定该方法在什么情况下被执行，clazz属性指定要跟踪的类的全限定类名，也可以用正则表达式，“/类名的Pattern/”匹配，如/javax\.swing\…*/；用”+类名”追踪所有子类，如+java.lang.Runnable；用”@xxx”追踪用该注解注解过的类，如@javax.jws.WebService。method属性指定要追踪的方法名称，也可以用正则表达式。location属性用@Location来指定该方法在目标方法执行前(后、异常、某行、某个方法调用)被执行。
@OnTimer:定时执行该方法。
@OnExit:当脚本运行Sys.exit(code)时执行该方法。
@OnError:当脚本运行抛出异常时执行该方法。
@OnEvent:脚本运行时Ctrl+C可以发送事件。
@OnLowMemory:指定一个内存阀值，低于阀值值执行该方法。
@OnProbe:指定一个xml文件来描述在什么时候执行该方法。

方法参数注解

@Self:指目标对象本身。
@Retrun:指目标程序方法返回值(需要配合Kind.RETURN)。
@ProbeClassName:指目标类名。
@ProbeMethodName:指目标方法名。
@targetInstance:指@Location指定的clazz和method的目标(需要配合Kind.CALL)。
@targetMethodOrField:指@Location指定的clazz和method的目标的方法或字段(需要配合Kind.CALL)
@Duration:指目标方法执行时间，单位是纳秒(需要需要配合Kind.RETURN或Kind.ERROR一起使用)。
@AnyType:获取对应请求的参数，泛指任意类型。

追踪时机参数
- Kind.Entry:开始进入目标方法时，默认值。

Kind.Return:目标方法返回时。
Kind.Error:异常没被捕获被抛出目标方法之外时。
Kind.Throw:异常抛出时。
Kind.Catch:异常被捕获时。
Kind.Call:被调用时。
Kind.Line:执行到某行时。

其它
- 追踪构造函数：@OnMethod(clazz=“java.net.ServerSocket”,method="”)。

追踪静态内部类：在类与内部类之间加上""，例如@OnMethod(clazz="com.vip.MyServer "，例如@OnMethod(clazz=“com.vip.MyServer”，例如@OnMethod(clazz=“com.vip.MyServerMyInnerClass”, method="hello”)。
追踪同名函数：如果有多个同名的函数，可以在拦截函数上定义不同的参数列表。
追踪结果输出可以使用>将结果输出到指定文件。

如何使用Btrace定位问题

分析哪个方法调用了System.gc()，调用栈如何？

@OnMethod(clazz = "java.lang.System", method = "gc", location = @Location(Kind.ENTRY))
public static void onSystemGC() {
    BTraceUtils.println("System GC");
    BTraceUtils.jstack();
}

统计方法的调用次数，且每隔1分钟打印调用次数

@Export
static AtomicInteger counter = new AtomicInteger();

@OnMethod(clazz = "com.answer.btrace.BTraceDemo", method = "add")
public static void run(@Self Object self) {
    counter.getAndIncrement();
}

// @OnTimer注解可以实现定时执行脚本中的一个方法
@OnTimer(1000 * 60)
public static void run() {
    BTraceUtils.println("counter: " + counter.get());
    counter.set(0);
}

方法执行时，查看对象的实例属性值

@OnMethod(clazz = "com.answer.btrace.BTraceDemo", method = "add")
public static void getField(@Self Object self) {
    Field field = BTraceUtils.field("com.answer.btrace.BTraceDemo", "size");
    int size = (int) BTraceUtils.get(field, self);
    BTraceUtils.println(size);
}

实战

@BTrace
public class Debuger {

    @Export
    static long counter;

    @OnMethod(clazz = "com.answer.controller.SystemController", method = "queryDicts", location = @Location(Kind.RETURN))
    public static void run(
            @ProbeClassName String className,
            @ProbeMethodName String methodName,
            @Self Object self,
            String[] dictCodes,
            @Return AnyType result,
            @Duration long time) {
        BTraceUtils.println("className=" + className);
        BTraceUtils.printArray(dictCodes);
        BTraceUtils.println("methodName=" + methodName);
        BTraceUtils.println("cost time=" + time);
        if (dictCodes != null) {
            BTraceUtils.println("dictCodes=" + dictCodes);
        }

        BTraceUtils.println("result=" + result);
        BTraceUtils.println();
        counter++;
    }

    @OnTimer(10 * 1000)
    public static void run() {
        BTraceUtils.println("execute counter:" + counter);
        counter = 0;
        BTraceUtils.println();
    }

}

Reference

btrace github
如何在生产环境使用Btrace进行调试
基于Btrace的监控调试