開源Java診斷工具Arthas:開篇之watch實戰

2023-08-22 06:00:32

一、前言

  • 還在為排查Java程式線上問題頭痛嗎,看我們用阿里開源的診斷神器 Arthas 來幫您
  • 本文開篇主要介紹 阿里開源的診斷神器Arthas 3.7.0版本,watch、jad、classloader 命令,以 Debian 11、openjdk 11 為例

二、Arthas 簡介和安裝

1. 簡介

  • Arthas 是一款線上監控診斷產品,通過全域性視角實時檢視應用 load、記憶體、gc、執行緒的狀態資訊
  • 並能在不修改應用程式碼的情況下,對業務問題進行診斷,包括檢視方法呼叫的出入參、異常
  • 監測方法執行耗時,類載入資訊等,大大提升線上問題排查效率。

2. 安裝和啟動

  • 執行該程式的使用者需要和目標程序具有相同的許可權,最好和目標程序的使用者一致
  • 啟動以後,輸入 數位 選擇要觀察的程序,也可增加 --select jar名稱 自動選擇程序,提高操作效率
  • 還可以在 末尾增加 程序號(啟動後也不用選擇程序了)
curl -O https://arthas.aliyun.com/arthas-boot.jar && java -jar arthas-boot.jar

三、watch命令

1. 基本用法

  • 觀察指定函數的呼叫情況,如 入參、返回值、丟擲異常,通過編寫 OGNL 表示式檢視
  • 命令格式:watch 類全名或類名錶示式 函數名錶示式 {觀察表示式} -x 輸出深度 -n 次數
  • 觀察表示式:預設 {params, target, returnObj},分別是 參數列、被觀察物件、返回值
  • -x 輸出深度:預設為 1,最大為 4。預設的 觀察表示式中 params + 輸出深度 1,只能輸出 params 是否 empty,size 是 幾,要看到內容就要加大 輸出深度 或 改為 params[0]
  • 很多時候,我們都不關注 被觀察物件 target,指定 觀察表示式 可以降低干擾,尤其是 屬性多 或 輸出深度大的時候
  • 觀察執行頻繁的方法,最好指定 -n 次數,避免刷屏

2. 只想看滿足條件的

  • 如 測試環境 同時有其他人存取,只想看到自己的請求
  • 命令格式:watch 類全名或類名錶示式 函數名錶示式 {觀察表示式} '條件' -x 輸出深度 -n 次數

3. 只想看耗時長的

  • 命令格式:條件 替換為 #cost>毫秒數

4. 過載方法

  • 過載方法,可通過引數 個數、型別 篩選
  • 命令格式:watch 類全名或類名錶示式 函數名錶示式 {觀察表示式} 'params.length== 引數個數 && params[0] instanceof java.lang.String

5. 實現類 和 代理類 輸出2次

  • 增加引數,非代理類才輸出: --exclude-class-pattern *Enhance*
  • 不匹配子類:options disable-sub-class true

6. 匹配類數量超限(預設50個)

  • 錯誤資訊:The number of matched classes is 1501, greater than the limit value 50
  • 增加引數 -m 數量,指定 Class 最大匹配數量,預設值為 50,注意值小於實際類匹配數時報錯,也就是說 只能大於等於 類匹配數
  • 類名錶示式 包含 * 導致匹配類太多的,建議把 類名錶示式 寫的更精確
  • 子類太多:試試用 子類全名 + 方法,或 不匹配子類:options disable-sub-class true,或 提高匹配類數量 -m 2000

7. 觀察異常

  • 4 個觀察事件點,即 -b 函數呼叫前,-e 函數異常後,-s 函數返回後,-f 函數結束後(預設)
  • 命令格式:watch 類全名或類名錶示式 函數名錶示式 {throwExp} -e

8. 觀察函數呼叫前的入參

  • 這種情況比較少,一般是 入參、出參 是同一個 集合 或 物件,方法中修改了 內容
  • 命令格式:watch 類全名或類名錶示式 函數名錶示式 {觀察表示式} -b,觀察表示式 中 returnObj 是 null 哦,因為還沒執行完返回

四、拓展

1. 懷疑程式碼不一致,jad 反編譯 確認一下吧

  • 命令格式:jad 類全名或類名錶示式 函數名錶示式,方法名 是 可選的(程式碼行數多的類建議加 方法名,避免刷屏),不傳就反編譯整個類
  • 只顯示原始碼,不顯示 ClassLoader、Location:--source-only
  • 不顯示行號:--lineNumber false

2. 啥,jad 找不到類

  • 有一次,發版發了幾次都看不到效果,原來是 發錯服務了,囧,誰讓服務名稱字首是一樣的呢,只能怪自己了
  • 手動要載入也是可以的,classloader | arthas (aliyun.com),需指定 classLoader,如下範例
  • classloader --classLoaderClass org.springframework.boot.loader.LaunchedURLClassLoader --load java.lang.String

五、總結

  • Arthas 可以幫我們診斷不少線上問題,如 檢視方法呼叫的出入參、異常,監測方法執行耗時,類載入資訊等,大大提升線上問題排查效率。
  • FAQ | arthas (aliyun.com)
  • 後記:想當年還用過 阿里大神開源的 greys,一轉眼用 Arthas 也幾年了,而 Arthas 也是基於 greys 開發的

本文遵守【CC BY-NC】協定,轉載請保留原文出處及本版權宣告,否則將追究法律責任。
本文首先發佈於 https://www.890808.xyz/ ,其他平臺需要稽核更新慢一些。