Arthas
是Alibaba开源的Java诊断工具,深受开发者喜爱。
当你遇到以下类似问题而束手无策时,Arthas
可以帮助你解决:
- 这个类从哪个 jar 包加载的?为什么会报各种类相关的 Exception?
- 我改的代码为什么没有执行到?难道是我没 commit?分支搞错了?
- 遇到问题无法在线上 debug,难道只能通过加日志再重新发布吗?
- 线上遇到某个用户的数据处理有问题,但线上同样无法 debug,线下无法重现!
- 是否有一个全局视角来查看系统的运行状况?
- 有什么办法可以监控到JVM的实时运行状态?
- 怎么快速定位应用的热点,生成火焰图?
Arthas
支持JDK 6+,支持Linux/Mac/Windows,采用命令行交互模式,同时提供丰富的 Tab
自动补全功能,进一步方便进行问题的定位和诊断。
快速开始
使用arthas-boot
(推荐)
下载arthas-boot.jar
,然后用java -jar
的方式启动:
curl -O https://alibaba.github.io/arthas/arthas-boot.jar
java -jar arthas-boot.jar
打印帮助信息:
java -jar arthas-boot.jar -h
帮助信息如下
[root@iZ23a0kjkg7Z data]# java -jar arthas-boot.jar -h
[INFO] arthas-boot version: 3.1.7
Usage: arthas-boot [-h] [--target-ip <value>] [--telnet-port <value>]
[--http-port <value>] [--session-timeout <value>] [--arthas-home <value>]
[--use-version <value>] [--repo-mirror <value>] [--versions] [--use-http]
[--attach-only] [-c <value>] [-f <value>] [--height <value>] [--width
<value>] [-v] [--tunnel-server <value>] [--agent-id <value>] [--stat-url
<value>] [pid]
Bootstrap Arthas
EXAMPLES:
java -jar arthas-boot.jar <pid>
java -jar arthas-boot.jar --target-ip 0.0.0.0
java -jar arthas-boot.jar --telnet-port 9999 --http-port -1
java -jar arthas-boot.jar --tunnel-server 'ws://192.168.10.11:7777/ws'
java -jar arthas-boot.jar --tunnel-server 'ws://192.168.10.11:7777/ws'
--agent-id bvDOe8XbTM2pQWjF4cfw
java -jar arthas-boot.jar --stat-url 'http://192.168.10.11:8080/api/stat'
java -jar arthas-boot.jar -c 'sysprop; thread' <pid>
java -jar arthas-boot.jar -f batch.as <pid>
java -jar arthas-boot.jar --use-version 3.1.7
java -jar arthas-boot.jar --versions
java -jar arthas-boot.jar --session-timeout 3600
java -jar arthas-boot.jar --attach-only
java -jar arthas-boot.jar --repo-mirror aliyun --use-http
WIKI:
https://alibaba.github.io/arthas
Options and Arguments:
-h,--help Print usage
--target-ip <value> The target jvm listen ip, default 127.0.0.1
--telnet-port <value> The target jvm listen telnet port, default 3658
--http-port <value> The target jvm listen http port, default 8563
--session-timeout <value> The session timeout seconds, default 1800
(30min)
--arthas-home <value> The arthas home
--use-version <value> Use special version arthas
--repo-mirror <value> Use special maven repository mirror, value is
center/aliyun or http repo url.
--versions List local and remote arthas versions
--use-http Enforce use http to download, default use https
--attach-only Attach target process only, do not connect
-c,--command <value> Command to execute, multiple commands separated
by ;
-f,--batch-file <value> The batch file to execute
--height <value> arthas-client terminal height
--width <value> arthas-client terminal width
-v,--verbose Verbose, print debug info.
--tunnel-server <value> The tunnel server url
--agent-id <value> The agent id register to tunnel server
--stat-url <value> The report stat url
<pid> Target pid
[root@iZ23a0kjkg7Z data]#
- 如果下载速度比较慢,可以使用aliyun的镜像:
java -jar arthas-boot.jar --repo-mirror aliyun --use-http
使用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
来获取更多参数信息。
开源地址:https://github.com/alibaba/arthas
Arthas官方中文文档地址https://github.com/alibaba/arthas/blob/master/README_CN.md
Arthas 基础命令
-
help——查看命令帮助信息
-
cls——清空当前屏幕区域
-
session——查看当前会话的信息
-
reset——重置增强类,将被 Arthas 增强过的类全部还原,Arthas 服务端关闭时会重置所有增强过的类
-
version——输出当前目标 Java 进程所加载的 Arthas 版本号
-
history——打印命令历史
-
quit——退出当前 Arthas 客户端,其他 Arthas 客户端不受影响
-
stop——关闭 Arthas 服务端,所有 Arthas 客户端全部退出
-
keymap——Arthas快捷键列表及自定义快捷键
Arthas命令
官方文档命令列表地址https://alibaba.github.io/arthas/commands.html#arthas
强烈建议:在使用的时候,直接通过“命令 -h"(如:dash board -h) 来看语法讲解,这里只是自己学习时做的一点笔记
dashboard
当前系统的实时数据面板,按 ctrl+c 退出
dashboard [-b <value>] [-h] [-i <value>] [-n <value>]
数据说明
-
ID: Java级别的线程ID,注意这个ID不能跟jstack中的nativeID一一对应
-
NAME: 线程名
-
GROUP: 线程组名
-
PRIORITY: 线程优先级, 1~10之间的数字,越大表示优先级越高
-
STATE: 线程的状态
-
CPU%: 线程消耗的cpu占比,采样100ms,将所有线程在这100ms内的cpu使用量求和,再算出每个线程的cpu使用占比。
-
TIME: 线程运行总时间,数据格式为
分:秒
-
INTERRUPTED: 线程当前的中断位状态
-
DAEMON: 是否是daemon线程
thread
查看当前线程信息,查看线程的堆栈
thread [-h] [-b] [-i <value>] [--state <value>] [-n <value>] [id]
参数说明
参数名称 | 参数说明 |
---|---|
id | 线程id,显示指定线程运行的堆栈信息,如:thread 122 |
-n | 指定最忙的前N个线程并打印堆栈,如:thread -n 10 |
-b | 找出当前阻塞其他线程的线程, thread -b |
-i <value> | 指定cpu占比统计的采样间隔,单位为毫秒,如thread -i 5000 |
--state | 查看指定状态的线程,如:thread -state WAITING |
cpu占比是如何统计出来的?
这里的cpu统计的是,一段采样间隔内,当前JVM里各个线程所占用的cpu时间占总cpu时间的百分比。其计算方法为: 首先进行一次采样,获得所有线程的cpu的使用时间(调用的是
java.lang.management.ThreadMXBean#getThreadCpuTime
这个接口),然后睡眠一段时间,默认100ms,可以通过-i
参数指定,然后再采样一次,最后得出这段时间内各个线程消耗的cpu时间情况,最后算出百分比。
注意: 这个统计也会产生一定的开销(JDK这个接口本身开销比较大),因此会看到as的线程占用一定的百分比,为了降低统计自身的开销带来的影响,可以把采样间隔拉长一些,比如5000毫秒。
如果想看从Java进程启动开始到现在的cpu占比情况:可以使用show-busy-java-threads这个脚本
示例
threa 122
thread -i 5000
jvm
查看当前JVM信息
THREAD相关
-
COUNT: JVM当前活跃的线程数
-
DAEMON-COUNT: JVM当前活跃的守护线程数
-
PEAK-COUNT: 从JVM启动开始曾经活着的最大线程数
-
STARTED-COUNT: 从JVM启动开始总共启动过的线程次数
-
DEADLOCK-COUNT: JVM当前死锁的线程数
文件描述符相关
-
MAX-FILE-DESCRIPTOR-COUNT:JVM进程最大可以打开的文件描述符数
-
OPEN-FILE-DESCRIPTOR-COUNT:JVM当前打开的文件描述符数
sc
查看JVM已加载的类信息
sc [-c <value>] [-d] [-x <value>] [-f] [-h] [-E] class-pattern
“Search-Class” 的简写,这个命令能搜索出所有已经加载到 JVM 中的 Class 信息,这个命令支持的参数有 [d]
、[E]
、[f]
和 [x:]
。
参数说明
参数名称 | 参数说明 |
---|---|
class-pattern | 类名表达式匹配 |
method-pattern | 方法名表达式匹配 |
-d | 输出当前类的详细信息,包括这个类所加载的原始文件来源、类的声明、加载的ClassLoader等详细信息。 如果一个类被多个ClassLoader所加载,则会出现多次 |
-E | 开启正则表达式匹配,默认为通配符匹配 |
-f | 输出当前类的成员变量信息(需要配合参数-d一起使用) |
-x | 指定输出静态变量时属性的遍历深度,默认为 0,即直接使用 toString 输出 |
class-pattern支持全限定名,如com.taobao.test.AAA,也支持com/taobao/test/AAA这样的格式,这样,我们从异常堆栈里面把类名拷贝过来的时候,不需要在手动把/
替换为.
啦。
sc 默认开启了子类匹配功能,也就是说所有当前类的子类也会被搜索出来,想要精确的匹配,请打开options disable-sub-class true
开关
jad
反编译指定已加载类的源码
jad [-c <value>] [-h] [-E] [--source-only] class-pattern [method-name]
jad
命令将 JVM 中实际运行的 class 的 byte code 反编译成 java 代码,便于你理解业务逻辑;
-
在 Arthas Console 上,反编译出来的源码是带语法高亮的,阅读更方便
-
当然,反编译出来的 java 代码可能会存在语法错误,但不影响你进行阅读理解
参数说明
参数名称 | 参数说明 |
---|---|
class-pattern | 类名表达式匹配 |
-c | 类所属 ClassLoader 的 hashcode |
-E | 开启正则表达式匹配,默认为通配符匹配 |
--source-only | 值显示源码,默认情况下还会显示ClassLoader、Location信息 |
<method-name> | 方法名表达式,反编译一个具体的方法而不是全部类 |
redefine
加载外部的.class
文件,redefine jvm已加载的类。
参考:Instrumentation#redefineClasses
redefine [-c <value>] [-h] classfilePaths...
注意:redefine后的原来的类不能恢复,redefine有可能失败(比如增加了新的field),参考jdk本身的文档。
参数说明
参数名称 | 参数说明 |
---|---|
-c | ClassLoader的hashcode |
classfilePaths... | 外部的.class 文件的完整路径,支持多个 |
redefine的限制
-
不允许新增加field/method
-
正在跑的函数,没有退出不能生效,比如下面新增加的
System.out.println
,只有run()
函数里的会生效
heapdump
dump java heap, 类似jmap命令的heap dump功能
heapdump [-h] [-l] [file]
参数说明
参数名称 | 参数说明 |
-l, --live | 只dump live对象 |
<file> | 输出到的文件 |
trace
方法内部调用路径,并输出方法路径上的每个节点上耗时
trace
命令能主动搜索 class-pattern
/method-pattern
对应的方法调用路径,渲染和统计整个调用链路上的所有性能开销和追踪调用链路。
参数说明
参数名称 | 参数说明 |
---|---|
class-pattern | 类名表达式匹配 |
method-pattern | 方法名表达式匹配 |
condition-express | 条件表达式 |
[E] | 开启正则表达式匹配,默认为通配符匹配 |
[n:] | 命令执行次数 |
#cost | 方法执行耗时 |
参考https://blog.csdn.net/u013735734/article/details/102930307