java Btrace使用

背景

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

Btrace

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

项目地址：Btrace
用户指南：UserGuide

因为Btrace会把脚本逻辑直接侵入到运行的代码中，因此在使用上作不少限制：
一、不能建立对象
二、不能使用数组
三、不能抛出或捕获异常
四、不能使用循环
五、不能使用synchronized关键字
六、属性和方法必须使用static修饰

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

Btrace能够作什么？

一、接口性能变慢，分析每一个方法的耗时状况；
二、当在Map中插入大量数据，分析其扩容状况；
三、分析哪一个方法调用了System.gc()，调用栈如何；
四、执行某个方法抛出异常时，分析运行时参数；
五、....

Btrace第一个例子

package com.metty.rpc.common;
import java.util.Random;

/**
 * Created by j_zhan on 2016/11/28.
 */
public class BtraceCase {
    public static Random random = new Random();
    public int size;

    public static void main(String[] args) throws Exception {
        new BtraceCase().run();
    }
    
    public void run() throws Exception {
        while (true) {
            add(random.nextInt(10), random.nextInt(10));
        }
    }

    public int add(int a, int b) throws Exception {
        Thread.sleep(random.nextInt(10) * 100);
        return a + b;
    }
}

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

经过jps命令获取pid为8454
执行btrace 8454 Debug.java实现对运行代码的监控，输出结果以下：

能够发现，Btrace能够获取每次执行add方法时的数据，固然Btrace能作的远远不止这些，好比获取当前jvm堆使用状况、当前线程的执行栈等等。

参数说明

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

@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定位问题

一、找出全部耗时超过1ms的过滤器Filter

因为@Dutation返回的时间是纳秒级别，须要进行转换，若是定位一个Filter性能变慢，接着使用@Location(Kind.CALL)进行更细粒度的分析。

二、分析哪一个方法调用了System.gc()，调用栈如何？

经过查看调用栈，能够很清楚的发现哪一个类哪一个方法调用了System.gc()

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

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

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

经过反射机制，能够很方法的获得当前实例的属性值

总结

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