「技术工具」阿里开源Java在线诊断工具 Arthas 进阶教程

Arthas 是Alibaba开源的Java诊断工具，深受开发者喜爱。

本教程会以一个普通的Spring Boot应用为例，演示Arthas命令的详细用法。

下载demo-arthas-spring-boot.jar，再用java -jar命令启动：

demo-arthas-spring-boot是一个很简单的spring boot应用，源代码：查看

启动之后，可以访问61000端口

在新的Terminal 2里，下载arthas-boot.jar，再用java -jar命令启动：

arthas-boot是Arthas的启动程序，它启动后，会列出所有的Java进程，用户可以选择需要诊断的目标进程。

选择第一个进程，输入 1 ，再Enter/回车：

Attach成功之后，会打印Arthas LOGO。输入 help 可以获取到更多的帮助信息。

下面介绍Arthas里查看JVM信息的命令。

sysprop

sysprop 可以打印所有的System Properties信息。

也可以指定单个key： sysprop java.version

也可以通过grep来过滤： sysprop | grep user

可以设置新的value： sysprop testKey testValue

sysenv

sysenv 命令可以获取到环境变量。和sysprop命令类似。

jvm

jvm 命令会打印出JVM的各种详细信息。

dashboard

dashboard 命令可以查看当前系统的实时数据面板。

输入 q 或者 Ctrl+C 可以退出dashboard命令。

Tips

为了更好使用Arthas，下面先介绍Arthas里的一些使用技巧。

help

Arthas里每一个命令都有详细的帮助信息。可以用-h来查看。帮助信息里有EXAMPLES和WIKI链接。

比如：

自动补全

Arthas支持丰富的自动补全功能，在使用有疑惑时，可以输入Tab来获取更多信息。

比如输入 sysprop java. 之后，再输入Tab，会补全出对应的key：

readline的快捷键支持

Arthas支持常见的命令行快捷键，比如Ctrl + A跳转行首，Ctrl + E跳转行尾。

更多的快捷键可以用 keymap 命令查看。

历史命令的补全

如果想再执行之前的命令，可以在输入一半时，按Up/↑ 或者 Ddown/↓，来匹配到之前的命令。

比如之前执行过sysprop java.version，那么在输入sysprop ja之后，可以输入Up/↑，就会自动补全为sysprop java.version。

如果想查看所有的历史命令，也可以通过 history 命令查看到。

pipeline

Arthas支持在pipeline之后，执行一些简单的命令，比如：

sysprop | grep java

sysprop | wc -l

下面介绍Arthas里查找已加载类的命令。

sc

sc 命令可以查找到所有JVM已经加载到的类。 如果搜索的是接口，还会搜索所有的实现类。比如查看所有的Filter实现类：

通过-d参数，可以打印出类加载的具体信息，很方便查找类加载问题。

sc支持通配，比如搜索所有的StringUtils：

sm

sm命令则是查找类的具体函数。比如：

通过-d参数可以打印函数的具体属性：

也可以查找特定的函数，比如查找构造函数：

可以通过 jad 命令来反编译代码：

通过--source-only参数可以只打印出在反编译的源代码：

在Arthas里，有一个单独的ognl命令，可以动态执行代码。

调用static函数

可以检查Terminal 1里的进程输出，可以发现打印出了hello ognl。

查找UserController的ClassLoader

注意hashcode是变化的，需要先查看当前的ClassLoader信息，提取对应ClassLoader的hashcode。

如果你使用-c，你需要手动输入hashcode：-c

对于只有唯一实例的ClassLoader可以通过--classLoaderClass指定class name，使用起来更加方便：

--classLoaderClass 的值是ClassLoader的类名，只有匹配到唯一的ClassLoader实例时才能工作，目的是方便输入通用命令，而-c 是动态变化的。

获取静态类的静态字段

获取UserController类里的logger字段：

还可以通过-x参数控制返回值的展开层数。比如：

执行多行表达式，赋值给临时变量，返回一个List

更多

在Arthas里ognl表达式是很重要的功能，在很多命令里都可以使用ognl表达式。

一些更复杂的用法，可以参考：

现象

目前，访问 http://localhost:61000/user/0 ，会返回500异常：

但请求的具体参数，异常栈是什么呢？

查看UserController的 参数/异常

在Arthas里执行：

可以看到实际抛出的异常是IllegalArgumentException。

可以输入 q 或者 Ctrl+C 退出watch命令。

如果想把获取到的结果展开，可以用-x参数：

返回值表达式

在上面的例子里，第三个参数是返回值表达式，它实际上是一个ognl表达式，它支持一些内置对象：

你可以利用这些内置对象来组成不同的表达式。比如返回一个数组：

更多参考： https://arthas.aliyun.com/doc/advice-class.html

条件表达式

watch命令支持在第4个参数里写条件表达式，比如：

当访问 user/1 时，watch命令没有输出

当访问 user/101 时，watch会打印出结果。

当异常时捕获

watch命令支持-e选项，表示只捕获抛出异常时的请求：

按照耗时进行过滤

watch命令支持按请求耗时进行过滤，比如：

下面介绍通过jad/mc/redefine 命令实现动态更新代码的功能。

目前，访问 http://localhost:61000/user/0 ，会返回500异常：

