在线调试工具BTrace使用介绍

2018-12-13 本文已影响23人公众号_WU双

1 基本概念

1.1 背景

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

1.2 定义

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

1.3 项目地址

https://github.com/btraceio/btrace

2 使用介绍

下载安装BTrace

1）到github发布界面下载最新发布包https://github.com/btraceio/btrace/releases

2）解压缩下载的发布包即可，解压缩后文件结构如下：

BTrace解压缩后文件结构

编写调试脚本

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

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

@BTrace
public 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);
      }
   }

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

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

 public class Main
{
  public static Random random = new Random();

  public static void main(String[] args) throws Exception {
    new Main().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;
  }
}

运行脚本

1）获取当前运行程序的pid；

2）在命令行运行btrace <PID> Debug.java

运行后当程序执行add()方法时，界面输出如下：

运行脚本界面输出

退出在线调试

1）在命令行界面按ctrl+c；

ctrl+c退出调试

2）输入1回车，选择退出

输入1，然后回车

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

3 常用注解说明

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

BTrace总共有两类注解，一种是在方法上面的注解，另一种是在方法参数里面的注解，不同注解有着不同的功能。

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

3.1 常用方法注解

方法注解用来标注脚本的方法。

1.@OnMethod

示例：

@BTrace
public 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);
      }
   }

说明：@OnMethod注解用来指定目标类、目标方法以及方法中具体位置的注解。

参数说明：

clazz：用来指定目标类，支持正则表达式；

method：用来指定待分析的方法名，支持正则表达式；

location：用来指定待分析方法的具体拦截位置信息，用@Location注解来指定，@Location注解常用值如下：

Kind.ENTRY：在进入方法时，调用Btrace脚本，此为默认值；

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

Kind.LINE：通过设置line，可以监控代码是否执行到指定的位置，示例：location=@Location(value=Kind.LINE, line = 20)；

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

2. @OnTimer

示例：

  @BTrace
  public class Memory {
  @OnTimer(4000)
   public static void printMem() {
      println("Heap:");
      println(Sys.Memory.heapUsage());
      println("Non-Heap:");
      println(Sys.Memory.nonHeapUsage());
  }
}

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

3. @OnLowMemory

示例：

 @BTrace 
 public class MemAlerter {
   @OnLowMemory(pool = "Tenured Gen",threshold=6000000)
   public static void onLowMem(MemoryUsage mu) {
      println(mu); 
   }
 }

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

3.2 常用方法参数注解

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

@ProbeClassName：用来标记脚本方法中的参数，能够获取当前拦截方法的类名；
@ProbeMethodName：用来标记脚本方法中的参数，能够获取当前拦截的方法名；
@Self：用来标记跟踪脚本方法中的参数，能够获取拦截方法运行时的实例，获取实例后通过反射机制可以获取对象的各类信息；
@Return：用来标记跟踪脚本方法中的参数，能够获取当前拦截的方法的返回值；
@Duration：用来标记跟踪脚本方法中的参数，能够获取当前拦截的方法的执行时间；

4 注意事项

BTrace脚本的所有输出都是输出到stdout；
为了保证程序的安全，BTrace对编写的脚本进行了一些限制，比如不允许在脚本中创建对象，不允许在脚本中抛出异常等，更详细的限制请参考BTrace使用限制；
如果我们一定要在脚本中进行创建对象等操作，我们可以关闭BTrace的安全限制，在btrace启动命令脚本中将com.sun.btrace.unsafe的值改为true，并且在脚本中使用@BTrace(unsafe = true)注解；
支持热插拔，无需重启应用，只需关闭BTrace会话，即可动态删除已添加的打印日志等信息；
使用过程中出现的其他未知异常可去github issue中去搜索；
在线调试因为BTrace会直接把脚本侵入到运行的代码中，所以一定要小心再小心，确保万无一失后在执行脚本。

5 参考资料

[1] 如何在生产环境使用Btrace进行调试.https://www.jianshu.com/p/dbb3a8b5c92f