一、Btrace
BTrace是sun公司推出的一款Java 动态、安全追踪(监控)工具,可以在不用重启的情况下监控系统运行情况,方便的获取程序运行时的数据信息,如方法参数、返回值、全局变量和堆栈信息等,并且做到最少的侵入,占用最少的系统资源。由于Btrace会把脚本逻辑直接侵入到运行的代码中,所以在使用上做很多限制:
1、不能创建对象
2、不能使用数组
3、不能抛出或捕获异常
4、不能使用循环
5、不能使用synchronized关键字
6、属性和方法必须使用static修饰
根据官方声明,不恰当的使用BTrace可能导致JVM崩溃,如在BTrace脚本使用错误的class文件,所以在上生产环境之前,务必在本地充分的验证脚本的正确性。
Btrace可以做什么?
1、接口性能变慢,分析每个方法的耗时情况;
2、当在Map中插入大量数据,分析其扩容情况;
3、分析哪个方法调用了System.gc(),调用栈如何;
4、执行某个方法抛出异常时,分析运行时参数;
二、下载btrace包
原有官网已经搬迁至github上,直接给出下载地址: https://github.com/btraceio/btrace/releases下面的安装步骤主要就是设置环境变量,其实也可以不设置。这里设置下只是为方便执行命令而已。另外各种操作系统设置环境变量的方法也有所不同,我这里是采用的 mac 系统,采用的终端软件我也改变了一下,所以需要各自根据自己的实际情况进行设置。
下载完成后,执行:
mkdir btrace tar -zxvf btrace-bin-1.3.8.1.tgz -C btrace假设btrace路径为 : /usr/local/btrace
下面只需要设置 BTRACE_HOME 和 PATH 两个环境变量即可。
注意我这里修改的文件是~/.zshrc文件。这个要看各自使用的操作系统以及所使用的terminal客户端而定。具体是哪个文件请各自查阅相关资料。
vim ~/.zshrc
拉到文件末尾,添加以下代码:(建议不要去修改已有的配置,只需要在末尾追加即可)
export BTRACE_HOME="/Applications/btrace" export PATH=$BTRACE_HOME/bin:$PATH
保存文件,执行:
source ~/.zshrc基本用法
btrace pid btrace脚本
三、创建基础测试类
1、建立一个maven项目,引入依赖,目前用的是1.2.3版本,更新版本可到以下链接自行拉取btrace-boot: http://mvnrepository.com/artifact/com.sun.tools.btrace/btrace-boot
btrace-agent:http://mvnrepository.com/artifact/com.sun.tools.btrace/btrace-agent
maven依赖引用
<dependency> <groupId>com.sun.tools.btrace</groupId> <artifactId>btrace-agent</artifactId> <version>1.2.3</version> </dependency> <dependency> <groupId>com.sun.tools.btrace</groupId> <artifactId>btrace-boot</artifactId> <version>1.2.3</version> </dependency>
2、编写测试类
import static com.sun.btrace.BTraceUtils.*; import com.sun.btrace.BTraceUtils; import com.sun.btrace.annotations.*; import java.util.Map; @BTrace public class TracingHashTable { /** * @author leopard on 2018年6月7日 * @param @Self object 调用对象 * @param id 参数 * @param @Return map 返回值 * @param @Duration time 响应时间 */ @OnMethod(clazz = "cn.leopard.sharding.resource.TestResource", method = "testUrl", location = @Location(Kind.RETURN)) public static void traceExecute(@Self Object object,String id,@Return Map<String, String> map , @Duration long time) { println("调用堆栈!!"); BTraceUtils.println("parameter object = "+ object ); BTraceUtils.println("parameter id = "+ id ); BTraceUtils.println("result map = "+ map ); BTraceUtils.println("cost time = "+ time ); jstack(); } }
先运行maven项目工程(自行建立测试项目,这里直接跳过)。
项目运行后,在终端执行
top
可参看到你启动项目的pid
btrace会在remote JVM(pid:54155)agent开启一个远程socketserver,默认端口是2020,正好我这台服务器有多个JVM实例,当我在第一个JVM上执行之后,第一个就会报错
btrace报错:Port 2020 unavailable
所以我改用端口 2021 运行监控测试类
请求方法后的输出信息。
四、扩展
监控项目代码code,参看文章:一个java内存泄漏的排查案例
以上为请求监控演示,下面给各位打下辅助扩展
参数说明
@OnMethod
Btrace使用@OnMethod注解定义需要分析的方法入口
在@OnMethod注解中,需要指定class、method以及location等,class表明需要监控的类,method表明需要监控的方法,指定方式如下:
1、使用全限定名:clazz="com.metty.rpc.common.BtraceCase", method="add"
2、使用正则表达式:clazz="/javax\.swing\..*/", method="/.*/"
3、使用接口:clazz="+com.ctrip.demo.Filter", method="doFilter"
4、使用注解:clazz="@javax.jws.WebService", method=""@javax.jws.WebMethod"
5、如果需要分析构造方法,需要指定method="<init>
@Location
定义Btrace对方法的拦截位置,通过@Location注解指定,默认为Kind.ENTRY
1、Kind.ENTRY:在进入方法时,调用Btrace脚本
2、Kind.RETURN:方法执行完时,调用Btrace脚本,只有把拦截位置定义为Kind.RETURN,才能获取方法的返回结果@Return和执行时间@Duration
3、Kind.CALL:分析方法中调用其它方法的执行情况,比如在execute方法中,想获取add方法的执行耗时,必须把where设置成Where.AFTER
4、Kind.LINE:通过设置line,可以监控代码是否执行到指定的位置
5、Kind.ERROR, Kind.THROW, Kind.CATCH :用于对某些异常情况的跟踪,包括异常抛出,异常被捕获,异常未捕获被抛出方法之外
@Dutation
返回的时间是纳秒级别,需要进行转换
@OnTimer
可以实现定时执行脚本中的一个方法
附参考转载出处: