在阿里巴巴內部,有很多自研工具供開發者使用,其中有一款工具,是幾乎每個JAVA開發都使用過的工具,那就是Arthas,這是一款Java診斷工具,是一款牛逼帶閃電的工具。該工具已于2018年9月份開源。
GitHub地址:https://github.com/alibaba/arthas 用戶文檔:https://alibaba.github.io/arthas/
在日常開發中,你是否遇到過以下問題:
這個類從哪個 jar 包加載的?為什么會報各種類相關的 Exception?
我改的代碼為什么沒有執行到?難道是我沒 commit?分支搞錯了?
遇到問題無法在線上 debug,難道只能通過加日志再重新發布嗎?
線上遇到某個用戶的數據處理有問題,但線上同樣無法 debug,線下無法重現!
是否有一個全局視角來查看系統的運行狀況?
有什么辦法可以監控到JVM的實時運行狀態
以上問題,通通可以通過Arthas來進行問題診斷!!!是不是很好很強大Arthas支持JDK 6+,采用命令行交互模式,同時提供豐富的 Tab 自動補全功能,進一步方便進行問題的定位和診斷。
Arthas安裝
1、使用arthas-boot安裝
下載arthas-boot.jar,然后用java -jar的方式啟動:
wget https://alibaba.github.io/arthas/arthas-boot.jar java -jar arthas-boot.jar
打印幫助信息:
java -jar arthas-boot.jar -h
如果下載速度比較慢,可以使用aliyun的鏡像:
java -jar arthas-boot.jar --repo-mirror aliyun --use-http
2、使用as.sh安裝
Arthas 支持在 linux/Unix/mac 等平臺上一鍵安裝,請復制以下內容,并粘貼到命令行中,敲 回車 執行即可:
curl -L https://alibaba.github.io/arthas/install.sh | sh
上述命令會下載啟動腳本文件 as.sh 到當前目錄,你可以放在任何地方或將其加入到 $PATH 中。
直接在shell下面執行./as.sh,就會進入交互界面。
也可以執行./as.sh -h來獲取更多參數信息。
快速入門
1. 啟動Demo
wget https://alibaba.github.io/arthas/arthas-demo.jar java -jar arthas-demo.jar
arthas-demo是一個簡單的程序,每隔一秒生成一個隨機數,再執行質因式分解,并打印出分解結果。
2. 啟動arthas
在命令行下面執行:
wget https://alibaba.github.io/arthas/arthas-boot.jar java -jar arthas-boot.jar
-
執行該程序的用戶需要和目標進程具有相同的權限。比如以admin用戶來執行:sudo su admin && java -jar arthas-boot.jar 或 sudo -u admin -EH java -jar arthas-boot.jar。
-
如果attatch不上目標進程,可以查看~/logs/arthas/ 目錄下的日志。
-
如果下載速度比較慢,可以使用aliyun的鏡像:java -jar arthas-boot.jar --repo-mirror aliyun --use-http
-
java -jar arthas-boot.jar -h 打印更多參數信息。
選擇應用java進程:
$ $ java -jar arthas-boot.jar * [1]: 35542 [2]: 71560 arthas-demo.jar
Demo進程是第2個,則輸入2,再輸入回車/enter。Arthas會attach到目標進程上,并輸出日志:
[INFO] Try to attach process 71560 [INFO] Attach process 71560 success. [INFO] arthas-client connect 127.0.0.1 3658 ,---. ,------. ,--------.,--. ,--. ,---. ,---. / O | .--. ''--. .--'| '--' | / O ' .-' | .-. || '--'.' | | | .--. || .-. |`. `-. | | | || | | | | | | || | | |.-' | `--' `--'`--' '--' `--' `--' `--'`--' `--'`-----' wiki: https://alibaba.github.io/arthas version: 3.0.5.20181127201536 pid: 71560 time: 2018-11-28 19:16:24 $
3. 查看dashboard
輸入dashboard,按enter/回車,會展示當前進程的信息,按ctrl+c可以中斷執行。
$ dashboard ID NAME GROUP PRIORI STATE %CPU TIME INTERRU DAEMON 17 pool-2-thread-1 system 5 WAITIN 67 0:0 false false 27 Timer-for-arthas-dashb system 10 RUNNAB 32 0:0 false true 11 AsyncAppender-Worker-a system 9 WAITIN 0 0:0 false true 9 Attach Listener system 9 RUNNAB 0 0:0 false true 3 Finalizer system 8 WAITIN 0 0:0 false true 2 Reference Handler system 10 WAITIN 0 0:0 false true 4 Signal Dispatcher system 9 RUNNAB 0 0:0 false true 26 as-command-execute-dae system 10 TIMED_ 0 0:0 false true 13 job-timeout system 9 TIMED_ 0 0:0 false true 1 main main 5 TIMED_ 0 0:0 false false 14 nioEventLoopGroup-2-1 system 10 RUNNAB 0 0:0 false false 18 nioEventLoopGroup-2-2 system 10 RUNNAB 0 0:0 false false 23 nioEventLoopGroup-2-3 system 10 RUNNAB 0 0:0 false false 15 nioEventLoopGroup-3-1 system 10 RUNNAB 0 0:0 false false Memory used total max usage GC heap 32M 155M 1820M 1.77% gc.ps_scavenge.count 4 ps_eden_space 14M 65M 672M 2.21% gc.ps_scavenge.time(m 166 ps_survivor_space 4M 5M 5M s) ps_old_gen 12M 85M 1365M 0.91% gc.ps_marksweep.count 0 nonheap 20M 23M -1 gc.ps_marksweep.time( 0 code_cache 3M 5M 240M 1.32% ms) Runtime os.name Mac OS X os.version 10.13.4 java.version 1.8.0_162 java.home /Library/Java/JavaVir tualMachines/jdk1.8.0 _162.jdk/Contents/Hom e/jre
4. 通過sysenv命令來獲取到進程的Main Class
$ sysenv | grep MAIN JAVA_MAIN_CLASS_71560 demo.MathGame
5. 通過jad來反編繹Main Class
$ jad demo.MathGame ClassLoader: +-sun.misc.Launcher$AppClassLoader@3d4eac69 +-sun.misc.Launcher$ExtClassLoader@66350f69 Location: /tmp/arthas-demo.jar /* * Decompiled with CFR 0_132. */ package demo; import java.io.PrintStream; import java.util.ArrayList; import java.util.Iterator; import java.util.List; import java.util.Random; import java.util.concurrent.TimeUnit; public class MathGame { private static Random random = new Random; private int illegalArgumentCount = 0; public static void main(String[] args) throws InterruptedException { MathGame game = new MathGame; do { game.run; TimeUnit.SECONDS.sleep(1L); } while (true); } public void run throws InterruptedException { try { int number = random.nextInt; List<Integer> primeFactors = this.primeFactors(number); MathGame.print(number, primeFactors); } catch (Exception e) { System.out.println(String.format("illegalArgumentCount:%3d, ", this.illegalArgumentCount) + e.getMessage); } } public static void print(int number, List<Integer> primeFactors) { StringBuffer sb = new StringBuffer("" + number + "="); Iterator<Integer> iterator = primeFactors.iterator; while (iterator.hasNext) { int factor = iterator.next; sb.append(factor).append('*'); } if (sb.charAt(sb.length - 1) == '*') { sb.deleteCharAt(sb.length - 1); } System.out.println(sb); } public List<Integer> primeFactors(int number) { if (number < 2) { ++this.illegalArgumentCount; throw new IllegalArgumentException("number is: " + number + ", need >= 2"); } ArrayList<Integer> result = new ArrayList<Integer>; int i = 2; while (i <= number) { if (number % i == 0) { result.add(i); number /= i; i = 2; continue; } ++i; } return result; } } Affect(row-cnt:1) cost in 970 ms.
6. watch
通過watch命令來查看demo.MathGame#primeFactors函數的返回值:
$ watch demo.MathGame primeFactors returnObj Press Ctrl+C to abort. Affect(class-cnt:1 , method-cnt:1) cost in 107 ms. ts=2018-11-28 19:22:30; [cost=1.715367ms] result= ts=2018-11-28 19:22:31; [cost=0.185203ms] result= ts=2018-11-28 19:22:32; [cost=19.012416ms] result=@ArrayList[ @Integer[5], @Integer[47], @Integer[2675531], ] ts=2018-11-28 19:22:33; [cost=0.311395ms] result=@ArrayList[ @Integer[2], @Integer[5], @Integer[317], @Integer[503], @Integer[887], ] ts=2018-11-28 19:22:34; [cost=10.136007ms] result=@ArrayList[ @Integer[2], @Integer[2], @Integer[3], @Integer[3], @Integer[31], @Integer[717593], ] ts=2018-11-28 19:22:35; [cost=29.969732ms] result=@ArrayList[ @Integer[5], @Integer[29], @Integer[7651739], ]
5. 退出arthas
如果只是退出當前的連接,可以用quit或者exit命令。Attach到目標進程上的arthas還會繼續運行,端口會保持開放,下次連接時可以直接連接上。
如果想完全退出arthas,可以執行shutdown命令。
常用命令
基礎命令
-
help——查看命令幫助信息
-
cls——清空當前屏幕區域
-
session——查看當前會話的信息
-
reset——重置增強類,將被 Arthas 增強過的類全部還原,Arthas 服務端關閉時會重置所有增強過的類
-
version——輸出當前目標 Java 進程所加載的 Arthas 版本號
-
quit——退出當前 Arthas 客戶端,其他 Arthas 客戶端不受影響
-
shutdown——關閉 Arthas 服務端,所有 Arthas 客戶端全部退出
-
keymap——Arthas快捷鍵列表及自定義快捷鍵
jvm相關
-
dashboard——當前系統的實時數據面板
-
thread——查看當前 JVM 的線程堆棧信息
-
jvm——查看當前 JVM 的信息
-
sysprop——查看和修改JVM的系統屬性
-
New! getstatic——查看類的靜態屬性
class/classloader相關
-
sc——查看JVM已加載的類信息
-
sm——查看已加載類的方法信息
-
dump——dump 已加載類的 byte code 到特定目錄
-
redefine——加載外部的.class文件,redefine到JVM里
-
jad——反編譯指定已加載類的源碼
-
classloader——查看classloader的繼承樹,urls,類加載信息,使用classloader去getResource
monitor/watch/trace相關
-
monitor——方法執行監控
-
watch——方法執行數據觀測
-
trace——方法內部調用路徑,并輸出方法路徑上的每個節點上耗時
-
stack——輸出當前方法被調用的調用路徑
-
tt——方法執行數據的時空隧道,記錄下指定方法每次調用的入參和返回信息,并能對這些不同的時間下調用進行觀測
請注意,這些命令,都通過字節碼增強技術來實現的,會在指定類的方法中插入一些切面來實現數據統計和觀測,因此在線上、預發使用時,請盡量明確需要觀測的類、方法以及條件,診斷結束要執行 shutdown 或將增強過的類執行 reset 命令。
options
-
options——查看或設置Arthas全局開關
管道
Arthas支持使用管道對上述命令的結果進行進一步的處理,如sm org.Apache.log4j.Logger | grep
-
grep——搜索滿足條件的結果
-
plaintext——將命令的結果去除顏色
-
wc——按行統計輸出結果
以上,就是關于Arthas的簡單介紹,要想真正的融會貫通,真正的把他作為一個排查問題的利器,還需要自己動手實踐下!所謂實踐出真知。