Arthas 教程

Java 诊断利器 Arthas，是阿里的一款开源工具。Github-alibaba/arthas 上可以看到它的介绍。主要是最近对分析 Java 错误堆栈比较感兴趣，就了解了一下

Arthas（阿尔萨斯） 能为你做什么？

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

当你遇到以下类似问题而束手无策时，Arthas可以帮助你解决：

1. 这个类从哪个 jar 包加载的？为什么会报各种类相关的 Exception？

2. 我改的代码为什么没有执行到？难道是我没 commit？分支搞错了？

3. 遇到问题无法在线上 debug，难道只能通过加日志再重新发布吗？

4. 线上遇到某个用户的数据处理有问题，但线上同样无法 debug，线下无法重现！

5. 是否有一个全局视角来查看系统的运行状况？

6. 有什么办法可以监控到JVM的实时运行状态？

7. 怎么快速定位应用的热点，生成火焰图？

8. 怎样直接从JVM内查找某个类的实例？

Arthas支持JDK 6+，支持Linux/Mac/Windows，采用命令行交互模式，同时提供丰富的 Tab 自动补全功能，进一步方便进行问题的定位和诊断。

Arthas Install

快速安装

使用arthas-boot（推荐）

下载arthas-boot.jar，然后用java -jar的方式启动：

curl -O https://arthas.aliyun.com/arthas-boot.jar
java -jar arthas-boot.jar

打印帮助信息：

java -jar arthas-boot.jar -h

如果下载速度比较慢，可以使用aliyun的镜像：

java -jar arthas-boot.jar --repo-mirror aliyun --use-http

使用as.sh

Arthas 支持在 Linux/Unix/Mac 等平台上一键安装，请复制以下内容，并粘贴到命令行中，敲 回车 执行即可：

curl -L https://arthas.aliyun.com/install.sh | sh

上述命令会下载启动脚本文件 as.sh 到当前目录，你可以放在任何地方或将其加入到 $PATH 中。

直接在shell下面执行./as.sh，就会进入交互界面。

也可以执行./as.sh -h来获取更多参数信息。

全量安装

最新版本，点击下载：

解压后，在文件夹里有arthas-boot.jar，直接用java -jar的方式启动：

java -jar arthas-boot.jar

打印帮助信息：

java -jar arthas-boot.jar -h

手动安装

手动安装

通过rpm/deb来安装

在releases页面下载rpm/deb包： https://github.com/alibaba/arthas/releases

安装deb

sudo dpkg -i arthas*.deb

安装rpm

sudo rpm -i arthas*.rpm

deb/rpm安装的用法

在安装后，可以直接执行：

as.sh

通过Cloud Toolkit插件使用Arthas

• 通过Cloud Toolkit插件使用Arthas一键诊断远程服务器

离线帮助文档

最新版本离线文档下载：

卸载

• 在 Linux/Unix/Mac 平台

  删除下面文件：

rm -rf ~/.arthas/
rm -rf ~/logs/arthas

• Windows平台直接删除user home下面的.arthas和logs/arthas目录

基础命令

• help——查看命令帮助信息

• cat——打印文件内容，和linux里的cat命令类似

• echo–打印参数，和linux里的echo命令类似

• grep——匹配查找，和linux里的grep命令类似

• base64——base64编码转换，和linux里的base64命令类似

• tee——复制标准输入到标准输出和指定的文件，和linux里的tee命令类似

• pwd——返回当前的工作目录，和linux命令类似

• cls——清空当前屏幕区域

• session——查看当前会话的信息

• reset——重置增强类，将被 Arthas 增强过的类全部还原，Arthas 服务端关闭时会重置所有增强过的类

• version——输出当前目标 Java 进程所加载的 Arthas 版本号

• history——打印命令历史

• quit——退出当前 Arthas 客户端，其他 Arthas 客户端不受影响

• stop——关闭 Arthas 服务端，所有 Arthas 客户端全部退出

• keymap——Arthas快捷键列表及自定义快捷键

jvm相关

• dashboard——当前系统的实时数据面板

• thread——查看当前 JVM 的线程堆栈信息

• jvm——查看当前 JVM 的信息

• sysprop——查看和修改JVM的系统属性

• sysenv——查看JVM的环境变量

• vmoption——查看和修改JVM里诊断相关的option

• perfcounter——查看当前 JVM 的Perf Counter信息

• logger——查看和修改logger

• getstatic——查看类的静态属性

