Arthas、BTrace线上问题诊断工具比较

生产环境中可能出现各种问题，可能是逻辑性错误，可能是环境相关，这时候需要获取程序运行时的数据信息，如方法参数、返回值来定位问题，通过传统的增加日志记录的方式非常繁琐，而且需要重启server，代价很大。arthas、BTrace可以动态地跟踪java运行程序，将跟踪字节码注入到运行类中，对运行代码侵入较小，对性能上的影响可以忽略不计

btrace简单介绍

btrace有诸多安全限制，需要增加jvm启动参数-Dcom.sun.btrace.unsafe=true，并且需要编写代码。arthas类似linux shell，直接敲命令解决所有问题，好用太多

1.下载地址

https://github.com/btraceio/btrace/releases/download/v1.3.11.3/btrace-bin-1.3.11.3.zip

2.启动命令

btrace [-p ] [-cp ]
样例：
./bin/btrace -cp mylib/fastjson-1.2.41.jar:mylib/spring-web-5.0.8.RELEASE.jar:. 18962 Btrace.java

3.获取方法参数、返回值例子

package com.test;

import com.alibaba.fastjson.JSONObject;
import com.sun.btrace.BTraceUtils;
import static com.sun.btrace.BTraceUtils.*;
import com.sun.btrace.annotations.*;
import org.springframework.web.client.RestTemplate;

/**
 * 监控myMethod方法入参、返回值 
 */
@BTrace
public class Btrace {
    @OnMethod(
            clazz = "com.test.MyClass",
            method = "myMethod",
            location = @Location(Kind.RETURN) //函数返回的时候执行
    )
    public static void myMethod(RestTemplate template, String param,  @Return JSONObject result) {
        println("param:" + param);
    }
}

arthas使用介绍

arthas线上问题诊断工具，可查看classloader信息，类加载情况，jstack，方法调用监控，线上性能分析等

1.下载安装arthas

下载地址：https://alibaba.github.io/arthas/arthas-boot.jar，windows上使用浏览器打开，linux支持wget下载保存到本地

2.启动arthas

执行java -jar arthas-boot.jar启动arthas，成功启动会打印java进程列表，输入相应序号进入arthas。
我们使用windows的powershell演示arthas启动如下：

PS D:\dev> java -jar .\arthas-boot.jar
[INFO] arthas-boot version: 3.1.0
[INFO] Process 20892 already using port 3658
[INFO] Process 20892 already using port 8563
[INFO] Found existing java process, please choose one and hit RETURN.
* [1]: 20892 demo.test.myweb.MywebApplication
  [2]: 11952 org.jetbrains.plugins.scala.nailgun.NailgunRunner

3.查看应用的classloader信息

该命令会显示classloader名、实例数、加载的类数量

$ classloader //打印classloader信息
 name                                                numberOfInstances  loadedCountTotal
 sun.misc.Launcher$AppClassLoader                    1                  4029
 BootstrapClassLoader                                1                  2947
 com.taobao.arthas.agent.ArthasClassloader           1                  1079
 sun.reflect.DelegatingClassLoader                   82                 82
 sun.misc.Launcher$ExtClassLoader                    1                  29
 javax.management.remote.rmi.NoCallStackClassLoader  2                  2
Affect(row-cnt:6) cost in 12 ms.
$ classloader -c 3444d69d -a //查看hash值为3444d69d的classloader加载的所有类

4.使用watch观察方法入参、返回值、异常信息

通过编写OGNL表达式进行对应变量的查看。假如有下面controller方法，入参User有name、pass两个属性
params[0]代表第一个参数
params[0].name代表第一个参数user的name属性值
returnObj代表返回值

@ResponseBody
@RequestMapping(value = "/login", method = RequestMethod.GET)
public String login(User user) {
    if ("tom".equals(user.getName())) {
        if ("123456".equals(user.getPass())) {
            return "success";
        }
    }
    return "failed";
}
$ watch demo.test.myweb.UserController login "{params[0].name,params[0].pass,returnObj}"
Press Q or Ctrl+C to abort.
Affect(class-cnt:1 , method-cnt:1) cost in 37 ms.
ts=2019-03-25 15:05:44; [cost=0.178959ms] result=@ArrayList[
    @String[tom],
    @String[123456],
    @String[success],
]
ts=2019-03-25 15:06:03; [cost=0.172545ms] result=@ArrayList[
    @String[tom],
    @String[aaaaaa],
    @String[failed],
]

5.monitor/watch/trace相关

请注意，这些命令，都通过字节码增强技术来实现的，会在指定类的方法中插入一些切面来实现数据统计和观测，因此在线上、预发使用时，请尽量明确需要观测的类、方法以及条件，诊断结束要执行 shutdown 或将增强过的类执行 reset 命令。
monitor——方法执行监控
watch——方法执行数据观测
trace——方法内部调用路径，并输出方法路径上的每个节点上耗时
stack——输出当前方法被调用的调用路径
tt——方法执行数据的时空隧道，记录下指定方法每次调用的入参和返回信息，并能对这些不同的时间下调用进行观测

6.基础命令

help——查看命令帮助信息
cat——打印文件内容，和linux里的cat命令类似
pwd——返回当前的工作目录，和linux命令类似
cls——清空当前屏幕区域
session——查看当前会话的信息
reset——重置增强类，将被 Arthas 增强过的类全部还原，Arthas 服务端关闭时会重置所有增强过的类
version——输出当前目标 Java 进程所加载的 Arthas 版本号
history——打印命令历史
quit——退出当前 Arthas 客户端，其他 Arthas 客户端不受影响
shutdown——关闭 Arthas 服务端，所有 Arthas 客户端全部退出
keymap——Arthas快捷键列表及自定义快捷键

7.jvm相关

dashboard——当前系统的实时数据面板
thread——查看当前 JVM 的线程堆栈信息
jvm——查看当前 JVM 的信息
sysprop——查看和修改JVM的系统属性
sysenv——查看JVM的环境变量
getstatic——查看类的静态属性
ognl——执行ognl表达式

8.class/classloader相关

sc——查看JVM已加载的类信息
sm——查看已加载类的方法信息
jad——反编译指定已加载类的源码
mc——内存编绎器，内存编绎.java文件为.class文件
redefine——加载外部的.class文件，redefine到JVM里
dump——dump 已加载类的 byte code 到特定目录
classloader——查看classloader的继承树，urls，类加载信息，使用classloader去getResource