下面通过热更新代码，修改这个逻辑。

jad反编译UserController

jad反编译的结果保存在 /tmp/UserController.java文件里了。

再打开一个Terminal 3，然后用vim来编辑/tmp/UserController.java：

比如当 user id 小于1时，也正常返回，不抛出异常：

sc查找加载UserController的ClassLoader

可以发现是 spring boot [email protected] 加载的。

请记下你的classLoaderHash，后面需要使用它。在这里，它是 1be6f5c3。

mc

保存好/tmp/UserController.java之后，使用mc(Memory Compiler)命令来编译，并且通过-c或者--classLoaderClass参数指定ClassLoader：

也可以通过mc -c /tmp/UserController.java -d /tmp，使用-c参数指定ClassLoaderHash:

redefine

再使用redefine命令重新加载新编译好的UserController.class：

热修改代码结果

redefine成功之后，再次访问 user/0 ，结果是：

在这个案例里，动态修改应用的Logger Level。

查找UserController的ClassLoader

用ognl获取logger

可以知道[email protected]实际使用的是logback。可以看到level=null，则说明实际最终的level是从root logger里来的。

单独设置UserController的logger level

再次获取[email protected]，可以发现已经是DEBUG了：

修改logback的全局logger level

通过获取root logger，可以修改全局的logger level：

在这个案例里，展示排查logger冲突的方法。

确认应用使用的logger系统

以UserController为例，它使用的是slf4j api，但实际使用到的logger系统是logback。

获取logback实际加载的配置文件

使用classloader命令查找可能存在的logger配置文件

可以知道加载的配置的具体来源。

可以尝试加载容易冲突的文件：

在这个案例里，展示获取spring context，再获取bean，然后调用函数。

使用tt命令获取到spring context

tt即 TimeTunnel，它可以记录下指定方法每次调用的入参和返回信息，并能对这些不同的时间下调用进行观测。

访问：user/1

可以看到tt命令捕获到了一个请求：

使用tt命令从调用记录里获取到spring context

输入 q 或者 Ctrl + C 退出上面的 tt -t命令。

结果是：

在这个案例里，展示排查HTTP 401问题的技巧。

访问： admin

结果是：

我们知道401通常是被权限管理的Filter拦截了，那么到底是哪个Filter处理了这个请求，返回了401？

跟踪所有的Filter函数

开始trace：

访问： admin

可以在调用树的最深层，找到AdminFilterConfig$AdminFilter返回了401：

通过stack获取调用栈

上面是通过trace命令来获取信息，从结果里，我们可以知道通过stack跟踪HttpServletResponse:sendError()，同样可以知道是哪个Filter返回了401

执行：

访问： admin

在这个案例里，展示排查HTTP 404问题的技巧。

访问： a.txt

结果是：

那么到底是哪个Servlet处理了这个请求，返回了404？

跟踪所有的Servlet函数

开始trace：

访问： a.txt

在Terminal 3里，查看/tmp/servlet.txt的内容：

/tmp/servlet.txt里的内容会比较多，需要耐心找到调用树里最长的地方。

可以发现请求最终是被freemarker处理的：

下面介绍classloader命令的功能。

先访问一个jsp网页，触发jsp的加载： hello

列出所有ClassLoader

列出ClassLoader里加载的所有类

列出上面的org.apache.jasper.servlet.JasperLoader加载的类：

反编译jsp的代码

查看ClassLoader树

注意：请使用你的classLoaderHash值覆盖  ，然后手动执行下面相关命令：

列出ClassLoader的urls

比如上面查看到的spring LaunchedURLClassLoader的 hashcode是1be6f5c3，可以通过-c或者--classLoaderClass参数来列出它的所有urls：

加载指定ClassLoader里的资源文件

查找指定的资源文件： classloader --classLoaderClass org.springframework.boot.loader.LaunchedURLClassLoader -r logback-spring.xml

尝试加载指定的类

比如用上面的spring LaunchedURLClassLoader 尝试加载 java.lang.String ：

查看所有线程信息

查看具体线程的栈

查看线程ID 16的栈：

查看CPU使用率top n线程的栈

查看5秒内的CPU使用率top n线程栈

查找线程是否有阻塞

Arthas支持通过Web Socket来连接。

当在本地启动时，可以访问 http://127.0.0.1:8563/ ，通过浏览器来使用Arthas。

推荐通过“快速入门”来体验： https://arthas.aliyun.com/doc/quick-start.html

Arthas在 watch/trace 等命令时，实际上是修改了应用的字节码，插入增强的代码。显式执行 reset 命令，可以清除掉这些增强代码。

退出Arthas

用 exit 或者 quit 命令可以退出Arthas。

退出Arthas之后，还可以再次用 java -jar arthas-boot.jar 来连接。

exit/quit命令只是退出当前session，arthas server还在目标进程中运行。

想完全退出Arthas，可以执行 stop 命令。

arthas-boot.jar 支持很多参数，可以执行 java -jar arthas-boot.jar -h 来查看。

默认情况下， arthas server侦听的是 127.0.0.1 这个IP，如果希望远程可以访问，可以使用--target-ip的参数。

使用指定版本：

在“进阶教程”，演示了Arthas的大部分高级用法，希望对大家排查问题有帮助。