Arthas 用户文档
Arthas（阿尔萨斯） 能为你做什么？
Arthas 是Alibaba开源的Java诊断工具，深受开发者喜爱。
当你遇到以下类似问题而束手无策时，Arthas可以帮助你解决：
- 这个类从哪个 jar 包加载的？为什么会报各种类相关的 Exception？
- 我改的代码为什么没有执行到？难道是我没 commit？分支搞错了？
- 遇到问题无法在线上 debug，难道只能通过加日志再重新发布吗？
- 线上遇到某个用户的数据处理有问题，但线上同样无法 debug，线下无法重现！
- 是否有一个全局视角来查看系统的运行状况？
- 有什么办法可以监控到JVM的实时运行状态？
Arthas支持JDK 6+，支持Linux/Mac/Winodws，采用命令行交互模式，同时提供丰富的 Tab 自动补全功能，进一步方便进行问题的定位和诊断。
Contents
Arthas Install
快速安装
使用arthas-boot（推荐）
下载arthas-boot.jar，然后用java -jar的方式启动：
|
wget https://alibaba.github.io/arthas/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
-
如果从github下载有问题，可以使用gitee镜像
wget https://arthas.gitee.io/arthas-boot.jar
使用as.sh
Arthas 支持在 Linux/Unix/Mac 等平台上一键安装，请复制以下内容，并粘贴到命令行中，敲 回车 执行即可：
curl -L https://alibaba.github.io/arthas/install.sh | sh
上述命令会下载启动脚本文件 as.sh 到当前目录，你可以放在任何地方或将其加入到 $PATH 中。
直接在shell下面执行./as.sh，就会进入交互界面。
也可以执行./as.sh -h来获取更多参数信息。
-
如果从github下载有问题，可以使用gitee镜像
curl -L https://arthas.gitee.io/install.sh | sh
全量安装
最新版本，点击下载：
解压后，在文件夹里有arthas-boot.jar，直接用java -jar的方式启动：
java -jar arthas-boot.jar
打印帮助信息：
java -jar arthas-boot.jar -h
手动安装
离线帮助文档
最新版本，点击下载：
卸载
-
在 Linux/Unix/Mac 平台
删除下面文件：
rm -rf ~/.arthas/rm -rf ~/logs/arthas -
Windows平台直接删除user home下面的.arthas和logs/arthas目录
快速入门
1. 启动Demo
|
wget https://alibaba.github.io/arthas/arthas-demo.jar
|
|
|
java -jar arthas-demo.jar
|
arthas-demo是一个简单的程序，每隔一秒生成一个随机数，再执行质因式分解，并打印出分解结果。
arthas-demo源代码：查看
2. 启动arthas
在命令行下面执行（使用和目标进程一致的用户启动，否则可能attach失败）：
|
wget https://alibaba.github.io/arthas/arthas-boot.jar
|
|
|
java -jar arthas-boot.jar
|
- 执行该程序的用户需要和目标进程具有相同的权限。比如以admin用户来执行：sudo su admin && java -jar arthas-boot.jar 或 sudo -u admin -EH java -jar arthas-boot.jar。
- 如果attach不上目标进程，可以查看~/logs/arthas/ 目录下的日志。
- 如果下载速度比较慢，可以使用aliyun的镜像：java -jar arthas-boot.jar --repo-mirror aliyun --use-http
- java -jar arthas-boot.jar -h 打印更多参数信息。
选择应用java进程：
|
$ $ java -jar arthas-boot.jar
|
|
|
* [1]: 35542
|
|
|
[2]: 71560 arthas-demo.jar
|
Demo进程是第2个，则输入2，再输入回车/enter。Arthas会attach到目标进程上，并输出日志：
|
[INFO] Try to attach process 71560
|
|
|
[INFO] Attach process 71560 success.
|
|
|
[INFO] arthas-client connect 127.0.0.1 3658
|
|
|
,---. ,------. ,--------.,--. ,--. ,---. ,---.
|
|
|
/ O | .--. ''--. .--'| '--' | / O ' .-'
|
|
|
| .-. || '--'.' | | | .--. || .-. |`. `-.
|
|
|
| | | || | | | | | | || | | |.-' |
|
|
|
`--' `--'`--' '--' `--' `--' `--'`--' `--'`-----'
|
|
|
wiki: https://alibaba.github.io/arthas
|
|
|
version: 3.0.5.20181127201536
|
|
|
pid: 71560
|
|
|
time: 2018-11-28 19:16:24
|
|
|
$
|
3. 查看dashboard
输入dashboard，按enter/回车，会展示当前进程的信息，按ctrl+c可以中断执行。
|
$ dashboard
|
|
|
ID NAME GROUP PRIORI STATE %CPU TIME INTERRU DAEMON
|
|
|
17 pool-2-thread-1 system 5 WAITIN 67 0:0 false false
|
|
|
27 Timer-for-arthas-dashb system 10 RUNNAB 32 0:0 false true
|
|
|
11 AsyncAppender-Worker-a system 9 WAITIN 0 0:0 false true
|
|
|
9 Attach Listener system 9 RUNNAB 0 0:0 false true
|
|
|
3 Finalizer system 8 WAITIN 0 0:0 false true
|
|
|
2 Reference Handler system 10 WAITIN 0 0:0 false true
|
|
|
4 Signal Dispatcher system 9 RUNNAB 0 0:0 false true
|
|
|
26 as-command-execute-dae system 10 TIMED_ 0 0:0 false true
|
|
|
13 job-timeout system 9 TIMED_ 0 0:0 false true
|
|
|
1 main main 5 TIMED_ 0 0:0 false false
|
|
|
14 nioEventLoopGroup-2-1 system 10 RUNNAB 0 0:0 false false
|
|
|
18 nioEventLoopGroup-2-2 system 10 RUNNAB 0 0:0 false false
|
|
|
23 nioEventLoopGroup-2-3 system 10 RUNNAB 0 0:0 false false
|
|
|
15 nioEventLoopGroup-3-1 system 10 RUNNAB 0 0:0 false false
|
|
|
Memory used total max usage GC
|
|
|
heap 32M 155M 1820M 1.77% gc.ps_scavenge.count 4
|
|
|
ps_eden_space 14M 65M 672M 2.21% gc.ps_scavenge.time(m 166
|
|
|
ps_survivor_space 4M 5M 5M s)
|
|
|
ps_old_gen 12M 85M 1365M 0.91% gc.ps_marksweep.count 0
|
|
|
nonheap 20M 23M -1 gc.ps_marksweep.time( 0
|
|
|
code_cache 3M 5M 240M 1.32% ms)
|
|
|
Runtime
|
|
|
os.name Mac OS X
|
|
|
os.version 10.13.4
|
|
|
java.version 1.8.0_162
|
|
|
java.home /Library/Java/JavaVir
|
|
|
tualMachines/jdk1.8.0
|
|
|
_162.jdk/Contents/Hom
|
|
|
e/jre
|
4. 通过thread命令来获取到arthas-demo进程的Main Class
thread 1会打印线程ID 1的栈，通常是main函数的线程。
|
$ thread 1 | grep 'main('
|
|
|
at demo.MathGame.main(MathGame.java:17)
|
5. 通过jad来反编绎Main Class
|
$ jad demo.MathGame
|
|
|
ClassLoader:
|
|
|
+-sun.misc.Launcher$AppClassLoader@3d4eac69
|
|
|
+-sun.misc.Launcher$ExtClassLoader@66350f69
|
|
|
Location:
|
|
|
/tmp/arthas-demo.jar
|
|
|
/*
|
|
|
* Decompiled with CFR 0_132.
|
|
|
*/
|
|
|
package demo;
|
|
|
import java.io.PrintStream;
|
|
|
import java.util.ArrayList;
|
|
|
import java.util.Iterator;
|
|
|
import java.util.List;
|
|
|
import java.util.Random;
|
|
|
import java.util.concurrent.TimeUnit;
|
|
|
public class MathGame {
|
|
|
private static Random random = new Random();
|
|
|
private int illegalArgumentCount = 0;
|
|
|
public static void main(String[] args) throws InterruptedException {
|
|
|
MathGame game = new MathGame();
|
|
|
do {
|
|
|
game.run();
|
|
|
TimeUnit.SECONDS.sleep(1L);
|
|
|
} while (true);
|
|
|
}
|
|
|
public void run() throws InterruptedException {
|
|
|
try {
|
|
|
int number = random.nextInt();
|
|
|
List<Integer> primeFactors = this.primeFactors(number);
|
|
|
MathGame.print(number, primeFactors);
|
|
|
}
|
|
|
catch (Exception e) {
|
|
|
System.out.println(String.format("illegalArgumentCount:%3d, ", this.illegalArgumentCount) + e.getMessage());
|
|
|
}
|
|
|
}
|
|
|
public static void print(int number, List<Integer> primeFactors) {
|
|
|
StringBuffer sb = new StringBuffer("" + number + "=");
|
|
|
Iterator<Integer> iterator = primeFactors.iterator();
|
|
|
while (iterator.hasNext()) {
|
|
|
int factor = iterator.next();
|
|
|
sb.append(factor).append('*');
|
|
|
}
|
|
|
if (sb.charAt(sb.length() - 1) == '*') {
|
|
|
sb.deleteCharAt(sb.length() - 1);
|
|
|
}
|
|
|
System.out.println(sb);
|
|
|
}
|
|
|
public List<Integer> primeFactors(int number) {
|
|
|
if (number < 2) {
|
|
|
++this.illegalArgumentCount;
|
|
|
throw new IllegalArgumentException("number is: " + number + ", need >= 2");
|
|
|
}
|
|
|
ArrayList<Integer> result = new ArrayList<Integer>();
|
|
|
int i = 2;
|
|
|
while (i <= number) {
|
|
|
if (number % i == 0) {
|
|
|
result.add(i);
|
|
|
number /= i;
|
|
|
i = 2;
|
|
|
continue;
|
|
|
}
|
|
|
++i;
|
|
|
}
|
|
|
return result;
|
|
|
}
|
|
|
}
|
|
|
Affect(row-cnt:1) cost in 970 ms.
|
6. watch
通过watch命令来查看demo.MathGame#primeFactors函数的返回值：
|
$ watch demo.MathGame primeFactors returnObj
|
|
|
Press Ctrl+C to abort.
|
|
|
Affect(class-cnt:1 , method-cnt:1) cost in 107 ms.
|
|
|
ts=2018-11-28 19:22:30; [cost=1.715367ms] result=null
|
|
|
ts=2018-11-28 19:22:31; [cost=0.185203ms] result=null
|
|
|
ts=2018-11-28 19:22:32; [cost=19.012416ms] result=@ArrayList[
|
|
|
@Integer[5],
|
|
|
@Integer[47],
|
|
|
@Integer[2675531],
|
|
|
]
|
|
|
ts=2018-11-28 19:22:33; [cost=0.311395ms] result=@ArrayList[
|
|
|
@Integer[2],
|
|
|
@Integer[5],
|
|
|
@Integer[317],
|
|
|
@Integer[503],
|
|
|
@Integer[887],
|
|
|
]
|
|
|
ts=2018-11-28 19:22:34; [cost=10.136007ms] result=@ArrayList[
|
|
|
@Integer[2],
|
|
|
@Integer[2],
|
|
|
@Integer[3],
|
|
|
@Integer[3],
|
|
|
@Integer[31],
|
|
|
@Integer[717593],
|
|
|
]
|
|
|
ts=2018-11-28 19:22:35; [cost=29.969732ms] result=@ArrayList[
|
|
|
@Integer[5],
|
|
|
@Integer[29],
|
|
|
@Integer[7651739],
|
|
|
]
|
更多的功能可以查看进阶使用。
5. 退出arthas
如果只是退出当前的连接，可以用quit或者exit命令。Attach到目标进程上的arthas还会继续运行，端口会保持开放，下次连接时可以直接连接上。
如果想完全退出arthas，可以执行shutdown命令。
进阶使用
基础命令
jvm相关
class/classloader相关
monitor/watch/trace相关
请注意，这些命令，都通过字节码增强技术来实现的，会在指定类的方法中插入一些切面来实现数据统计和观测，因此在线上、预发使用时，请尽量明确需要观测的类、方法以及条件，诊断结束要执行 shutdown 或将增强过的类执行 reset 命令。
options
- options——查看或设置Arthas全局开关
管道
Arthas支持使用管道对上述命令的结果进行进一步的处理，如sm java.lang.String * | grep 'index'
- grep——搜索满足条件的结果
- plaintext——将命令的结果去除ANSI颜色
- wc——按行统计输出结果
后台异步任务
当线上出现偶发的问题，比如需要watch某个条件，而这个条件一天可能才会出现一次时，异步后台任务就派上用场了，详情请参考这里
- 使用 > 将结果重写向到日志文件，使用 & 指定命令是后台运行，session断开不影响任务执行（生命周期默认为1天）
- jobs——列出所有job
- kill——强制终止任务
- fg——将暂停的任务拉到前台执行
- bg——将暂停的任务放到后台执行
其他特性
命令列表
Arthas 基础命令
- help——查看命令帮助信息
- cls——清空当前屏幕区域
- session——查看当前会话的信息
- reset——重置增强类，将被 Arthas 增强过的类全部还原，Arthas 服务端关闭时会重置所有增强过的类
- version——输出当前目标 Java 进程所加载的 Arthas 版本号
- history——打印命令历史
- quit——退出当前 Arthas 客户端，其他 Arthas 客户端不受影响
- shutdown——关闭 Arthas 服务端，所有 Arthas 客户端全部退出
- keymap——Arthas快捷键列表及自定义快捷键
Docker
通过Docker快速入门
-
删除本地已有的arthas-demo docker container（非必要）
$ docker stop arthas-demo || true && docker rm arthas-demo || true -
启动arthas-demo
$ docker run --name arthas-demo -it hengyunabc/arthas:latest /bin/sh -c "java -jar /opt/arthas/arthas-demo.jar" -
启动arthas-boot来进行诊断
$ docker exec -it arthas-demo /bin/sh -c "java -jar /opt/arthas/arthas-boot.jar"* [1]: 9 jar[INFO] arthas home: /opt/arthas[INFO] Try to attach process 9[INFO] Attach process 9 success.[INFO] arthas-client connect 127.0.0.1 3658,---. ,------. ,--------.,--. ,--. ,---. ,---./ O | .--. ''--. .--'| '--' | / O ' .-'| .-. || '--'.' | | | .--. || .-. |`. `-.| | | || | | | | | | || | | |.-' |`--' `--'`--' '--' `--' `--' `--'`--' `--'`-----'wiki: https://alibaba.github.io/arthasversion: 3.0.5pid: 9time: 2018-12-18 11:30:36
诊断Docker里的Java进程
docker exec -it ${containerId} /bin/bash -c "wget https://alibaba.github.io/arthas/arthas-boot.jar && java -jar arthas-boot.jar"
诊断k8s里容器里的Java进程
kubectl exec -it ${pod} --container ${containerId} -- /bin/bash -c "wget https://alibaba.github.io/arthas/arthas-boot.jar && java -jar arthas-boot.jar"
把Arthas安装到基础镜像里
可以很简单把Arthas安装到你的Docker镜像里。
FROM openjdk:8-jdk-alpine
# copy arthas
COPY --from=hengyunabc/arthas:latest /opt/arthas /opt/arthas