【性能跟踪】btrace学习一--安装btrace

最近公司里为了监控线上的类，方法的执行时间，结果等用到了这个开源的小工具，自己也学习了下，感觉比较简单，但是还是挺实用的。

这里做个学习笔记。

 

1.首先到网上下个Btrace包吧，官方网址是：http://kenai.com/projects/btrace

btrace不用怎么安装，下下来之后解压就可以直接使用了。window下,linux下都是一样的，这里就按window下的安装来说

下下来解压如下：


 

 

用到的就是Bin目录下的；



假如环境变量就可以了

 

2、上面配置好后，打开一个控制台：

 

输入命令 btrace:



 

这样就ok了。。

 

3、下面就可以用这个工具做监控了

4、linux的配置安装：

使用btrace可以在不改进代码，不影响当前线上运行的基础上进行运行时环境的跟踪，

可以免去打日志，发部等繁琐的工作

使用Btrace可以从官网上下载相应二进制文件

下载地址为：http://kenai.com/projects/btrace/downloads

下载后解压，需要配置环境变量

将目录 btrace/bin 配置到自己的PATH环境变量中， 同进也可以将btrace/build配置到classpath当中去

LINUX下编辑/etc/profile文件，可将上述配置弄好，然后执行source /etc/profile可使用变量生效

配置完成后在终端执行 btrace 命令，若出现如下结果表明安装正确(如何配置，本页面见下一篇博客)

Usage: btrace <options> <pid> <btrace source or .class file> <btrace arguments>
where possible options include:
  -classpath <path> Specify where to find user class files and annotation processors
  -cp <path>        Specify where to find user class files and annotation processors
  -I <path>         Specify where to find include files
  -p <port>         Specify port to which the btrace agent listens for clients

尝试第一个BTrace应用

编写测试类 Case1 and CaseObject

[java] view
plaincopyprint?

import java.util.Random;  

public class Case1{  

  

   public static void main(String[] args) throws Exception{  

      Random random=new Random();  

      CaseObject object=new CaseObject();  

      boolean result=true;  

      while(result){  

         result=object.execute(random.nextInt(1000));  

         Thread.sleep(1000);  

      }  

   }  

  

}  

class CaseObject{  

  

   private static int sleepTotalTime=0;  

  

   public boolean execute(int sleepTime) throws Exception{  

       System.out.println("sleep: "+sleepTime);  

       sleepTotalTime+=sleepTime;  

       Thread.sleep(sleepTime);  

       return true;  

   }  

  

}  

第二步，编写BTrace角本 TraceMethodArgsAndReturn.java

[java] view
plaincopyprint?

import static com.sun.btrace.BTraceUtils.*;  

import com.sun.btrace.annotations.*;  

  

@BTrace  

public class TraceMethodArgsAndReturn{  

  

 @OnMethod(  

      clazz="CaseObject",  

      method="execute",  

      location=@Location(Kind.RETURN)  

   )  

   public static void traceExecute(@Self CaseObject instance,int sleepTime,@Return boolean result){  

     println("call CaseObject.execute");  

     println(strcat("sleepTime is:",str(sleepTime)));  

     println(strcat("sleepTotalTime is:",str(get(field("CaseObject","sleepTotalTime"),instance))));  

     println(strcat("return value is:",str(result)));  

   }  

}  

注意，在这里我们两个文件都放在同一个目录，同时需要将第一个java文件编译成class文件，即字节码

将Case1程序运行起来，他将是一个无限循环的程序，这样可以保证一直在运行，方便我们去捕获运行时的一些信息

下一步我们将用jps命令去查看case1进程的pid是多少， 假如我们获得的Case1的pid是4444

最后一步我们将执行btrace角本去获得相关信息， 执行命令如下

 btrace <options> <pid> <btrace source or .class file> <btrace arguments>

在我们这个实例中就是：

btrace 4444 TraceMethodArgsAndReturn.java

 执行完后你就可以看到效果了啦.........................

-------------------------------------------------------------------------------------------------
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 

[plain] view
plaincopy





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异常。

样例：

[java] view
plaincopy





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，里面有很多实用的样例，比如异常捕捉等。