Arthas学习笔记

一、运行环境

操作系统：centos7.9
Java版本：jdk1.8.201
arthas版本: 3.6.9

二、安装Arthas并attach一个进程

curl -O https://alibaba.github.io/arthas/arthas-boot.jar
curl -O https://alibaba.github.io/arthas/arthas-demo.jar

java -jar arthas-demo.jar  #先启动Java demo 进程或任意Java进程，但是需要注意该进程需要和arthas运行的用户一致
java -jar arthas-boot.jar   --target-ip 0.0.0.0 --telnet-port 9998 #新开一个页面，参数 --target-ip  --telnet-port指定监听地址和端口 ，默认监听地址为127.0.0.1



#清理arthas
rm -rf ~/.arthas/
rm -rf ~/logs/arthas

三、基础命令

1.help

查看命令帮助信息

2.cat

打印文件内容，和linux里的cat命令类似
如果没有写路径，则显示当前目录下的文件
[arthas@4121]$ cat /root/t1.txt

3.grep

匹配查找，和linux里的grep命令类似，但它只能用于管道命令

[arthas@4121]$ sysprop | grep java
 java.specification.version                     1.8
 java.class.path                                arthas-demo.jar
 java.vm.vendor                                 Oracle Corporation
 java.vendor.url                                http://java.oracle.com/
 java.vm.specification.version                  1.8

4.pwd

打印当前工作目录

5.cls

清屏

6.session

查看当前会话的信息

7.reset

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

还原指定类
reset Test

还原所有以List结尾的类
reset *List

还原所有的类
reset

8.history

打印命令历史

9.quit

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

10.stop

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

11.keymap

Arthas快捷键列表及自定义快捷键

四、快捷键

1.命令行快捷键

- 任何时候 `tab` 键，会根据当前的输入给出提示
- 命令后敲 `-` 或 `--` ，然后按 `tab` 键，可以展示出此命令具体的选项

2.后台异步命令相关快捷键

- ctrl + c: 终止当前命令
- ctrl + z: 挂起当前命令，后续可以 bg/fg 重新支持此命令，或 kill 掉
- ctrl + a: 回到行首
- ctrl + e: 回到行尾

五、jvm命令相关

1.dashboard

输入dashboard(仪表板)，按回车/enter，会展示当前进程的信息，按q或ctrl+c可以中断执行。

注：输入前面部分字母，按tab可以自动补全命令
　　第一部分是显示JVM中运行的所有线程：所在线程组，优先级，线程的状态，CPU的占用率，是否是后台进程等
　　第二部分显示的JVM内存的使用情况
　　第三部分是操作系统的一些信息和Java版本号

- ID: Java级别的线程ID，注意这个ID不能跟jstack中的nativeID一一对应
- NAME: 线程名
- GROUP: 线程组名
- PRIORITY: 线程优先级, 1~10之间的数字，越大表示优先级越高
- STATE: 线程的状态
- CPU%: 线程消耗的cpu占比，采样100ms，将所有线程在这100ms内的cpu使用量求和，再算出每个线程的cpu使用占比。
- TIME: 线程运行总时间，数据格式为`分：秒`
- INTERRUPTED: 线程当前的中断位状态
- DAEMON: 是否是daemon线程

2.thread

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

参数说明

示例

展示当前最忙的前3个线程并打印堆栈

显示1号线程的运行堆栈

 找出当前阻塞其他线程的线

指定采样时间间隔，每过1000毫秒采样，显示最占时间的3个线程

查看处于等待状态的线程

3.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当前打开的文件描述符数

4.sysprop

查看和修改JVM的系统属性

查看所有属性
sysprop

查看单个属性，支持通过tab补全
sysprop java.version

修改单个属性
sysprop user.country
user.country=US

sysprop user.country CN
Successfully changed the system property.
user.country=CN

5.sysenv

查看当前JVM的环境属性(`System Environment Variables`)

查看所有环境变量
sysenv

