学习目标

1. 类和类加载器相关的命令
2. monitor/watcher/trace/stack/vmtool 等核心命令的使用
3. 火焰图

dump

作用

参数

举例

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

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

结果

小结

classloader

目标

作用

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

参数说明

举例

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

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

 
查看ClassLoader的继承树
 classloader -t

 
通过类加载器的hash，查看此类加载器实际所在的位置
 classloader -c 7f232c62

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

使用ClassLoader去查找类的class文件所在的位置

classloader -c 7f232c62 -r java/lang/String.class


 
使用ClassLoader去加载类
 classloader -c 7f232c62 --load java.lang.String

小结

1. 显示所有类加载器的信息
2. 获取某个类加载器所在的jar包
3. 获取某个资源在哪个jar包中
4. 加载某个类

monitor

目标

作用

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

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

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

参数说明

举例

 过5秒监控一次，类demo.MathGame中primeFactors方法
 monitor -c 5 demo.MathGame primeFactors

监控的维度说明

小结

 用来监视一个时间段中指定方法的执行次数，成功次数，失败次数，耗时等这些信息

watch

目标

作用

方法执行数据观测，让你能方便的观察到指定方法的调用情况。

能观察到的范围为：返回值
、抛出异常
、入参
，通过编写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"

小结

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参数指定捕捉结果的次数。比如下面的例子里，捕捉到一次调用就退出命令。
 trace demo.MathGame run -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
 

小结

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'

小结

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

tt

作用

介绍

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

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

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

参数解析

• t
  
  tt 命令有很多个主参数，-t
  就是其中之一。这个参数表明希望记录下类 *Test
  的 print
  方法的每次执行情况。
• n 3
  
  当你执行一个调用量不高的方法时可能你还能有足够的时间用 CTRL+C
  中断 tt 命令记录的过程，但如果遇到调用量非常大的方法，瞬间就能将你的 JVM 内存撑爆。
  此时你可以通过 -n
  参数指定你需要记录的次数，当达到记录次数时 Arthas 会主动中断tt命令的记录过程，避免人工操作无法停止的情况。

使用案例

基本使用

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

表格字段说明

• 条件表达式
  不知道大家是否有在使用过程中遇到以下困惑
  条件表达式也是用 OGNL
  来编写，核心的判断对象依然是 Advice
  对象。除了 tt
  命令之外，watch
  、trace
  、stack
  命令也都支持条件表达式。
• 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 -l

需要筛选出 primeFactors
方法的调用信息

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

查看调用信息

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

 tt -i 1004

重做一次调用

 tt -i 1004 -p

小结

作用：记录指定方法每次调用的入参和返回值，并后期还可以对这些信息进行观测

options

作用

全局开关

全局选项

案例

查看所有的options

 options

获取option的值

 options json-format

设置指定的option

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

 options save-result true

小结

profiler火焰图

目标

介绍

案例

启动profiler

 $ profiler start
 Started [cpu] profiling

默认情况下，生成的是cpu的火焰图，即event为cpu。可以用--event参数来指定。

显示支持的事件

 $ profiler list

获取已采集的sample的数量

 $ profiler getSamples
 17

查看profiler状态

 $ profiler status
 [cpu] profiling is running for 129 seconds

停止profiler

生成svg格式结果

 $ profiler stop
 profiler output file: /root/app/arthas/arthas-output/20211126-153129.svg
 OK

 $ profiler stop --file /tmp/output.svg
 profiler output file: /tmp/output.svg
 OK

生成html格式结果

默认情况下，结果文件是svg
格式，如果想生成html
格式，可以用--format
参数指定：

 $ profiler stop --format html
 profiler output file: /tmp/test/arthas-output/20191125-143329.html
 OK

或者在--file
参数里用文件名指名格式。比如--file /tmp/result.html
。

通过浏览器查看arthas-output下面的profiler结果

火焰图的含义

火焰图是基于 perf 结果产生的SVG 图片，用来展示 CPU 的调用栈。

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

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

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

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

小结

vmtool

https://arthas.aliyun.com/doc/vmtool.html#id1

$ vmtool --action getInstances --className java.lang.String --limit 10
@String[][
    @String[Sorry, deque too big],
    @String[head=%d tail=%d capacity=%d%n],
    @String[elements=%s%n],
    @String[sun/nio/ch/IOVecWrapper],
    @String[40252e37-8a73-4960-807e-3495addd5b08:1620922383791],
    @String[40252e37-8a73-4960-807e-3495addd5b08:1620922383791],
    @String[sun/nio/ch/AllocatedNativeObject],
    @String[sun/nio/ch/NativeObject],
    @String[sun/nio/ch/IOVecWrapper$Deallocator],
    @String[Java_sun_nio_ch_FileDispatcherImpl_writev0],
]

‍

可以通过 - -limit
参数来限制返回值的数量，避免获取超大数据时对 JVM 造成的压力。默认值为 10。

查找 spring context

vmtool --action getInstances --className org.springframework.context.ApplicationContext

getInstances action返回结果绑定到instances变量上，它是数组。通过 -x/--expand 参数可以指定结果的展开层次，默认值是1。
vmtool --action getInstances --className org.springframework.context.ApplicationContext -x 2

vmtool --action getInstances \\
 --classLoaderClass org.springframework.boot.loader.LaunchedURLClassLoader \\
 --className org.springframework.context.ApplicationContext

$ sc -d org.springframework.context.ApplicationContext class-info        org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext code-source       file:/private/tmp/demo-arthas-spring-boot.jar!/BOOT-INF/lib/spring-boot-1.5.13.RELEASE.jar!/ name              org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext... class-loader      +-org.springframework.boot.loader.LaunchedURLClassLoader@19469ea2                     +-sun.misc.Launcher$AppClassLoader@75b84c92                       +-sun.misc.Launcher$ExtClassLoader@4f023edb classLoaderHash   19469ea2

vmtool --action getInstances \\-c 19469ea2 \\--className org.springframework.context.ApplicationContext

强制GC

vmtool --action forceGc

[GC (JvmtiEnv ForceGarbageCollection)  25760K->17039K(349696K), 0.0015299 secs][Full GC (JvmtiEnv ForceGarbageCollection)  17039K->16840K(353792K), 0.0154049 secs]

‍

学习总结

参考

https://arthas.aliyun.com/doc/index.html