Arthas 快速入门
Arthas 快速入门
Arthas
是 Alibaba 开源的 Java 诊断工具 。
简介
Arthas
可以解决的问题:
- 这个类从哪个 jar 包加载的?为什么会报各种类相关的 Exception?
- 我改的代码为什么没有执行到?难道是我没 commit?分支搞错了?
- 遇到问题无法在线上 debug,难道只能通过加日志再重新发布吗?
- 线上遇到某个用户的数据处理有问题,但线上同样无法 debug,线下无法重现!
- 是否有一个全局视角来查看系统的运行状况?
- 有什么办法可以监控到 JVM 的实时运行状态?
Arthas
支持 JDK 6+,支持 Linux/Mac/Windows,采用命令行交互模式,同时提供丰富的 Tab
自动补全功能,进一步方便进行问题的定位和诊断。
安装
使用arthas-boot
(推荐)
下载arthas-boot.jar
,然后用java -jar
的方式启动:
1 | wget https://alibaba.github.io/arthas/arthas-boot.jar |
打印帮助信息:
1 | java -jar arthas-boot.jar -h |
如果下载速度比较慢,可以使用 aliyun 的镜像:
1
java -jar arthas-boot.jar --repo-mirror aliyun --use-http
如果从 github 下载有问题,可以使用 gitee 镜像
1
wget https://arthas.gitee.io/arthas-boot.jar
使用as.sh
Arthas 支持在 Linux/Unix/Mac 等平台上一键安装,请复制以下内容,并粘贴到命令行中,敲 回车
执行即可:
1 | curl -L https://alibaba.github.io/arthas/install.sh | sh |
上述命令会下载启动脚本文件 as.sh
到当前目录,你可以放在任何地方或将其加入到 $PATH
中。
直接在 shell 下面执行./as.sh
,就会进入交互界面。
也可以执行./as.sh -h
来获取更多参数信息。
如果从 github 下载有问题,可以使用 gitee 镜像
1
curl -L https://arthas.gitee.io/install.sh | sh
全量安装
最新版本,点击下载:下载地址
解压后,在文件夹里有arthas-boot.jar
,直接用java -jar
的方式启动:
1 | java -jar arthas-boot.jar |
打印帮助信息:
1 | java -jar arthas-boot.jar -h |
基础使用
启动 Demo
1 | wget https://alibaba.github.io/arthas/arthas-demo.jar |
arthas-demo
是一个简单的程序,每隔一秒生成一个随机数,再执行质因式分解,并打印出分解结果。
arthas-demo
源代码:查看
启动 arthas
在命令行下面执行(使用和目标进程一致的用户启动,否则可能 attach 失败):
1 | wget https://alibaba.github.io/arthas/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 进程:
1 | $ $ java -jar arthas-boot.jar |
Demo 进程是第 2 个,则输入 2,再输入回车/enter
。Arthas 会 attach 到目标进程上,并输出日志:
1 | [INFO] Try to attach process 71560 |
查看 dashboard
输入dashboard,按回车/enter
,会展示当前进程的信息,按ctrl+c
可以中断执行。
1 | $ dashboard |
通过 thread 命令来获取到arthas-demo
进程的 Main Class
thread 1
会打印线程 ID 1 的栈,通常是 main 函数的线程。
1 | $ thread 1 | grep 'main(' |
通过 jad 来反编译 Main Class
1 | $ jad demo.MathGame |
watch
通过watch命令来查看demo.MathGame#primeFactors
函数的返回值:
1 | $ watch demo.MathGame primeFactors returnObj |
更多的功能可以查看进阶使用。
退出 arthas
如果只是退出当前的连接,可以用quit
或者exit
命令。Attach 到目标进程上的 arthas 还会继续运行,端口会保持开放,下次连接时可以直接连接上。
如果想完全退出 arthas,可以执行shutdown
命令。
进阶使用
基础命令
- help——查看命令帮助信息
- cat——打印文件内容,和 linux 里的 cat 命令类似
- pwd——返回当前的工作目录,和 linux 命令类似
- cls——清空当前屏幕区域
- session——查看当前会话的信息
- reset——重置增强类,将被 Arthas 增强过的类全部还原,Arthas 服务端关闭时会重置所有增强过的类
- version——输出当前目标 Java 进程所加载的 Arthas 版本号
- history——打印命令历史
- quit——退出当前 Arthas 客户端,其他 Arthas 客户端不受影响
- shutdown——关闭 Arthas 服务端,所有 Arthas 客户端全部退出
- keymap——Arthas 快捷键列表及自定义快捷键
jvm 相关
- dashboard——当前系统的实时数据面板
- thread——查看当前 JVM 的线程堆栈信息
- jvm——查看当前 JVM 的信息
- sysprop——查看和修改 JVM 的系统属性
- sysenv——查看 JVM 的环境变量
- vmoption——查看和修改 JVM 里诊断相关的 option
- logger——查看和修改 logger
- getstatic——查看类的静态属性
- ognl——执行 ognl 表达式
- mbean——查看 Mbean 的信息
- heapdump——dump java heap, 类似 jmap 命令的 heap dump 功能
class/classloader 相关
- sc——查看 JVM 已加载的类信息
- sm——查看已加载类的方法信息
- jad——反编译指定已加载类的源码
- mc——内存编绎器,内存编绎
.java
文件为.class
文件 - redefine——加载外部的
.class
文件,redefine 到 JVM 里 - dump——dump 已加载类的 byte code 到特定目录
- classloader——查看 classloader 的继承树,urls,类加载信息,使用 classloader 去 getResource
monitor/watch/trace 相关
请注意,这些命令,都通过字节码增强技术来实现的,会在指定类的方法中插入一些切面来实现数据统计和观测,因此在线上、预发使用时,请尽量明确需要观测的类、方法以及条件,诊断结束要执行
shutdown
或将增强过的类执行reset
命令。
- monitor——方法执行监控
- watch——方法执行数据观测
- trace——方法内部调用路径,并输出方法路径上的每个节点上耗时
- stack——输出当前方法被调用的调用路径
- tt——方法执行数据的时空隧道,记录下指定方法每次调用的入参和返回信息,并能对这些不同的时间下调用进行观测
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。
用户数据回报
在3.1.4
版本后,增加了用户数据回报功能,方便统一做安全或者历史数据统计。
在启动时,指定stat-url
,就会回报执行的每一行命令,比如: ./as.sh --stat-url 'http://192.168.10.11:8080/api/stat'
在 tunnel server 里有一个示例的回报代码,用户可以自己在服务器上实现。