Arthas下载安装及使用介绍

• 官网网址： https://arthas.gitee.io/
• 官方文档：https://arthas.gitee.io/doc/quick-start.html
• GitHub： https://github.com/alibaba/arthas

一、简介

1.1 什么是 Arthas？

Arthas 是一款由 阿里巴巴 开发的 线上监控诊断工具。通过全局视角实时查看应用负载、内存、gc、线程的状态信息，能在不修改应用代码的情况下，对业务问题进行诊断，包括查看方法调用的出入参、异常，检测方法执行耗时，类加载信息等，大大提升线上问题排查效率。

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

1.2 Arthas 可以做些什么？

Arthas 可以帮你解决以下常见问题：

1. 这个类从哪个 jar 包加载的？为什么会报各种类相关的 Exception？
2. 我改的代码为什么没有执行到？难道是我没 commit？分支搞错了？
3. 遇到问题无法在线上 debug，难道只能通过加日志再重新发布吗？
4. 是否一个全局视角来查看系统的运行状况？
5. 有什么办法可以监控到 JVM 的实时运行状态？
6. 怎么快速定位应用的热点，生成火焰图？
7. 怎样直接从 JVM 内查找某个类的实例？

---

二、下载安装、卸载

2.1 安装方式一：在线安装

执行如下命令：

（需要使用和目标进程一致的用户启动，否则可能 attack 失败）

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

选择 java 进程：

$ $ java -jar arthas-boot.jar
* [1]: 35542
  [2]: 71560 demo.jar

我们的示例 java 进程是第 2 个，则输入 2，再输入回车。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://arthas.aliyun.com/doc
version: 3.0.5.20181127201536
pid: 71560
time: 2018-11-28 19:16:24

$

如果是第一次启动，会自动下载 Arthas 的相关文件：

我们可以看到，在 Windows 中默认安装目录为：

# 文件位置
C:\Users\Administrator\.arthas\lib\3.7.2\arthas\
# 日志位置
C:\Users\Administrator\logs\arthas\

在 Linux 中安装也是一模一样的，只不过默认安装路径为：

# 文件位置
~/.arthas/
# 日志位置
~/logs/arthas/

2.2 安装方式二：离线安装

比如要下载 3.7.2 版本，下载的 url 是：

• 下载地址： https://maven.aliyun.com/repository/public/com/taobao/arthas/arthas-packaging/3.7.2/arthas-packaging-3.7.2-bin.zip

下载后文件如下所示：

压缩包内容如下所示：

如果是 Windows 平台，解压后，直接使用如下命令启动即可：

java -jar arthas-boot.jar

如果是 Linux 平台，可以使用以下命令解压到指定的 arthas 目录：

unzip -d arthas arthas-packaging-3.7.2-bin.zip

执行结果如下所示：

2.3 卸载

在 Windows 平台，卸载只需要直接删除以下两个目录即可：

• 文件目录：C:\Users\Administrator\.arthas\lib\3.7.2\arthas\
• 日志目录：C:\Users\Administrator\logs\arthas\

在 Linux 平台，卸载只需要执行如下命令删除文件即可：

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

---

三、常见操作

3.1 dashbord 信息面板

输入 dashboard，回车即可看到信息面板：

Ctrl + C 即可中断刷新，并推出 dashboard。

3.2 thread 线程信息

输入 thread 命令，即可看到当前 Java 进程的所有线程信息：

使用 thread 线程ID 命令，即可查看线程的调用栈信息：

3.3 jad 反编译 class 类、方法

使用 jad 包名.类名 [方法名] 命令，即可对指定类文件进行反编译，如果不传方法就是反编译整个类信息：

小知识： 在类名上右键 -> Copy/Paste Special -> Copy Reference，即可同时拷贝包名+类名。

3.4 watch 监控方法的入参、出参

1）监控入参

比如，我们想监控 DemoController 类的 test() 方法的入参，可以使用如下命令：

# 查看入参（默认只查看一层JSON）
watch com.demo.controller.DemoController test params
# 如果入参（查看2层JSON）
watch com.demo.controller.DemoController test params -x 2
# 同时查看入参和出参
watch com.demo.controller.DemoController test "{params,returnObj}"

请求地址：http://localhost:8080/demo/test?key=123

执行结果如下：

可以看到，入参是一个值为 123 的 String 类型对象。使用 Q 或者 Ctrl + C 就可以退出。

2）监控出参

比如，我们想监控 DemoController 类的 test() 方法的出参，可以使用如下命令：

# 查看出参（默认只查看一层JSON）
watch com.demo.controller.DemoController test returnObj
# 查看出参（查看2层JSON）
watch com.demo.controller.DemoController test returnObj -x 2
# 同时查看入参和出参
watch com.demo.controller.DemoController test "{params,returnObj}"

请求地址：http://localhost:8080/demo/test?key=123

执行结果如下：

可以看到，这里返回了一个 Result 对象，里面的数据也具体打印出来了。

3.5 trace 查看方法耗时，定位接口慢问题

trace 命令，用于监控某个方法的调用链路，渲染和统计整个调用链路上的所有性能开销和耗时。

举个例子，如果我们想查看 com.demo.controller.DemoController 类的 test() 方法中的调用链路和耗时，可以使用如下命令：

trace com.demo.controller.DemoControler test

3.6 stack 查看方法的调用栈

stack 命令，用于确认某个方法在哪些地方被调用，打印调用栈信息。

举个例子，如果我们想确认 Result 类的 succeed() 方法在哪些地方被调用了，可以使用如下命令：

stack com.demo.common.Result succeed

3.7 sc 查看 JVM 已加载的类信息

sc 命令，是 “Search-Class” 的缩写，这个命令能搜索出所有已加载到 JVM 中的 Class 信息，支持通配符。

举个例子，如果要对 com.demo 包下的类进行模糊搜索，可以使用如下命令：

sc com.demo.*

可以打印类的详细信息，可以使用如下命令：

sc -d 包名.类名

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

sm 命令，是 “Search-Method” 的缩写，这个命令能搜索出所有已经加载了 Class 信息的方法信息。

注意： sm 命令只能看到由当前类所声明（declaring）的方法，无法看到父类方法。

举个例子，查看 java.lang.String 中的所有方法，可以使用如下命令：

sm java.lang.String

执行结果如下：

也可以查看 java.lang.String 中的某个方法，可以使用如下命令：

# 查看某个方法
sm java.lang.String toString

# 查看某个方法的详细信息
sm -d java.lang.String toString

3.9 profiler 生成火焰图

profiler 命令支持生成应用热点的火焰图。本质上是通过不断地采样，然后把收集到的采样结果生成火焰图。

注意： 目前 profiler 生成火焰图的功能只支持在 Linux/Mac 系统中进行。

首先，启动 profiler，命令如下：

profiler start

获取已采集的 sample 的数量，命令如下：

profiler getSamples

查看 profiler 状态，命令如下：

profiler status

停止 profiler，并生成 html 文件，命令如下：

# 默认生成 html 文件
profiler stop

也可以指定 html 文件的生成位置，命令如下：

profiler stop --file /tmp/result.html

我们可以通过浏览器查看 arthas-output 下面的 profiler 结果。默认情况下，arthas 使用 3658 端口，我们可以访问如下地址：http://localhost:3658/arthas-output/

点击就可以查看具体的结果了：

图中横向长度越长的方法执行时间越长，一般绿色是我们自己的代码，黄色代表 JVM 底层的代码。

默认情况下，生成的是 CPU 的火焰图，即 event 为 CPU，可以使用 --event 参数来指定。在不同的平台，不同的 OS 下面，支持的 events 各有不同，比如在 MacOS 下面：

$ profiler list
Basic events:
  cpu
  alloc
  lock
  wall
  itimer

在 Linux 下面：

$ profiler list
Basic events:
  cpu
  alloc
  lock
  wall
  itimer