查看单个环境变量
sysenv USER

6.vmoption

查看，更新VM诊断相关的参数

查看所有的选项
vmoption

查看指定的选项
vmoption PrintGCDetails

更新指定的选项
vmoption PrintGCDetails true

7.getstatic

通过getstatic命令可以方便的查看类的静态属性

示例
显示demo.MathGame类中静态属性random
getstatic demo.MathGame random

8.ognl

执行ognl表达式，这是从3.0.5版本新增的功能

示例
调用静态函数
ognl '@[email protected]("hello")'

获取静态类的静态字段
ognl '@demo.MathGame@random'

执行多行表达式，赋值给临时变量，返回一个List
ognl '#value1=@System@getProperty("java.home"), #value2=@System@getProperty("java.runtime.name"), {#value1, #value2}'

六、class/classloader相关命令

1.sc

查看JVM已加载的类信息，“Search-Class” 的简写，这个命令能搜索出所有已经加载到 JVM 中的 Class 信息

sc 默认开启了子类匹配功能，也就是说所有当前类的子类也会被搜索出来，想要精确的匹配，请打开`options disable-sub-class true`开关

参数说明

示例

模糊搜索，demo包下所有的类
sc demo.*

打印类的详细信息
sc -d demo.MathGame

打印出类的Field信息
sc -df demo.MathGame

2.sm

查看已加载类的方法信息

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

sm 命令只能看到由当前类所声明 (declaring) 的方法，父类则无法看到。

参数说明

示例

显示String类加载的方法
sm java.lang.String

显示String中的toString方法详细信息
sm -d java.lang.String toString

3.jad

反编译指定已加载类源码
jad 命令将 JVM 中实际运行的 class 的 byte code 反编译成 java 代码，便于你理解业务逻辑； 
在 Arthas Console 上，反编译出来的源码是带语法高亮的，阅读更方便
当然，反编译出来的 java 代码可能会存在语法错误，但不影响你进行阅读理解

示例

反编译java.lang.String
jad java.lang.String

#反编绎时只显示源代码，默认情况下，反编译结果里会带有ClassLoader信息，通过--source-only选项，可以只打印源代码。方便和mc/redefine命令结合使用。 jad --source-only demo.MathGame

反编译指定的函数
jad demo.MathGame main

4.mc

Memory Compiler/内存编译器，编译.java文件生成.class

示例

在内存中编译Hello.java为Hello.class
mc /root/Hello.java

可以通过-d命令指定输出目录
mc -d /root/bbb /root/Hello.java  #bbb为输出目录

5.redefine

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

注意， redefine后的原来的类不能恢复，redefine有可能失败（比如增加了新的field）。

reset命令对redefine的类无效。如果想重置，需要redefine原始的字节码。

redefine命令和jad/watch/trace/monitor/tt等命令会冲突。执行完redefine之后，如果再执行上面提到的命令，则会把redefine的字节码重置。

redefine的限制

- 不允许新增加field/method
- 正在跑的函数，没有退出不能生效，比如下面新增加的`System.out.println`，只有`run()`函数里的会生效

public class MathGame {

    public static void main(String[] args) throws InterruptedException {
        MathGame game = new MathGame();
        while (true) {
            game.run();
            TimeUnit.SECONDS.sleep(1);
            // 这个不生效，因为代码一直跑在 while里
            System.out.println("in loop");
        }
    }

    public void run() throws InterruptedException {
        // 这个生效，因为run()函数每次都可以完整结束
        System.out.println("call run()");
        try {
            int number = random.nextInt();
            List<Integer> primeFactors = primeFactors(number);
            print(number, primeFactors);
        } catch (Exception e) {
            System.out.println(String.format("illegalArgumentCount:%3d, ", illegalArgumentCount) + e.getMessage());
        }
    }
    
}

综合示例

1. 使用jad反编译demo.MathGame输出到/root/MathGame.java jad --source-only demo.MathGame > /root/MathGame.java

