watch

watch在线教程

方法执行数据观测

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

参数说明

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

参数名称参数说明
class-pattern类名表达式匹配
method-pattern方法名表达式匹配
express观察表达式
condition-express条件表达式
[b]在方法调用之前观察
[e]在方法异常之后观察
[s]在方法返回之后观察
[f]在方法结束之后(正常返回和异常返回)观察
[E]开启正则表达式匹配，默认为通配符匹配
[x:]指定输出结果的属性遍历深度，默认为 1

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

观察的维度也比较多，主要体现在参数 advice 的数据结构上。Advice 参数最主要是封装了通知节点的所有信息。请参考表达式核心变量中关于该节点的描述。

特别说明：

  • watch 命令定义了4个观察事件点，即 -b 方法调用前，-e 方法异常后，-s 方法返回后，-f 方法结束后

  • 4个观察事件点 -b、-e、-s 默认关闭，-f 默认打开，当指定观察点被打开后，在相应事件点会对观察表达式进行求值并输出

  • 这里要注意方法入参和方法出参的区别，有可能在中间被修改导致前后不一致，除了 -b 事件点 params 代表方法入参外，其余事件都代表方法出参

  • 当使用 -b 时，由于观察事件点是在方法调用前，此时返回值或异常均不存在

使用参考

启动 Demo

启动快速入门里的arthas-demo。

观察方法出参和返回值

  1. $ watch demo.MathGame primeFactors "{params,returnObj}" -x 2
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 44 ms.
  4. ts=2018-12-03 19:16:51; [cost=1.280502ms] result=@ArrayList[
  5.     @Object[][
  6.         @Integer[1],
  7.     ],
  8.     @ArrayList[
  9.         @Integer[3],
  10.         @Integer[19],
  11.         @Integer[191],
  12.         @Integer[49199],
  13.     ],
  14. ]

观察方法入参

  1. $ watch demo.MathGame primeFactors "{params,returnObj}" -x 2 -b
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 50 ms.
  4. ts=2018-12-03 19:23:23; [cost=0.0353ms] result=@ArrayList[
  5.     @Object[][
  6.         @Integer[-1077465243],
  7.     ],
  8.     null,
  9. ]
  • 对比前一个例子，返回值为空（事件点为方法执行前，因此获取不到返回值）

同时观察方法调用前和方法返回后

  1. $ watch demo.MathGame primeFactors "{params,target,returnObj}" -x 2 -b -s -n 2
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 46 ms.
  4. ts=2018-12-03 19:29:54; [cost=0.01696ms] result=@ArrayList[
  5.     @Object[][
  6.         @Integer[1],
  7.     ],
  8.     @MathGame[
  9.         random=@Random[java.util.Random@522b408a],
  10.         illegalArgumentCount=@Integer[13038],
  11.     ],
  12.     null,
  13. ]
  14. ts=2018-12-03 19:29:54; [cost=4.277392ms] result=@ArrayList[
  15.     @Object[][
  16.         @Integer[1],
  17.     ],
  18.     @MathGame[
  19.         random=@Random[java.util.Random@522b408a],
  20.         illegalArgumentCount=@Integer[13038],
  21.     ],
  22.     @ArrayList[
  23.         @Integer[2],
  24.         @Integer[2],
  25.         @Integer[2],
  26.         @Integer[5],
  27.         @Integer[5],
  28.         @Integer[73],
  29.         @Integer[241],
  30.         @Integer[439],
  31.     ],
  32. ]

  • 参数里-n 2，表示只执行两次

  • 这里输出结果中，第一次输出的是方法调用前的观察表达式的结果，第二次输出的是方法返回后的表达式的结果

  • 结果的输出顺序和事件发生的先后顺序一致，和命令中 -s -b 的顺序无关

调整-x的值，观察具体的方法参数值

  1. $ watch demo.MathGame primeFactors "{params,target}" -x 3
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 58 ms.
  4. ts=2018-12-03 19:34:19; [cost=0.587833ms] result=@ArrayList[
  5.     @Object[][
  6.         @Integer[1],
  7.     ],
  8.     @MathGame[
  9.         random=@Random[
  10.             serialVersionUID=@Long[3905348978240129619],
  11.             seed=@AtomicLong[3133719055989],
  12.             multiplier=@Long[25214903917],
  13.             addend=@Long[11],
  14.             mask=@Long[281474976710655],
  15.             DOUBLE_UNIT=@Double[1.1102230246251565E-16],
  16.             BadBound=@String[bound must be positive],
  17.             BadRange=@String[bound must be greater than origin],
  18.             BadSize=@String[size must be non-negative],
  19.             seedUniquifier=@AtomicLong[-3282039941672302964],
  20.             nextNextGaussian=@Double[0.0],
  21.             haveNextNextGaussian=@Boolean[false],
  22.             serialPersistentFields=@ObjectStreamField[][isEmpty=false;size=3],
  23.             unsafe=@Unsafe[sun.misc.Unsafe@2eaa1027],
  24.             seedOffset=@Long[24],
  25.         ],
  26.         illegalArgumentCount=@Integer[13159],
  27.     ],
  28. ]
  • -x表示遍历深度，可以调整来打印具体的参数和结果内容，默认值是1。

