在生产环境中经常遇到格式各样的问题，如OOM或者莫名其妙的进程死掉。一般情况下是通过修改程序，添加打印日志；然后重新发布程序来完成。然而，这不仅麻烦，而且带来很多不可控的因素。有没有一种方式，在不修改原有运行程序的情况下获取运行时的数据信息呢？如方法参数、返回值、全局变量、堆栈信息等。Btrace就是这样一个工具，它可以在不修改原有代码的情况下动态地追踪java运行程序，通过hotswap技术，动态将跟踪字节码注入到运行类中，对运行代码侵入较小，对性能上的影响可以忽略不计。
基础说明
由于Btrace会把脚本逻辑直接侵入到运行的代码中，所以在使用上做很多限制：
- 不能创建对象
- 不能使用数组
- 不能抛出或捕获异常
- 不能使用循环
- 不能使用synchronized关键字
- 属性和方法必须使用static修饰
需要特别注意的是：不恰当的使用BTrace可能导致JVM崩溃，如在BTrace脚本使用错误的class文件，所以在上生产环境之前，务必在本地充分的验证脚本的正确性。
Btrace可以做什么？
- 接口性能变慢，分析每个方法的耗时情况；
- 当在Map中插入大量数据，分析其扩容情况；
- 分析哪个方法调用了System.gc()，调用栈如何；
- 执行某个方法抛出异常时，分析运行时参数；
- ....
参数说明：
指定分析方法的入口：@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能做的事情太多，但使用之前切记检查脚本的可行性，一旦Btrace脚本侵入到系统中，只有通过重启才能恢复。
通过jvisualvm插件的方式进行测试：
安装Btrace插件
工具-->插件-->可用插件中找到BTrace Workbench进行安装即可。
测试用例
package com.vmtools;
public class Counter {
// 总数
private static int totalCount = 0;
public int add(int num) throws Exception {
totalCount += num;
sleep();
return totalCount;
}
private void sleep() throws InterruptedException {
Thread.sleep(1000);
}
}
package com.vmtools;
import java.util.Random;
public class BtraceTest {
public static void main(String[] args) throws Exception {
Random random = new Random();
// 计数器
Counter counter = new Counter();
while (true) {
// 每次增加随机值
counter.add(random.nextInt(10));
Thread.sleep(1000);
}
}
}
Btrace测试
运行上诉测试用例
jvisualvm中找到对应的进程id-->Trace application...-->分别进行相应的测试
获取add()方法参数值和返回值。
/* BTrace Script Template */
import com.sun.btrace.annotations.*;
import static com.sun.btrace.BTraceUtils.*;
//获取add()方法参数值和返回值。
@BTrace
public class TracingScript {
/* put your code here */
@OnMethod(
clazz="com.vmtools.Counter",
method="add",
location=@Location(Kind.RETURN)
)
public static void func(
int a,
@Return int result) {
println("trace: =======================");
jstack();
println(strcat("a:", str(a)));
println(strcat("result:", str(result)));
}
}
定时获取Counter类的属性值totalCount
/* BTrace Script Template */
import com.sun.btrace.annotations.*;
import static com.sun.btrace.BTraceUtils.*;
//定时获取Counter类的属性值totalCount。
@BTrace
public class TracingScript {
private static Object totalCount=0;
/* put your code here */
@OnMethod(
clazz="com.vmtools.Counter",
method="add",
location=@Location(Kind.RETURN)
)
public static void func(@Self com.vmtools.Counter counter) {
totalCount = get(field("com.vmtools.Counter", "totalCount"), counter);
}
@OnTimer(2000)
public static void print(){
println(" ====== ");
println(strcat("totalCount: ",str(totalCount)));
}
}
获取add方法执行时间
/* BTrace Script Template */
import com.sun.btrace.annotations.*;
import static com.sun.btrace.BTraceUtils.*;
//获取add方法执行时间
@BTrace
public class TracingScript {
@TLS private static long startTime = 0;
/* put your code here */
@OnMethod(
clazz="com.vmtools.Counter",
method="add"
)
public static void func(@Self com.vmtools.Counter counter) {
startTime = timeNanos();
}
@OnMethod(
clazz="com.vmtools.Counter",
method="add",
location=@Location(Kind.RETURN)
)
public static void endExecute(@Duration long duration){
long time = timeNanos() - startTime;
println(strcat("execute time(nanos): ", str(time)));
println(strcat("duration(nanos): ", str(duration)));
}
}
参考文档：