2.按上面的代码编辑完毕以后，使用mc内存中对新的代码编译

mc /root/MathGame.java -d /root
3.使用redefine命令加载新的字节码
redefine /root/demo/MathGame.class

验证输出

6.dump

将已加载类的字节码文件保存到特定目录：logs/arthas/classdump/

参数

示例

把String类的字节码文件保存到~/logs/arthas/classdump/目录下
dump java.lang.String

把demo包下所有的类的字节码文件保存到~/logs/arthas/classdump/目录下
dump demo.*

7.classloader

获取类加载器信息
1. `classloader` 命令将 JVM 中所有的classloader的信息统计出来，并可以展示继承树，urls等。
2. 可以让指定的classloader去getResources，打印出所有查找到的resources的url。对于`ResourceNotFoundException`异常比较有用。

参数说明

示例

默认按类加载器的类型查看统计信息
classloader

按类加载器的实例查看统计信息，可以看到类加载的hashCode
classloader -l

查看ClassLoader的继承树
classloader -t

通过类加载器的hash，查看此类加载器实际所在的位置
classloader -c 680f2737  #680f2737 为hashCode

使用ClassLoader去查找指定资源resource所在的位置
classloader -c 680f2737 -r META-INF/MANIFEST.MF

使用ClassLoader去查找类的class文件所在的位置
classloader -c 680f2737 -r java/lang/String.class

使用ClassLoader去加载类
classloader -c 70dea4e --load java.lang.String

七、其他核心命令

1.monitor

监控指定类中方法的执行情况

对匹配 `class-pattern`／`method-pattern`的类、方法的调用进行监控。

`monitor` 命令是一个非实时返回命令，实时返回命令是输入之后立即返回

而非实时返回的命令，则是不断的等待目标 Java 进程返回信息，直到用户输入 `Ctrl+C` 为止。

参数说明

方法拥有一个命名参数 [c:]，意思是统计周期（cycle of output），拥有一个整型的参数值

举例

过5秒监控一次，类demo.MathGame中primeFactors方法
monitor -c 5 demo.MathGame primeFactors #默认等待120秒

监控的维度说明

2.watch

观察到指定方法的调用情况
能观察到的范围为：`返回值`、`抛出异常`、`入参`，通过编写OGNL 表达式进行对应变量的查看。

参数说明

watch 的参数比较多，主要是因为它能在 4 个不同的场景观察对象

这里重点要说明的是观察表达式，观察表达式的构成主要由ognl 表达式组成，所以你可以这样写"{params,returnObj}"，只要是一个合法的 ognl 表达式，都能被正常支持。

特别说明

- watch 命令定义了4个观察事件点，即 `-b` 方法调用前，`-e` 方法异常后，`-s` 方法返回后，`-f` 方法结束后
- 4个观察事件点 `-b`、`-e`、`-s` 默认关闭，`-f` 默认打开，当指定观察点被打开后，在相应事件点会对观察表达式进行求值并输出
- 这里要注意`方法入参`和`方法出参`的区别，有可能在中间被修改导致前后不一致，除了 `-b` 事件点 `params` 代表方法入参外，其余事件都代表方法出参
- 当使用 `-b` 时，由于观察事件点是在方法调用前，此时返回值或异常均不存在

示例

观察demo.MathGame类中primeFactors方法出参和返回值，结果属性遍历深度为2。
params表示所有参数数组(因为不确定是几个参数)，returnObject表示返回值

watch demo.MathGame primeFactors "{params,returnObj}" -x 2

观察方法入参，对比前一个例子，返回值为空（事件点为方法执行前，因此获取不到返回值）

watch demo.MathGame primeFactors "{params,returnObj}" -x 2 -b

观察当前对象中的属性，如果想查看方法运行前后，当前对象中的属性，可以使用target关键字，代表当前对象
watch demo.MathGame primeFactors 'target' -x 2