条件表达式的例子

  1. $ watch demo.MathGame primeFactors "{params[0],target}" "params[0]<0"
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 68 ms.
  4. ts=2018-12-03 19:36:04; [cost=0.530255ms] result=@ArrayList[
  5.     @Integer[-18178089],
  6.     @MathGame[demo.MathGame@41cf53f9],
  7. ]
  • 只有满足条件的调用，才会有响应。

观察异常信息的例子

  1. $ watch demo.MathGame primeFactors "{params[0],throwExp}" -e -x 2
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 62 ms.
  4. ts=2018-12-03 19:38:00; [cost=1.414993ms] result=@ArrayList[
  5.     @Integer[-1120397038],
  6.     java.lang.IllegalArgumentException: number is: -1120397038, need >= 2
  7.     at demo.MathGame.primeFactors(MathGame.java:46)
  8.     at demo.MathGame.run(MathGame.java:24)
  9.     at demo.MathGame.main(MathGame.java:16)
  10. ,
  11. ]

  • -e表示抛出异常时才触发

  • express中，表示异常信息的变量是throwExp

按照耗时进行过滤

  1. $ watch demo.MathGame primeFactors '{params, returnObj}' '#cost>200' -x 2
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 66 ms.
  4. ts=2018-12-03 19:40:28; [cost=2112.168897ms] result=@ArrayList[
  5.     @Object[][
  6.         @Integer[1],
  7.     ],
  8.     @ArrayList[
  9.         @Integer[5],
  10.         @Integer[428379493],
  11.     ],
  12. ]
  • #cost>200(单位是ms)表示只有当耗时大于200ms时才会输出，过滤掉执行时间小于200ms的调用

观察当前对象中的属性

如果想查看方法运行前后，当前对象中的属性，可以使用target关键字，代表当前对象

  1. $ watch demo.MathGame primeFactors 'target'
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 52 ms.
  4. ts=2018-12-03 19:41:52; [cost=0.477882ms] result=@MathGame[
  5.     random=@Random[java.util.Random@522b408a],
  6.     illegalArgumentCount=@Integer[13355],
  7. ]

然后使用target.field_name访问当前对象的某个属性

  1. $ watch demo.MathGame primeFactors 'target.illegalArgumentCount'
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 67 ms.
  4. ts=2018-12-03 20:04:34; [cost=131.303498ms] result=@Integer[8]
  5. ts=2018-12-03 20:04:35; [cost=0.961441ms] result=@Integer[8]

获取类的静态字段、调用类的静态方法的例子

  1. watch demo.MathGame * '{params,@demo.MathGame@random.nextInt(100)}' -v -n 1 -x 2
  2. [arthas@6527]$ watch demo.MathGame * '{params,@demo.MathGame@random.nextInt(100)}' -n 1 -x 2
  3. Press Q or Ctrl+C to abort.
  4. Affect(class count: 1 , method count: 5) cost in 34 ms, listenerId: 3
  5. ts=2021-01-05 21:35:20; [cost=0.173966ms] result=@ArrayList[
  6.     @Object[][
  7.         @Integer[-138282],
  8.     ],
  9.     @Integer[89],
  10. ]
  • 注意这里使用 Thread.currentThread().getContextClassLoader() 加载,使用精确classloader ognl更好。

排除掉指定的类

watch/trace/monitor/stack/tt 命令都支持 --exclude-class-pattern 参数

使用 --exclude-class-pattern 参数可以排除掉指定的类，比如：

  1. watch javax.servlet.Filter * --exclude-class-pattern com.demo.TestFilter

不匹配子类

默认情况下 watch/trace/monitor/stack/tt 命令都会匹配子类。如果想不匹配，可以通过全局参数关掉。

  1. options disable-sub-class true

使用 -v 参数打印更多信息

watch/trace/monitor/stack/tt 命令都支持 -v 参数

当命令执行之后，没有输出结果。有两种可能：

  1. 匹配到的函数没有被执行

  2. 条件表达式结果是 false

但用户区分不出是哪种情况。

使用 -v选项，则会打印Condition express的具体值和执行结果，方便确认。

比如：

  1. $ watch -v -x 2 demo.MathGame print 'params' 'params[0] > 100000'
  2. Press Q or Ctrl+C to abort.
  3. Affect(class count: 1 , method count: 1) cost in 29 ms, listenerId: 11
  4. Condition express: params[0] > 100000 , result: false
  5. Condition express: params[0] > 100000 , result: false
  6. Condition express: params[0] > 100000 , result: true
  7. ts=2020-12-02 22:38:56; [cost=0.060843ms] result=@Object[][
  8.     @Integer[200033],
  9.     @ArrayList[
  10.         @Integer[200033],
  11.     ],
  12. ]
  13. Condition express: params[0] > 100000 , result: true
  14. ts=2020-12-02 22:38:57; [cost=0.052877ms] result=@Object[][
  15.     @Integer[123047],
  16.     @ArrayList[
  17.         @Integer[29],
  18.         @Integer[4243],
  19.     ],
  20. ]