btrace 的使用

BTrace是一个非常不错的java诊断工具。
BTrace 中的B表示bytecode，它是在字节码层面上对代码进行trace ，通过在运行中的java类中注入trace代码， 并对运行中的目标程序进行热交换(hotswap)来达到对代码的跟踪 。
记载下几个基本常用的使用方式备查，时间长了就忘记了哈。

首先你需要去官网下载个安装包：wget https://kenai.com/projects/btrace/downloads/download/releases/release-1.2.2/btrace-bin.tar.gz
下载后解压缩安装在自己想要安装的目录tar -xzvf  /home/admin/btrace/btrace-bin.tar.gz，安装好后就是配置环境变量，这个依赖jdk的，同时需要配置JAVA_HOME。

vi /home/zongqian/.bash_profile 

BTRACE_HOME=/home/admin/btrace
JAVA_HOME=/opt/taobao/java

PATH=$PATH:$BTRACE_HOME/bin:$JAVA_HOME/bin:$HOME/bin

export JAVA_HOME
export PATH

配置好自己个个人环境变量后，不要忘记了执行脚本是配置生效 source /home/zongqian/.bash_profile 。

配置好环境后接下来就是编写个测试实例了，执行运用BTrace步骤 分三步。
1.取得目标java进程id(pid) 
2.编写BTrace脚本 
3.执行命令行: btrace <options> <pid> <btrace source or .class file> <btrace arguments>
一般使用过程中难免需要用到被监控进程里面的类，这个时候可以通过 classpath来指定是比较有效的，还有被trace的类可以使用全名路径或者是正则表达式，否则会报no classloader异常。

样例：

package com.taobao.rp.test;


import static com.sun.btrace.BTraceUtils.exit;
import static com.sun.btrace.BTraceUtils.field;
import static com.sun.btrace.BTraceUtils.get;
import static com.sun.btrace.BTraceUtils.jstack;
import static com.sun.btrace.BTraceUtils.printEnv;
import static com.sun.btrace.BTraceUtils.printFields;
import static com.sun.btrace.BTraceUtils.printProperties;
import static com.sun.btrace.BTraceUtils.printVmArguments;
import static com.sun.btrace.BTraceUtils.println;


import com.sun.btrace.BTraceUtils.Strings;
import com.sun.btrace.BTraceUtils.Sys;
import com.sun.btrace.annotations.BTrace;
import com.sun.btrace.annotations.Duration;
import com.sun.btrace.annotations.Kind;
import com.sun.btrace.annotations.Location;
import com.sun.btrace.annotations.OnMethod;
import com.sun.btrace.annotations.Self;


@BTrace
public class BuyerModifyFunctionBtraceTest {


//print System Properties:
static {
println("System Properties:");
printProperties();
println("VM Flags:");
printVmArguments();
println("OS Enviroment:");
printEnv();
exit(0);
}

@OnMethod(clazz = "com.tb.app.biz.workflow.function.common.BuyerModifyBeforeReturnGoodsFunction", method = "storeInTransaction",location=@Location(Kind.RETURN))
public static void traceStoreInTransactionExecute(@Duration long duration) {
println(Strings.strcat("BuyerModifyBeforeReturnGoodsFunction.StoreInTransaction duration is:",Strings.str(duration)));
}


    @OnMethod(clazz = "com.tb.app.biz.workflow.function.common.BuyerModifyBeforeReturnGoodsFunction", method = "storeInTransaction")
    public static void traceBuyerModifyBeforeReturnGoods(@Self com.tb.app.biz.workflow.function.common.BuyerModifyBeforeReturnGoodsFunction instance, 
    com.taobao.refundplatform.rda.RefundRequest refundRequest) {
    
        println("who call BuyerModifyBeforeReturnGoodsFunction.storeInTransaction :");
        jstack();


        Sys.Memory.dumpHeap("heap_zongqian.bin");
        println("heap dumped!");
//        Sys.exit(0);
        
        println("refundRequest is:");
        println(refundRequest);
        
        println("refundRequest Fields is:");
        printFields(refundRequest);
       
        //print object field
        println("refundRequest Fields refundDO is:");
        println(get(field("com.taobao.refundplatform.rda.RefundRequest", "refundDO"), refundRequest));
        
        println("==================");
        Object montmp = get(field("com.taobao.refundplatform.rda.RefundRequest", "refundDO"), refundRequest);
        printFields(montmp);
                
    }

}

执行：
sudo -u admin btrace -cp /home/admin/app/.default/deploy/app.war/WEB-INF/lib/rp-common.jar:/home/admin/app/.default/deploy/app.war/WEB-INF/classes/ 171542 ModifyFunctionBtraceTest.java

然后你就可以走流程测试了，在控制台看到你的对应监控输出，这里的jar包需要制定具体的jar路径引用。

如果是需要在目标程序启动的时候trace，那么BTrace Agent 就是适用这个场景的。
BTrace Agent主要针对需要在目标程序启动的时候就需要trace其行为的场景, 此时BTrace agent将与目标程序一起启动(前提是必须对BTrace脚本进行预编译) 

在java启动的脚本添加命令行: 
引用
java -javaagent:btrace-agent.jar=script=<pre-compiled-btrace-script1>[,<pre-compiled-btrace-script1>]* <MainClass> <AppArguments>
eg:
 -javaagent:/home/admin/app/dtd/btrace/build/btrace-agent.jar=script=/home/admin/app/dtd/btrace/build/TrackDTDXSDLoad.class,scriptOutputFile=/home/admin/refundplatform/logs/dtdxsdloadstatus.log 

BTrace 处于安全方面的考虑，做了很多的限制，比如：不能够创建对象等。不过有些时候，如果能关闭这些限制，BTrace的功能将大大增强。
这个限制的开关设置在${BTRACE_HOME}/bin/btrace 脚本中com.sun.btrace.unsafe=true;修改为false即可。
eg：

${JAVA_HOME}/bin/java -Dcom.sun.btrace.probeDescPath=. -Dcom.sun.btrace.dumpClasses=false -Dcom.sun.btrace.debug=false -Dcom.sun.btrace.unsafe=false -cp ${BTRACE_HOME}/build/btrace-client.jar:${TOOLS_JAR}:/usr/share/lib/java/dtrace.jar com.sun.btrace.client.Main $*

btrace WIKI：https://kenai.com/projects/btrace/pages/UserGuide，里面有很多实用的样例，比如异常捕捉等。