关键词搜索

源码搜索 ×
×

一款深受开发者喜爱的Java诊断工具-Arthas

发布2023-01-31浏览436次

详情内容

今天要给大家分享的是一款Alibaba开源的Java诊断工具Arthas。

Arthas 是 Alibaba 在 2018 年 9 月开源的 Java 诊断工具。支持 JDK6+， 采用命令行交互模式，提供 Tab 自动补全，可以方便定位和诊断线上程序运行问题。得益于 Arthas 强大且丰富的功能，让 Arthas 能做很多的事情，比如以下场景：

  1. 是否有一个全局视角来查看系统的运行状况？

  2. 为什么 CPU 又升高了，到底是哪里占用了 CPU ？

  3. 运行的多线程有死锁吗？有阻塞吗？

  4. 程序运行耗时很长，是哪里耗时比较长呢？如何监测呢？

  5. 这个类从哪个 jar 包加载的？为什么会报各种类相关的 Exception？

  6. 遇到问题无法在线上 debug，难道只能通过加日志再重新发布吗？

简介

Arthas 是一款线上监控诊断产品，通过全局视角实时查看应用 load、内存、gc、线程的状态信息，并能在不修改应用代码的情况下，对业务问题进行诊断，包括查看方法调用的出入参、异常，监测方法执行耗时，类加载信息等，大大提升线上问题排查效率。

快速入门

1、启动 math-game

  1. curl -O https://arthas.aliyun.com/math-game.jar
  2. java -jar math-game.jar

math-game是一个简单的程序，每隔一秒生成一个随机数，再执行质因数分解，并打印出分解结果。

math-game源代码：

  1. public class MathGame {
  2.     private static Random random = new Random();
  3.  
  4.     private int illegalArgumentCount = 0;
  5.  
  6.     public static void main(String[] args) throws InterruptedException {
  7.         MathGame game = new MathGame();
  8.         while (true) {
  9.             game.run();
  10.             TimeUnit.SECONDS.sleep(1);
  11.         }
  12.     }
  13.  
  14.     public void run() throws InterruptedException {
  15.         try {
  16.             int number = random.nextInt()/10000;
  17.             List<Integer> primeFactors = primeFactors(number);
  18.             print(number, primeFactors);
  19.  
  20.         } catch (Exception e) {
  21.             System.out.println(String.format("illegalArgumentCount:%3d, ", illegalArgumentCount) + e.getMessage());
  22.         }
  23.     }
  24.  
  25.     public static void print(int number, List<Integer> primeFactors) {
  26.         StringBuffer sb = new StringBuffer(number + "=");
  27.         for (int factor : primeFactors) {
  28.             sb.append(factor).append('*');
  29.         }
  30.         if (sb.charAt(sb.length() - 1) == '*') {
  31.             sb.deleteCharAt(sb.length() - 1);
  32.         }
  33.         System.out.println(sb);
  34.     }
  35.  
  36.     public List<Integer> primeFactors(int number) {
  37.         if (number < 2) {
  38.             illegalArgumentCount++;
  39.             throw new IllegalArgumentException("number is: " + number + ", need >= 2");
  40.         }
  41.  
  42.         List<Integer> result = new ArrayList<Integer>();
  43.         int i = 2;
  44.         while (i <= number) {
  45.             if (number % i == 0) {
  46.                 result.add(i);
  47.                 number = number / i;
  48.                 i = 2;
  49.             } else {
  50.                 i++;
  51.             }
  52.         }
  53.  
  54.         return result;
  55.     }
  56. }

2、启动arthas

在命令行下面执行（使用和目标进程一致的用户启动，否则可能 attach 失败）：

  1.  
  2. curl -O https://arthas.aliyun.com/arthas-boot.jar
  3. java -jar arthas-boot.jar

  • 执行该程序的用户需要和目标进程具有相同的权限。比如以admin用户来执行：sudo su admin && java -jar arthas-boot.jar 或 sudo -u admin -EH java -jar arthas-boot.jar。

  • 如果 attach 不上目标进程，可以查看~/logs/arthas/ 目录下的日志。

  • 如果下载速度比较慢，可以使用 aliyun 的镜像：java -jar arthas-boot.jar --repo-mirror aliyun --use-http

  • java -jar arthas-boot.jar -h 打印更多参数信息。

选择应用 java 进程：

  1.  
  2. $ $ java -jar arthas-boot.jar
  3. * [1]: 35542
  4.   [2]: 71560 math-game.jar

math-game进程是第 2 个，则输入 2，再输入回车/enter。Arthas 会 attach 到目标进程上，并输出日志：

  1.  
  2. [INFO] Try to attach process 71560
  3. [INFO] Attach process 71560 success.
  4. [INFO] arthas-client connect 127.0.0.1 3658
  5.   ,---.  ,------. ,--------.,--.  ,--.  ,---.   ,---.
  6.  /  O  \ |  .--. ''--.  .--'|  '--'  | /  O  \ '   .-'
  7. |  .-.  ||  '--'.'   |  |   |  .--.  ||  .-.  |`.  `-.
  8. |  | |  ||  |\  \    |  |   |  |  |  ||  | |  |.-'    |
  9. `--' `--'`--' '--'   `--'   `--'  `--'`--' `--'`-----'
  10.  
  11.  
  12. wiki: https://arthas.aliyun.com/doc
  13. version: 3.0.5.20181127201536
  14. pid: 71560
  15. time: 2018-11-28 19:16:24
  16.  
  17. $