同时观察方法调用前和方法返回后，参数里-n 2，表示只执行两次。
这里输出结果中，第一次输出的是方法调用前的观察表达式的结果，第二次输出的是方法返回后的表达式的结果
params表示参数，target表示执行方法的对象，returnObject表示返回值

watch demo.MathGame primeFactors "{params,target,returnObj}" -x 2 -b -s -n 2

使用target.field_name访问当前对象的某个属性
watch demo.MathGame primeFactors 'target.illegalArgumentCount'

条件表达式的例子，输出第1参数小于的情况
watch demo.MathGame primeFactors "{params[0],target}" "params[0]<0"

3.trace

对方法内部调用路径进行追踪，并输出方法路径上的每个节点上耗时
`trace` 命令能主动搜索 `class-pattern`／`method-pattern` 对应的方法调用路径，渲染和统计整个调用链路上的所有性能开销和追踪调用链路。

观察表达式的构成主要由ognl 表达式组成，所以你可以这样写`"{params,returnObj}"`，只要是一个合法的 ognl 表达式，都能被正常支持。

很多时候我们只想看到某个方法的rt大于某个时间之后的trace结果，现在Arthas可以按照方法执行的耗时来进行过滤了，例如`trace *StringUtils isBlank '#cost>100'`表示当执行时间超过100ms的时候，才会输出trace的结果。

watch/stack/trace这个三个命令都支持`#cost`耗时条件过滤

参数说明

示例

trace函数指定类的指定方法
trace demo.MathGame run  #如果方法调用的次数很多，那么可以用-n参数指定捕捉结果的次数 如 -n 1 捕捉一次就退出命令

默认情况下，trace不会包含jdk里的函数调用，如果希望trace jdk里的函数，需要显式设置--skipJDKMethod false。
trace --skipJDKMethod false demo.MathGame run

据调用耗时过滤，trace大于0.5ms的调用路径
trace demo.MathGame run '#cost > .5'

可以用正则表匹配路径上的多个类和函数，一定程度上达到多层trace的效果。
trace -E com.test.ClassA|org.test.ClassB method1|method2|method3

4.stack

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

很多时候我们都知道一个方法被执行，但这个方法被执行的路径非常多，或者你根本就不知道这个方法是从那里被执行了，此时你需要的是 stack 命令。

参数说明

示例

获取primeFactors的调用路径
stack demo.MathGame primeFactors

条件表达式来过滤，第0个参数的值小于0，-n表示获取2次
stack demo.MathGame primeFactors 'params[0]<0' -n 2

据执行时间来过滤，耗时大于0.5毫秒
stack demo.MathGame primeFactors '#cost>0.5'

5.tt

time-tunnel 时间隧道

记录下指定方法每次调用的入参和返回信息，并能对这些不同时间下调用的信息进行观测

`watch` 虽然很方便和灵活，但需要提前想清楚观察表达式的拼写，这对排查问题而言要求太高，因为很多时候我们并不清楚问题出自于何方，只能靠蛛丝马迹进行猜测。

这个时候如果能记录下当时方法调用的所有入参和返回值、抛出的异常会对整个问题的思考与判断非常有帮助。

于是乎，TimeTunnel 命令就诞生了。

参数说明

基本使用示例

最基本的使用来说，就是记录下当前方法的每次调用环境现场。
tt -t demo.MathGame primeFactors

输出字段说明

- 条件表达式

  不知道大家是否有在使用过程中遇到以下困惑

  - Arthas 似乎很难区分出重载的方法
  - 我只需要观察特定参数，但是 tt 却全部都给我记录了下来

- 解决方法重载
  `tt -t *Test print params.length==1`
  通过制定参数个数的形式解决不同的方法签名，如果参数个数一样，你还可以这样写
  `tt -t *Test print 'params[1] instanceof Integer'`

- 解决指定参数
  `tt -t *Test print params[0].mobile=="13989838402"`

检索调用记录

当你用 `tt` 记录了一大片的时间片段之后，你希望能从中筛选出自己需要的时间片段，这个时候你就需要对现有记录进行检索
tt -l #打印之前的检索记录

