Btrace简介

2) 解压缩下载的发布包即可,解压缩后文件结构如下:

【转自】

类com.ssll.Main的add()方法代码如下:

背景

记得前几天有人问我:在生产环境中可能经常遇到各种问题,你们一般是如何进行调试的?
很惭愧,没有经验。因为平时碰不到生产环境的服务器,定位问题需要各种数据,所以大多数问题的解决方式都是在本地打断点进行调试,或者在测试环境利用输出日志进行调试,这种方式简单粗暴,但过程比较繁琐,需要各种重新发布,重启应用,还不能保证一次就找到问题的根源。直到最近才了解到Btrace这个工具,对于这样一个神器,我觉得有必要记录一篇,让更多的人知道。

  1. 运行脚本

Btrace

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

项目地址:Btrace

用户指南:UserGuide

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

1、不能创建对象

2、不能使用数组

3、不能抛出或捕获异常

4、不能使用循环

5、不能使用synchronized关键字

6、属性和方法必须使用static修饰

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

Btrace可以做什么?

1、接口性能变慢,分析每个方法的耗时情况;

2、当在Map中插入大量数据,分析其扩容情况;

3、分析哪个方法调用了System.gc(),调用栈如何;

4、执行某个方法抛出异常时,分析运行时参数;

5、....

Btrace第一个例子

图片 1

执行add方法时,对传入参数、返回值以及执行耗时进行分析,btrace脚本:

通过jps命令获取pid为8454

执行btrace 8454 Debug.java实现对运行代码的监控,输出结果如下:

图片 2

可以发现,Btrace可以获取每次执行add方法时的数据,当然Btrace能做的远远不止这些,比如获取当前jvm堆使用情况、当前线程的执行栈等等。

参数说明

@OnMethod

Btrace使用@OnMethod注解定义需要分析的方法入口

图片 3

在@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=""

@Location

定义Btrace对方法的拦截位置,通过@Location注解指定,默认为Kind.ENTRY

1、Kind.ENTRY:在进入方法时,调用Btrace脚本

2、Kind.RETURN:方法执行完时,调用Btrace脚本,只有把拦截位置定义为Kind.RETURN,才能获取方法的返回结果@Return和执行时间@Duration

图片 4

3、Kind.CALL:分析方法中调用其它方法的执行情况,比如在execute方法中,想获取add方法的执行耗时,必须把where设置成Where.AFTER

图片 5

4、Kind.LINE:通过设置line,可以监控代码是否执行到指定的位置

图片 6

5、Kind.ERROR, Kind.THROW, Kind.CATCH

用于对某些异常情况的跟踪,包括异常抛出,异常被捕获,异常未捕获被抛出方法之外

如何使用Btrace定位问题

1、找出所有耗时超过1ms的过滤器Filter

图片 7

由于@Dutation返回的时间是纳秒级别,需要进行转换,如果定位一个Filter性能变慢,接着使用@Location(Kind.CALL)进行更细粒度的分析。

2、分析哪个方法调用了System.gc(),调用栈如何?

图片 8

通过查看调用栈,可以很清楚的发现哪个类哪个方法调用了System.gc()

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

图片 9

Btrace的@OnTimer注解可以实现定时执行脚本中的一个方法

4、方法执行时,查看对象的实例属性值

图片 10

通过反射机制,可以很方法的得到当前实例的属性值

总结

Btrace能做的事情太多,但使用之前切记检查脚本的可行性,一旦Btrace脚本侵入到系统中,只有通过重启才能恢复。

Kind.ERROR, Kind.THROW,Kind.CATCH:用于某些异常情况的跟踪。

  1. 退出在线调试

说明:可以在内存超过指定阈值的时候进行相关操作。

上述脚本的功能为拦截类com.ssll.Main的add()方法,并获取打印当前拦截方法的类名、方法名、方法参数、方法返回值以及方法执行耗时。

图片 11BTrace解压缩后文件结构

当程序遇到问题时,我们一般怎么去定位?常见的解决方式都是在本地打断点进行调试,或者在测试环境利用输出日志进行调试,这种方式简单直接,但过程比较繁琐,需要重新编译类文件,替换class文件,重新发布,重启应用,还不能保证一次就找到问题的根源。所以我们就需要在线调试程序的工具。BTrace就是这样一款支持在线调试的工具。

Kind.RETURN:方法执行完时,调用Btrace脚本,只有把拦截位置定义为Kind.RETURN,才能获取方法的返回结果@Return和执行时间@Duration;

示例:

说明:可以通过@OnTimer注解实现定时执行脚本,定时单位为毫秒。上述脚本每过4秒钟打印应用程序相关内存信息。

本章只列举常用的注解说明,更全面的注解说明请参考BTrace全面注解说明。

2. @OnTimer

  1. BTrace脚本的所有输出都是输出到stdout;

  2. 为了保证程序的安全,BTrace对编写的脚本进行了一些限制,比如不允许在脚本中创建对象,不允许在脚本中抛出异常等,更详细的限制请参考BTrace使用限制;

  3. 如果我们一定要在脚本中进行创建对象等操作,我们可以关闭BTrace的安全限制,在btrace启动命令脚本中将com.sun.btrace.unsafe的值改为true,并且在脚本中使用@BTrace(unsafe = true)注解;

  4. 支持热插拔,无需重启应用,只需关闭BTrace会话,即可动态删除已添加的打印日志等信息;

  5. 使用过程中出现的其他未知异常可去github issue中去搜索;

  6. 在线调试因为BTrace会直接把脚本侵入到运行的代码中,所以一定要小心再小心,确保万无一失后在执行脚本。

import com.sun.btrace.BTraceUtils;import com.sun.btrace.annotations.*;@BTracepublic final class Debug { @OnMethod(clazz="com.ssll.Main",method="add",location=@Location(Kind.RETURN)) public static void test(@ProbeClassName String className,@ProbeMethodName String methodName, int a, int b, @Return int result, @Duration long time) throws Exception { BTraceUtils.println("className = " + className + ", methodName = " + methodName); BTraceUtils.println("parameter : a= " + a + ", b = " + b); BTraceUtils.println("cost time: " + time); } }

一个简单的调试脚本Debug.java如下:

方法参数注解为标记脚本中方法中的参数的。

method:用来指定待分析的方法名,支持正则表达式;

通过使用介绍知道整个调试主要步骤在于BTrace脚本的编写,BTrace脚本实现的功能主要依赖注解,我们来看下BTrace的主要注解。

1)
到github发布界面下载最新发布包

示例:

clazz:用来指定目标类,支持正则表达式;

3) 输入Y后回车终止批处理操作

@BTracepublic final class Debug {@OnMethod(clazz="com.ssll.Main",method="add",location=@Location(Kind.RETURN)) public static void test(@ProbeClassName String className,@ProbeMethodName String methodName, int a, int b, @Return int result, @Duration long time) throws Exception { BTraceUtils.println("className = " + className + ", methodName = " + methodName); BTraceUtils.println("parameter : a= " + a + ", b = " + b); BTraceUtils.println("cost time: " + time); } }

1.@OnMethod

2) 输入1回车,选择退出

相关文章

Comment ()
评论是一种美德,说点什么吧,否则我会恨你的。。。