3、查看dashboard

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

  1. $ dashboard
  2. ID     NAME                   GROUP          PRIORI STATE  %CPU    TIME   INTERRU DAEMON
  3. 17     pool-2-thread-1        system         5      WAITIN 67      0:0    false   false
  4. 27     Timer-for-arthas-dashb system         10     RUNNAB 32      0:0    false   true
  5. 11     AsyncAppender-Worker-a system         9      WAITIN 0       0:0    false   true
  6. 9      Attach Listener        system         9      RUNNAB 0       0:0    false   true
  7. 3      Finalizer              system         8      WAITIN 0       0:0    false   true
  8. 2      Reference Handler      system         10     WAITIN 0       0:0    false   true
  9. 4      Signal Dispatcher      system         9      RUNNAB 0       0:0    false   true
  10. 26     as-command-execute-dae system         10     TIMED_ 0       0:0    false   true
  11. 13     job-timeout            system         9      TIMED_ 0       0:0    false   true
  12. 1      main                   main           5      TIMED_ 0       0:0    false   false
  13. 14     nioEventLoopGroup-2-1  system         10     RUNNAB 0       0:0    false   false
  14. 18     nioEventLoopGroup-2-2  system         10     RUNNAB 0       0:0    false   false
  15. 23     nioEventLoopGroup-2-3  system         10     RUNNAB 0       0:0    false   false
  16. 15     nioEventLoopGroup-3-1  system         10     RUNNAB 0       0:0    false   false
  17. Memory             used   total max    usage GC
  18. heap               32M    155M  1820M  1.77% gc.ps_scavenge.count  4
  19. ps_eden_space      14M    65M   672M   2.21% gc.ps_scavenge.time(m 166
  20. ps_survivor_space  4M     5M    5M           s)
  21. ps_old_gen         12M    85M   1365M  0.91% gc.ps_marksweep.count 0
  22. nonheap            20M    23M   -1           gc.ps_marksweep.time( 0
  23. code_cache         3M     5M    240M   1.32% ms)
  24. Runtime
  25. os.name                Mac OS X
  26. os.version             10.13.4
  27. java.version           1.8.0_162
  28. java.home              /Library/Java/JavaVir
  29.                        tualMachines/jdk1.8.0
  30.                        _162.jdk/Contents/Hom
  31.                        e/jre

4、通过thread命令获取到math-game进程的Main Class

thread 1会打印线程 ID 1 的栈，通常是 main 函数的线程。

  1.  
  2. $ thread 1 | grep 'main('
  3.     at demo.MathGame.main(MathGame.java:17)

5、通过jad来反编译Main Class

  1.  
  2. $ jad demo.MathGame
  3.  
  4. ClassLoader:
  5. +-sun.misc.Launcher$AppClassLoader@3d4eac69
  6.   +-sun.misc.Launcher$ExtClassLoader@66350f69
  7.  
  8. Location:
  9. /tmp/math-game.jar
  10.  
  11. /*
  12.  * Decompiled with CFR 0_132.
  13.  */
  14. package demo;
  15.  
  16. import java.io.PrintStream;
  17. import java.util.ArrayList;
  18. import java.util.Iterator;
  19. import java.util.List;
  20. import java.util.Random;
  21. import java.util.concurrent.TimeUnit;
  22.  
  23. public class MathGame {
  24.     private static Random random = new Random();
  25.     private int illegalArgumentCount = 0;
  26.  
  27.     public static void main(String[] args) throws InterruptedException {
  28.         MathGame game = new MathGame();
  29.         do {
  30.             game.run();
  31.             TimeUnit.SECONDS.sleep(1L);
  32.         } while (true);
  33.     }
  34.  
  35.     public void run() throws InterruptedException {
  36.         try {
  37.             int number = random.nextInt();
  38.             List<Integer> primeFactors = this.primeFactors(number);
  39.             MathGame.print(number, primeFactors);
  40.         }
  41.         catch (Exception e) {
  42.             System.out.println(String.format("illegalArgumentCount:%3d, ", this.illegalArgumentCount) + e.getMessage());
  43.         }
  44.     }
  45.  
  46.     public static void print(int number, List<Integer> primeFactors) {
  47.         StringBuffer sb = new StringBuffer("" + number + "=");
  48.         Iterator<Integer> iterator = primeFactors.iterator();
  49.         while (iterator.hasNext()) {
  50.             int factor = iterator.next();
  51.             sb.append(factor).append('*');
  52.         }
  53.         if (sb.charAt(sb.length() - 1) == '*') {
  54.             sb.deleteCharAt(sb.length() - 1);
  55.         }
  56.         System.out.println(sb);
  57.     }
  58.  
  59.     public List<Integer> primeFactors(int number) {
  60.         if (number < 2) {
  61.             ++this.illegalArgumentCount;
  62.             throw new IllegalArgumentException("number is: " + number + ", need >= 2");
  63.         }
  64.         ArrayList<Integer> result = new ArrayList<Integer>();
  65.         int i = 2;
  66.         while (i <= number) {
  67.             if (number % i == 0) {
  68.                 result.add(i);
  69.                 number /= i;
  70.                 i = 2;
  71.                 continue;
  72.             }
  73.             ++i;
  74.         }
  75.         return result;
  76.     }
  77. }
  78.  
  79. Affect(row-cnt:1) cost in 970 ms.