Perf events:
  page-faults
  context-switches
  cycles
  instructions
  cache-references
  cache-misses
  branches
  branch-misses
  bus-cycles
  L1-dcache-load-misses
  LLC-load-misses
  dTLB-load-misses
  mem:breakpoint
  trace:tracepoint

例如，我们相对 alloc 事件进行采样，我们可以用 --event 参数指定要采样的事件：

profiler start --event alloc

除此之外，我们还可以配置 include/exclude 来过滤数据。如果应用比较复杂，生成的内容很多，想只关注部分数据，可以通过 include/exclude 来过滤，比如：

profiler start --include 'java/*' --include 'demo/*' --exclude '*Unsafe.park*'

补充：include/exclude 都支持设置多个值，但是需要配置在命令行的最后。

3.10 tt 请求时间监控命令

如果我们想在生产环境中，实时监控接口的请求时长，可以使用 tt -t 包名.类名 方法名 -n 10命令：

# 监控DemoController的test()请求时长10次
tt -t com.demo.controller.DemoController test -n 10

• -n：提前限制要记录的次数，防止调用量非常大导致 JVM 内存撑爆。

执行结果如下所示：

可以看到，记录 10 次请求信息后就自动停止了。只要我们没有手动清理数据，数据就会一直缓存在内存中，即使退出 Arthas 也不会清除。

我们可以随时使用 tt -l 命令查看缓存中的请求信息列表：

我们可以使用 tt -i <INDEX> 来查看其中某一次请求的具体数据：

你以为这就完了吗？重头戏来了，我们还可以实现请求的重放！ 使用 tt -i <INDEX> -p 就可以将某一次请求进行重放：

注意： 使用 tt 命令记录的数据都一直在你内存中储存着，如果想要清理可以使用 tt --delete-all 命令。

---

四、补充

4.1 如何将 arthas 设置为快捷命令

1）Linux 系统设置快捷命令

对于 Linux 系统，可以编辑 ~/.bashrc 文件，在末尾追加如下内容：

# 设置arthas快捷命令（jar包位置视具体情况而定）
alias arthas='java -jar /usr/local/arthas/arthas-boot.jar'

设置之后，我们只需在 Linux 系统中，输入 arthas 即可启动，如下图所示：

2）Windows系统设置快捷命令

我们之前设置 JAVA_HOME 的时候都知道，只要将路径添加到 PATH 环境变量就可以快速执行了。

下面我们就直接在之前添加过的 %JAVA_HOME%/bin 目录下创建一个 arthas.bat 文本文件，文件内容如下：

java -jar "D:\java Tool\arthas\arthas-boot.jar"

如下所示：

制作完脚本文件后，我们来使用一下：Ctrl + R，输入 arthas，如下所示：

回车执行，就会进入 Arthas 的界面：

4.2 报错：The telnet port 3658 is used by process 637485

当我们在使用 Arthas 的时候，特别是在 Linux 环境下，我们可能经常会遇到这个报错：

[ERROR] The telnet port 3658 is used by process 637485 instead of target process 118024, you will connect to an unexpected process.

完整报错信息：

[ERROR] The telnet port 3658 is used by process 637485 instead of target process 118024, you will connect to an unexpected process.
[ERROR] 1. Try to restart arthas-boot, select process 637485, shutdown it first with running the 'stop' command.
[ERROR] 2. Or try to stop the existing arthas instance: java -jar arthas-client.jar 127.0.0.1 3658 -c "stop"
[ERROR] 3. Or try to use different telnet port, for example: java -jar arthas-boot.jar --telnet-port 9998 --http-port -1

报错分析：

• 根据提示信息我们可以看到，报错是因为 3658 端口正在 637485 进程使用，所以导致无法监控 118024 进程。

问题修复：

• 修复问题其实很简单，我们只要看下 637485 进程对应哪个 jar包，然后用 arthas 连接之后，使用 stop 命令正确退出即可。

我们可以看到 63748 PID 对应的是1，我们输入1，然后执行 stop 命令：

可以看到 Arthas 正常关闭了，再次连接其他 java 进程就不会报错了。

整理完毕，完结撒花~🌻