需要筛选出指定方法的调用信息，如 primeFactors

tt -s 'method.name=="primeFactors"'

查看调用信息

对于具体一个时间片的信息而言，你可以通过 `-i` 参数后边跟着对应的 `INDEX` 编号查看到他的详细信息
tt -i 1002

重做一次调用

当你稍稍做了一些调整之后，你可能需要前端系统重新触发一次你的调用，此时得求爷爷告奶奶的需要前端配合联调的同学再次发起一次调用。而有些场景下，这个调用不是这么好触发的。

`tt` 命令由于保存了当时调用的所有现场信息，所以我们可以自己主动对一个 `INDEX` 编号的时间片自主发起一次调用，从而解放你的沟通成本。此时你需要 `-p` 参数。通过 `--replay-times` 指定 调用次数，通过 `--replay-interval` 指定多次调用间隔(单位ms, 默认1000ms)
tt -i 1002 -p

6.options

全局选项

全局选项

示例

查看所有的options
options

获取option的指定名称的值
options json-format

设置指定的option

例如，想打开执行结果存日志功能，输入如下命令即可：
options save-result true

7.profiler

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

示例

cpu
--event

显示支持的事件
profiler list

获取已采集的sample的数量
profiler getSamples

查看profiler状态，可以查看当前profiler在采样哪种`event`和采样时间。
profiler status

停止profiler并生成svg格式结果
 profiler stop

默认情况下，arthas使用8563端口，则可以打开： http://localhost:8563/arthas-output/ 查看到arthas-output目录下面的profiler结果：

文件显示

火焰图的含义

y 轴表示调用栈，每一层都是一个函数。调用栈越深，火焰就越高，顶部就是正在执行的函数，下方都是它的父函数。

x 轴表示抽样数，如果一个函数在 x 轴占据的宽度越宽，就表示它被抽到的次数多，即执行的时间长。注意，x 轴不代表时间，而是所有的调用栈合并后，按字母顺序排列的。

火焰图就是看顶层的哪个函数占据的宽度最大。只要有"平顶"（plateaus），就表示该函数可能存在性能问题。

颜色没有特殊含义，因为火焰图表示的是 CPU 的繁忙程度，所以一般选择暖色调。

综合实践

1.需求

1. 哪个Controller处理了请求
我们可以快速定位一个请求是被哪些`Filter`拦截的，或者请求最终是由哪些`Servlet`处理的。但有时，我们想知道一个请求是被哪个Spring MVC Controller处理的。如果翻代码的话，会比较难找，并且不一定准确。通过Arthas可以精确定位是哪个`Controller`处理请求。

2. 每个请求的调用参数和返回值是多少
通过watch来查看请求的参数和返回值

2.环境准备

将ssm_student.war项目部署到Linux的tomcat服务器下，可以正常访问。
部署MySQL数据库并导入SQL
war包及sql文件：https://pan.baidu.com/s/1KeOKZbyC70jBSrH3qZ8fFQ?pwd=n0bq

http://192.168.1.135:8080/ssm_student/  账号密码 NewBoy/123

3.实现步骤

在浏览器上进行登录操作，检查最耗时的方法

trace *.DispatcherServlet *

对最耗时的方法进行反编译获得源码

jad --source-only org.springframework.web.servlet.DispatcherServlet doDispatch

 watch org.springframework.web.servlet.DispatcherServlet getHandler 'returnObj'   #,刷新界面，查看返回的结果，得到使用到了2个控制器的方法

watch com.itheima.controller.* * {params,returnObj}

watch com.itheima.controller.* * {params,returnObj} -x 2

通过trace, jad, watch最后得到这个操作由2个控制器来处理，分别是： 

com.itheima.controller.UserController.login()
com.itheima.controller.StudentController.findAll()

"一劳永逸" 的话，有是有的，而 "一劳永逸" 的事却极少