watch命令
使用参考
Arthas
是Alibaba开源的Java诊断工具,深受开发者喜爱。在线排查问题,无需重启;动态跟踪Java代码;实时监控JVM状态。
Arthas
支持JDK 6+,支持Linux/Mac/Windows,采用命令行交互模式,同时提供丰富的 Tab
自动补全功能,进一步方便进行问题的定位和诊断。
当你遇到以下类似问题而束手无策时,Arthas可以帮助你解决:
这个类从哪个 jar 包加载的?为什么会报各种类相关的 Exception?
我改的代码为什么没有执行到?难道是我没 commit?分支搞错了?
遇到问题无法在线上 debug,难道只能通过加日志再重新发布吗?
线上遇到某个用户的数据处理有问题,但线上同样无法 debug,线下无法重现!
是否有一个全局视角来查看系统的运行状况?
有什么办法可以监控到JVM的实时运行状态?
怎么快速定位应用的热点,生成火焰图?
本教程会以一个简单的应用为例,演示watch命令。
Github: https://github.com/alibaba/arthas
文档: https://arthas.aliyun.com/doc/
下载arthas-demo.jar
,再用java -jar
命令启动:
bash wget https://arthas.aliyun.com/arthas-demo.jar;java -jar arthas-demo.jar
arthas-demo
是一个很简单的程序,它随机生成整数,再执行因式分解,把结果打印出来。如果生成的随机数是负数,则会打印提示信息。
在新的Terminal 2
里,下载arthas-boot.jar
,再用java -jar
命令启动:
bash wget https://arthas.aliyun.com/arthas-boot.jar;java -jar arthas-boot.jar
arthas-boot
是Arthas
的启动程序,它启动后,会列出所有的Java进程,用户可以选择需要诊断的目标进程。
选择第一个进程,输入 1
,再Enter/回车
:
bash 1
Attach成功之后,会打印Arthas LOGO。输入 help
可以获取到更多的帮助信息。
bash help
方法执行数据观测
让你能方便的观察到指定方法的调用情况。能观察到的范围为:返回值
、抛出异常
、入参
,通过编写 OGNL 表达式进行对应变量的查看。
watch 的参数比较多,主要是因为它能在 4 个不同的场景观察对象
| 参数名称 | 参数说明 | | ------------------- | ------------------------------------------ | | class-pattern | 类名表达式匹配 | | method-pattern | 方法名表达式匹配 | | express | 观察表达式 | | condition-express | 条件表达式 | | [b] | 在方法调用之前观察 | | [e] | 在方法异常之后观察 | | [s] | 在方法返回之后观察 | | [f] | 在方法结束之后(正常返回和异常返回)观察 | | [E] | 开启正则表达式匹配,默认为通配符匹配 | | [x:] | 指定输出结果的属性遍历深度,默认为 1 |
这里重点要说明的是观察表达式,观察表达式的构成主要由 ognl 表达式组成,所以你可以这样写"{params,returnObj}"
,只要是一个合法的 ognl 表达式,都能被正常支持。
观察的维度也比较多,主要体现在参数 advice
的数据结构上。Advice
参数最主要是封装了通知节点的所有信息。请参考表达式核心变量中关于该节点的描述。
特殊用法请参考:https://github.com/alibaba/arthas/issues/71
OGNL表达式官网:https://commons.apache.org/proper/commons-ognl/language-guide.html
特别说明:
watch 命令定义了4个观察事件点,即 -b
方法调用前,-e
方法异常后,-s
方法返回后,-f
方法结束后
4个观察事件点 -b
、-e
、-s
默认关闭,-f
默认打开,当指定观察点被打开后,在相应事件点会对观察表达式进行求值并输出
这里要注意方法入参
和方法出参
的区别,有可能在中间被修改导致前后不一致,除了 -b
事件点 params
代表方法入参外,其余事件都代表方法出参
当使用 -b
时,由于观察事件点是在方法调用前,此时返回值或异常均不存在
bash watch demo.MathGame primeFactors "{params,returnObj}" -x 2
按q
或者Ctrl+c
退出
bash q console $ watch demo.MathGame primeFactors "{params,returnObj}" -x 2 Press Ctrl+C to abort. Affect(class-cnt:1 , method-cnt:1) cost in 44 ms. ts=2018-12-03 19:16:51; [cost=1.280502ms] result=@ArrayList[ @Object[][ @Integer[535629513], ], @ArrayList[ @Integer[3], @Integer[19], @Integer[191], @Integer[49199], ], ]
bash watch demo.MathGame primeFactors "{params,returnObj}" -x 2 -b
按q
或者Ctrl+c
退出
bash q console $ watch demo.MathGame primeFactors "{params,returnObj}" -x 2 -b Press Ctrl+C to abort. Affect(class-cnt:1 , method-cnt:1) cost in 50 ms. ts=2018-12-03 19:23:23; [cost=0.0353ms] result=@ArrayList[ @Object[][ @Integer[-1077465243], ], null, ]
对比前一个例子,返回值为空(事件点为方法执行前,因此获取不到返回值)
bash watch demo.MathGame primeFactors "{params,target,returnObj}" -x 2 -b -s -n 2
按q
或者Ctrl+c
退出
bash q console $ watch demo.MathGame primeFactors "{params,target,returnObj}" -x 2 -b -s -n 2 Press Ctrl+C to abort. Affect(class-cnt:1 , method-cnt:1) cost in 46 ms. ts=2018-12-03 19:29:54; [cost=0.01696ms] result=@ArrayList[ @Object[][ @Integer[1544665400], ], @MathGame[ random=@Random[java.util.Random@522b408a], illegalArgumentCount=@Integer[13038], ], null, ] ts=2018-12-03 19:29:54; [cost=4.277392ms] result=@ArrayList[ @Object[][ @Integer[1544665400], ], @MathGame[ random=@Random[java.util.Random@522b408a], illegalArgumentCount=@Integer[13038], ], @ArrayList[ @Integer[2], @Integer[2], @Integer[2], @Integer[5], @Integer[5], @Integer[73], @Integer[241], @Integer[439], ], ]
参数里-n 2
,表示只执行两次
这里输出结果中,第一次输出的是方法调用前的观察表达式的结果,第二次输出的是方法返回后的表达式的结果
结果的输出顺序和事件发生的先后顺序一致,和命令中 -s -b
的顺序无关
-x
的值,观察具体的方法参数值bash watch demo.MathGame primeFactors "{params,target}" -x 3
按q
或者Ctrl+c
退出
bash q console $ watch demo.MathGame primeFactors "{params,target}" -x 3 Press Ctrl+C to abort. Affect(class-cnt:1 , method-cnt:1) cost in 58 ms. ts=2018-12-03 19:34:19; [cost=0.587833ms] result=@ArrayList[ @Object[][ @Integer[47816758], ], @MathGame[ random=@Random[ serialVersionUID=@Long[3905348978240129619], seed=@AtomicLong[3133719055989], multiplier=@Long[25214903917], addend=@Long[11], mask=@Long[281474976710655], DOUBLE_UNIT=@Double[1.1102230246251565E-16], BadBound=@String[bound must be positive], BadRange=@String[bound must be greater than origin], BadSize=@String[size must be non-negative], seedUniquifier=@AtomicLong[-3282039941672302964], nextNextGaussian=@Double[0.0], haveNextNextGaussian=@Boolean[false], serialPersistentFields=@ObjectStreamField[][isEmpty=false;size=3], unsafe=@Unsafe[sun.misc.Unsafe@2eaa1027], seedOffset=@Long[24], ], illegalArgumentCount=@Integer[13159], ], ]
-x
表示遍历深度,可以调整来打印具体的参数和结果内容,默认值是1。
bash watch demo.MathGame primeFactors "{params[0],target}" "params[0]<0"
按q
或者Ctrl+c
退出
bash q console $ watch demo.MathGame primeFactors "{params[0],target}" "params[0]<0" Press Ctrl+C to abort. Affect(class-cnt:1 , method-cnt:1) cost in 68 ms. ts=2018-12-03 19:36:04; [cost=0.530255ms] result=@ArrayList[ @Integer[-18178089], @MathGame[demo.MathGame@41cf53f9], ]
只有满足条件的调用,才会有响应。
watch-express
单个值可以不加’{}’,多个值需要加’{a,b,c}’。
condition-express
不能加’{}’,可以使用逗号分隔子表达式,取表达式最后一个值来判断。
如果watch的方法存在同名的其它重载方法,可以通过下面的办法进行过滤:
根据参数类型进行过滤
watch demo.MathGame primeFactors '{params, params[0].class.name}' 'params[0].class.name == "java.lang.Integer"'
bash watch demo.MathGame primeFactors '{params, params[0].class.name}' 'params[0].class.name == "java.lang.Integer"'
按q
或者Ctrl+c
退出
bash q
根据参数个数进行过滤
watch demo.MathGame primeFactors '{params, params.length}' 'params.length==1'
bash watch demo.MathGame primeFactors '{params, params.length}' 'params.length==1'
按q
或者Ctrl+c
退出
bash q
bash watch demo.MathGame primeFactors "{params[0],throwExp}" -e -x 2
按q
或者Ctrl+c
退出
bash q console $ watch demo.MathGame primeFactors "{params[0],throwExp}" -e -x 2 Press Ctrl+C to abort. Affect(class-cnt:1 , method-cnt:1) cost in 62 ms. ts=2018-12-03 19:38:00; [cost=1.414993ms] result=@ArrayList[ @Integer[-1120397038], java.lang.IllegalArgumentException: number is: -1120397038, need >= 2 at demo.MathGame.primeFactors(MathGame.java:46) at demo.MathGame.run(MathGame.java:24) at demo.MathGame.main(MathGame.java:16) , ]
-e
表示抛出异常时才触发
express中,表示异常信息的变量是throwExp
根据异常类型或者message进行过滤:
bash watch demo.MathGame primeFactors '{params, throwExp}' '#msg=throwExp.toString(), #msg.contains("IllegalArgumentException")' -e -x 2
按q
或者Ctrl+c
退出
bash q
bash watch demo.MathGame primeFactors '{params, returnObj}' '#cost>200' -x 2
按q
或者Ctrl+c
退出
bash q console $ watch demo.MathGame primeFactors '{params, returnObj}' '#cost>200' -x 2 Press Ctrl+C to abort. Affect(class-cnt:1 , method-cnt:1) cost in 66 ms. ts=2018-12-03 19:40:28; [cost=2112.168897ms] result=@ArrayList[ @Object[][ @Integer[2141897465], ], @ArrayList[ @Integer[5], @Integer[428379493], ], ]
#cost>200
(单位是ms
)表示只有当耗时大于200ms时才会输出,过滤掉执行时间小于200ms的调用
bash watch demo.MathGame primeFactors 'target'
按q
或者Ctrl+c
退出
bash q
如果想查看方法运行前后,当前对象中的属性,可以使用target
关键字,代表当前对象
console $ watch demo.MathGame primeFactors 'target' Press Ctrl+C to abort. Affect(class-cnt:1 , method-cnt:1) cost in 52 ms. ts=2018-12-03 19:41:52; [cost=0.477882ms] result=@MathGame[ random=@Random[java.util.Random@522b408a], illegalArgumentCount=@Integer[13355], ]
然后使用target.field_name
访问当前对象的某个属性
bash watch demo.MathGame primeFactors 'target.illegalArgumentCount'
按q
或者Ctrl+c
退出
bash q console $ watch demo.MathGame primeFactors 'target.illegalArgumentCount' Press Ctrl+C to abort. Affect(class-cnt:1 , method-cnt:1) cost in 67 ms. ts=2018-12-03 20:04:34; [cost=131.303498ms] result=@Integer[8] ts=2018-12-03 20:04:35; [cost=0.961441ms] result=@Integer[8]
在“watch”中,我们演示了了Arthas的watch命令。如果有更多的技巧或者使用疑问,欢迎在Issue里提出。
Issues: https://github.com/alibaba/arthas/issues
文档: https://arthas.aliyun.com/doc
如果您在使用Arthas,请让我们知道。您的使用对我们非常重要:查看
文章拷贝来源:https://start.aliyun.com/course?spm=a2ck6.17690074.0.0.28bc2e7dHTphXs&id=PaiFAkJM