groovy

Arthas 支持 groovy 脚本增强，允许像 BTrace 一样编写脚本来解决问题，可以在 groovy 脚本中进行if/for/switch/while 等控制语句，不受限制，但相比 BTrace 而言拥有更多的限制范围。

限制内容

  1. 禁止改变原有逻辑，与 watch 等命令一样，重点保证的是监听和观察。
  2. 只允许在方法的 before/success/exception/finish 四个环节进行监听。

参数说明

参数名称 参数说明
class-pattern 类名表达式匹配
method-pattern 方法名表达式匹配
script-filepath groovy 脚本的绝对路径
[S] 匹配所有的子类
[E] 开启正则表达式匹配，默认为通配符匹配

需要说明的是，第三个输入参数是脚本的绝对路径，比如 /tmp/test.groovy，不建议输入相对路径，比如 ./test.groovy

五个关键函数声明

  1. /**
  2.  * 增强脚本监听器
  3.  */
  4. interface ScriptListener {
  6.     /**
  7.      * 脚本创建
  8.      *
  9.      * @param output 输出器
  10.      */
  11.     void create(Output output);
  13.     /**
  14.      * 脚本销毁
  15.      *
  16.      * @param output 输出器
  17.      */
  18.     void destroy(Output output);
  20.     /**
  21.      * 方法执行前
  22.      *
  23.      * @param output 输出器
  24.      * @param advice 通知点
  25.      */
  26.     void before(Output output, Advice advice);
  28.     /**
  29.      * 方法正常返回
  30.      *
  31.      * @param output 输出器
  32.      * @param advice 通知点
  33.      */
  34.     void afterReturning(Output output, Advice advice);
  36.     /**
  37.      * 方法异常返回
  38.      *
  39.      * @param output 输出器
  40.      * @param advice 通知点
  41.      */
  42.     void afterThrowing(Output output, Advice advice);
  44. }

参数 Advice 说明

Advice 参数最主要是封装了通知节点的所有信息。参考表达式核心变量中关于该节点的描述。

参数 Output 说明

Output 参数只拥有三个方法，主要的工作还是输出对应的文本信息

  1. /**
  2.  * 输出器
  3.  */
  4. interface Output {
  6.     /**
  7.      * 输出字符串(不换行)
  8.      *
  9.      * @param string 待输出字符串
  10.      * @return this
  11.      */
  12.     Output print(String string);
  14.     /**
  15.      * 输出字符串(换行)
  16.      *
  17.      * @param string 待输出字符串
  18.      * @return this
  19.      */
  20.     Output println(String string);
  22.     /**
  23.      * 结束当前脚本
  24.      *
  25.      * @return this
  26.      */
  27.     Output finish();
  29. }

一个输出日志的 groovy 脚本示例

  1. import com.taobao.arthas.core.command.ScriptSupportCommand
  2. import com.taobao.arthas.core.util.Advice
  4. import static java.lang.String.format
  6. /**
  7.  * 输出方法日志
  8.  */
  9. public class Logger implements ScriptSupportCommand.ScriptListener {
  11.     @Override
  12.     void create(ScriptSupportCommand.Output output) {
  13.         output.println("script create.");
  14.     }
  16.     @Override
  17.     void destroy(ScriptSupportCommand.Output output) {
  18.         output.println("script destroy.");
  19.     }
  21.     @Override
  22.     void before(ScriptSupportCommand.Output output, Advice advice) {
  23.         output.println(format("before:class=%s;method=%s;paramslen=%d;%s;",
  24.                 advice.getClazz().getSimpleName(),
  25.                 advice.getMethod().getName(),
  26.                 advice.getParams().length, advice.getParams()))
  27.     }
  29.     @Override
  30.     void afterReturning(ScriptSupportCommand.Output output, Advice advice) {
  31.         output.println(format("returning:class=%s;method=%s;",
  32.                 advice.getClazz().getSimpleName(),
  33.                 advice.getMethod().getName()))
  34.     }
  36.     @Override
  37.     void afterThrowing(ScriptSupportCommand.Output output, Advice advice) {
  38.         output.println(format("throwing:class=%s;method=%s;",
  39.                 advice.getClazz().getSimpleName(),
  40.                 advice.getMethod().getName()))
  41.     }
  42. }

使用示例：

  1. $ groovy com.alibaba.sample.petstore.dal.dao.ProductDao getProductById /Users/zhuyong/middleware/arthas/scripts/Logger.groovy -S
  2. script create.
  3. Press Ctrl+C to abort.
  4. Affect(class-cnt:1 , method-cnt:1) cost in 102 ms.
  5. before:class=IbatisProductDao;method=getProductById;paramslen=1;[Ljava.lang.Object;@45df64fc;
  6. returning:class=IbatisProductDao;method=getProductById;
  7. before:class=IbatisProductDao;method=getProductById;paramslen=1;[Ljava.lang.Object;@5b0e2d00;
  8. returning:class=IbatisProductDao;method=getProductById;