• ognl——执行ognl表达式

• mbean——查看 Mbean 的信息

• heapdump——dump java heap, 类似jmap命令的heap dump功能

• vmtool——从jvm里查询对象，执行forceGc

class/classloader相关

• sc——查看JVM已加载的类信息

• sm——查看已加载类的方法信息

• jad——反编译指定已加载类的源码

• mc——内存编译器，内存编译.java文件为.class文件

• retransform——加载外部的.class文件，retransform到JVM里

• redefine——加载外部的.class文件，redefine到JVM里

• dump——dump 已加载类的 byte code 到特定目录

• classloader——查看classloader的继承树，urls，类加载信息，使用classloader去getResource

monitor/watch/trace相关

请注意，这些命令，都通过字节码增强技术来实现的，会在指定类的方法中插入一些切面来实现数据统计和观测，因此在线上、预发使用时，请尽量明确需要观测的类、方法以及条件，诊断结束要执行 stop 或将增强过的类执行 reset 命令。

• monitor——方法执行监控

• watch——方法执行数据观测

• trace——方法内部调用路径，并输出方法路径上的每个节点上耗时

• stack——输出当前方法被调用的调用路径

• tt——方法执行数据的时空隧道，记录下指定方法每次调用的入参和返回信息，并能对这些不同的时间下调用进行观测

profiler/火焰图

• profiler–使用async-profiler对应用采样，生成火焰图

鉴权

• auth–鉴权

options

• options——查看或设置Arthas全局开关

管道

Arthas支持使用管道对上述命令的结果进行进一步的处理，如sm java.lang.String * | grep 'index'

• grep——搜索满足条件的结果

• plaintext——将命令的结果去除ANSI颜色

• wc——按行统计输出结果

后台异步任务

当线上出现偶发的问题，比如需要watch某个条件，而这个条件一天可能才会出现一次时，异步后台任务就派上用场了，详情请参考这里

• 使用 > 将结果重写向到日志文件，使用 & 指定命令是后台运行，session断开不影响任务执行（生命周期默认为1天）

• jobs——列出所有job

• kill——强制终止任务

• fg——将暂停的任务拉到前台执行

• bg——将暂停的任务放到后台执行

Web Console

通过websocket连接Arthas。

• Web Console

Arthas Properties

• Arthas Properties

以java agent方式启动

• 以java agent方式启动

as.sh 和 arthas-boot 技巧

• 通过select功能选择attach的进程。

正常情况下，每次执行as.sh/arthas-boot.jar需要选择，或者指定PID。这样会比较麻烦，因为每次启动应用，它的PID会变化。

比如，已经启动了math-game.jar，使用jps命令查看：

$ jps
58883 math-game.jar
58884 Jps

通过select参数可以指定进程名字，非常方便

$ ./as.sh --select math-game
Arthas script version: 3.3.6
[INFO] JAVA_HOME: /tmp/java/8.0.222-zulu
Arthas home: /Users/admin/.arthas/lib/3.3.6/arthas
Calculating attach execution time...
Attaching to 59161 using version /Users/admin/.arthas/lib/3.3.6/arthas...
 
real    0m0.572s
user    0m0.281s
sys    0m0.039s
Attach success.
telnet connecting to arthas server... current timestamp is 1594280799
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
  ,---.  ,------. ,--------.,--.  ,--.  ,---.   ,---.
 /  O  \ |  .--. ''--.  .--'|  '--'  | /  O  \ '   .-'
|  .-.  ||  '--'.'   |  |   |  .--.  ||  .-.  |`.  `-.
|  | |  ||  |\  \    |  |   |  |  |  ||  | |  |.-'    |
`--' `--'`--' '--'   `--'   `--'  `--'`--' `--'`-----'
 
wiki      https://arthas.aliyun.com/doc
tutorials https://arthas.aliyun.com/doc/arthas-tutorials.html
version   3.3.6
pid       58883

用户数据回报

在3.1.4版本后，增加了用户数据回报功能，方便统一做安全或者历史数据统计。

在启动时，指定stat-url，就会回报执行的每一行命令，比如： ./as.sh --stat-url 'http://192.168.10.11:8080/api/stat'

在tunnel server里有一个示例的回报代码，用户可以自己在服务器上实现。

StatController.java

其他特性

• 异步命令支持
• 执行结果存日志
• 批处理的支持
• ognl表达式的用法说明

更多细节内容参见Arthas官网：

https://arthas.aliyun.com/doc/