6、watch

通过watch命令来查看demo.MathGame#primeFactors函数的返回值：

  1. $ watch demo.MathGame primeFactors returnObj
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 107 ms.
  4. ts=2018-11-28 19:22:30; [cost=1.715367ms] result=null
  5. ts=2018-11-28 19:22:31; [cost=0.185203ms] result=null
  6. ts=2018-11-28 19:22:32; [cost=19.012416ms] result=@ArrayList[
  7.     @Integer[5],
  8.     @Integer[47],
  9.     @Integer[2675531],
  10. ]
  11. ts=2018-11-28 19:22:33; [cost=0.311395ms] result=@ArrayList[
  12.     @Integer[2],
  13.     @Integer[5],
  14.     @Integer[317],
  15.     @Integer[503],
  16.     @Integer[887],
  17. ]
  18. ts=2018-11-28 19:22:34; [cost=10.136007ms] result=@ArrayList[
  19.     @Integer[2],
  20.     @Integer[2],
  21.     @Integer[3],
  22.     @Integer[3],
  23.     @Integer[31],
  24.     @Integer[717593],
  25. ]
  26. ts=2018-11-28 19:22:35; [cost=29.969732ms] result=@ArrayList[
  27.     @Integer[5],
  28.     @Integer[29],
  29.     @Integer[7651739],
  30. ]

7、退出arthas

如果只是退出当前的连接，可以用quit或者exit命令。Attach 到目标进程上的 arthas 还会继续运行，端口会保持开放，下次连接时可以直接连接上。

如果想完全退出 arthas，可以执行stop命令。

进阶使用

1、Web Console

Arthas 目前支持 Web Console，用户在 attach 成功之后，可以直接访问：http://127.0.0.1:8563/在新窗口打开。

可以填入 IP，远程连接其它机器上的 arthas。

2、Arthas Properties

arthas.properties文件在 arthas 的目录下。

  • 如果是自动下载的 arthas，则目录在~/.arthas/lib/3.x.x/arthas/下面

  • 如果是下载的完整包，在 arthas 解压目录下


支持的配置项

注意配置必须是驼峰的，和 spring boot 的-风格不一样。spring boot 应用才同时支持驼峰 和 -风格的配置。

  1. #arthas.config.overrideAll=true
  2. arthas.telnetPort=3658
  3. arthas.httpPort=8563
  4. arthas.ip=127.0.0.1
  5.  
  6. # seconds
  7. arthas.sessionTimeout=1800
  8.  
  9. #arthas.appName=demoapp
  10. #arthas.tunnelServer=ws://127.0.0.1:7777/ws
  11. #arthas.agentId=mmmmmmyiddddd

  • 如果配置 arthas.telnetPort为 -1 ，则不 listen telnet 端口。arthas.httpPort类似。

  • 如果配置 arthas.telnetPort为 0 ，则随机 telnet 端口，在~/logs/arthas/arthas.log里可以找到具体端口日志。arthas.httpPort类似。

3、Java Agent

通常 Arthas 是以动态 attach 的方式来诊断应用，但从3.2.0版本起，Arthas 支持直接以 java agent 的方式启动。

比如下载全量的 arthas zip 包，解压之后以 -javaagent 的参数指定arthas-agent.jar来启动：

通常 Arthas 是以动态 attach 的方式来诊断应用，但从3.2.0版本起，Arthas 支持直接以 java agent 的方式启动。
比如下载全量的 arthas zip 包，解压之后以 -javaagent 的参数指定arthas-agent.jar来启动：

默认的配置项在解压目录里的arthas.properties文件里。参考：Arthas Properties

Java Agent 机制参考：https://docs.oracle.com/javase/8/docs/api/java/lang/instrument/package-summary.html

结论

虽然有了Arthas，但也不要忘记JDK自带的性能调优工具，在某些场景下，它还是有很大作用的。而且Arthas里面很多功能其根本就是封装了JDK自带的这些调优命令。
 

以上就是有关Arthas的使用了，如果觉得本文对你有帮助，可以转发关注支持一下

关注Java私房菜，获取开源Java技术。

相关技术文章

最新源码

下载排行榜
点击QQ咨询
开通会员
返回顶部
×
微信扫码支付 元
微信扫码支付
确定支付下载
请使用微信描二维码支付
×

提示信息

×

选择支付方式

  • 微信支付
  • 支付宝付款
确定支付下载