不會(huì)還有人不知道 Arthas 可以條件過(guò)濾進(jìn)行 Watch 吧？

作者：kiritomoe 2021-08-08 21:53:40

Arthas 的 watch 指令一直是我排查線上問(wèn)題時(shí)使用最多的指令，沒(méi)有之一。而按照條件進(jìn)行 watch 也是很常見(jiàn)的一個(gè)需求，例如線上一個(gè)方法會(huì)有大量的調(diào)用，而我們可以按照指定的條件，watch 到我們希望觀察的那一次調(diào)用。

[[416078]]

前言

說(shuō)實(shí)話，我對(duì) Arthas 也沒(méi)有什么研究，一開(kāi)始還真不清楚原來(lái) Arthas watch 可以按條件過(guò)濾，翻看一下官方文檔：https://arthas.aliyun.com/doc/watch#id6

條件表達(dá)式的例子

$ watch demo.MathGame primeFactors "{params[0],target}" "params[0]<0" 
Press Ctrl+C to abort. 
Affect(class-cnt:1 , method-cnt:1) cost in 68 ms. 
ts=2018-12-03 19:36:04; [cost=0.530255ms] result=@ArrayList[ 
    @Integer[-18178089], 
    @MathGame[demo.MathGame@41cf53f9], 
]

喏，這不是這么明顯的例子嗎?但是上面的例子，貌似只給出了一些簡(jiǎn)單的訊息

可以直接用 watch 命令的參數(shù)項(xiàng)中增加條件表達(dá)式進(jìn)行過(guò)濾
可以進(jìn)行數(shù)值類型的過(guò)濾

但是，這個(gè)簡(jiǎn)單的示例，并沒(méi)有解答我內(nèi)心其他的疑惑：

我可以進(jìn)行字符串、集合等復(fù)雜類型的判斷嗎?
這個(gè)表達(dá)式是 el、ognl 或者其他類型的表達(dá)式嗎?

帶著這些疑問(wèn)，我記錄下了這篇文章，給不了解 Arthas watch 條件表達(dá)式的讀者們一些參考。

一些條件表達(dá)式的示例

有一些讀者可能僅僅是想知道“我該怎么實(shí)現(xiàn)使用 Arthas 條件 Watch”，為此，我在本文的第二節(jié)先介紹下我平時(shí)積累的一些實(shí)踐命令。

示例方法

public void methodForWatch(int id, User user) { 
}

User 結(jié)構(gòu)

@Data 
public class User { 
    private String name; 
    private int age; 
    private List<String> hobbies; 
}

另外準(zhǔn)備一些請(qǐng)求，我會(huì)在每個(gè)示例中執(zhí)行相同的調(diào)用。示例請(qǐng)求：

1, new User("hanmeimei", 16, Arrays.asList("pubg", "lol")); 
2, new User("liming", 17, Collections.singletonList("pubg")); 
3, new User("tom", 18, Collections.singletonList("running")); 
4, new User("jacky", 19, Collections.singletonList("food"));

示例 1：過(guò)濾 int 類型;過(guò)濾 id > 0 的請(qǐng)求

這其實(shí)就是官方的示例，我拿過(guò)來(lái)再貼一遍

watch moe.cnkirito.arthas.WatchDemo methodForWatch "{params,returnObj}" "params[0]>0" -x 2

示例 2：過(guò)濾對(duì)象中的字符串類型;過(guò)濾 User 中 name = haimeimei 的請(qǐng)求

watch moe.cnkirito.arthas.WatchDemo methodForWatch "{params,returnObj}" "params[1].getName().equals('liming')" -x 2

這里有三個(gè)注意點(diǎn)

使用 params[1] 這種數(shù)組訪問(wèn)的方式，對(duì)應(yīng)到 methodForWatch 方法的第二個(gè)參數(shù) User user
使用 getName() 這種方法調(diào)用的方式拿到 name 字段，并且使用 String 的 equals 方法進(jìn)行字符串比對(duì)
由于 condition 表達(dá)式整體使用了雙引號(hào) ""，在 hanmeimei 該字面量上需要使用單引號(hào) ''

示例 3：過(guò)濾集合中的元素;過(guò)濾對(duì) pubg 感興趣的 User 相關(guān)的請(qǐng)求

watch moe.cnkirito.arthas.WatchDemo methodForWatch {params,returnObj} "params[1].getHobbies().contains('pubg')" -x 2

示例 4：多個(gè)條件表達(dá)式

增加請(qǐng)求示例

5, new User("kirito", 20, null);

按照示例 3 的 watch 語(yǔ)句執(zhí)行，會(huì)發(fā)現(xiàn) Arthas 直接拋了一個(gè)空指針：

watch failed, condition is: params[1].getHobbies().contains('pubg'), express is: {params,returnObj}, java.lang.NullPointerException: target is null for method contains, visit /Users/xujingfeng/logs/arthas/arthas.log for more details.

需要增加空指針的判斷：

watch moe.cnkirito.actuator.demo.HelloController methodForWatch {params,returnObj} "params[1].getHobbies() != null && params[1].getHobbies().contains('pubg')" -x 2

吶，很簡(jiǎn)單，可以直接使用 && 增加判斷條件。

ognl 實(shí)現(xiàn)條件過(guò)濾

可能有人要說(shuō)了，Kirito 啊!你的公眾號(hào)最近是不是廣告發(fā)的太多了，深感愧疚，寫了一篇沒(méi)啥深度的原創(chuàng)文章來(lái)充數(shù)啊!那我當(dāng)然要反駁啦，其實(shí)我看 Arthas 文檔的時(shí)候也是踩了坑的，索性我將這個(gè)過(guò)程也分享一下。

可能大家看了上面的示例會(huì)覺(jué)得這個(gè) condition 表達(dá)式不就是跟 Java 里面的表達(dá)式差不多嗎?但其實(shí)我作為一個(gè)不太了解 Arthas 的弱雞，上面的用法純粹是我摸索出來(lái)的，在最開(kāi)始的時(shí)候，參考 github 中的 issue，我使用的其實(shí)是其他的方式來(lái)實(shí)現(xiàn)的條件查詢，參考 issue：https://github.com/alibaba/arthas/issues/71。

看下 github 中的 Arthas 開(kāi)源作者提供的按條件過(guò)濾的示例，可以發(fā)現(xiàn)跟上文中我介紹的過(guò)濾方式好像，有那么一點(diǎn)點(diǎn)的不同。注意上文的示例

$ watch demo.MathGame primeFactors "{params[0],target}" "params[0]<0"

watch 后的參數(shù)是由 4 部分組成的，分別是類名表達(dá)式，方法名表達(dá)式，觀察表達(dá)式，條件表達(dá)式。

而 issue 中給出的表達(dá)式

$ watch com.taobao.container.Test test "params[0].{? #this.name == null }" -x 2

沒(méi)有第四部分：條件表達(dá)式。過(guò)濾條件被放到了觀察表達(dá)式的對(duì)象后，并且不是 Java 里面的表達(dá)式，而是 ognl 表達(dá)式。

ognl 表達(dá)式官方參考文檔：https://commons.apache.org/proper/commons-ognl/language-guide.html

例如使用 ognl 表達(dá)式實(shí)現(xiàn)上面的示例 2，需要這么寫

示例 5：使用 ognl 表達(dá)式過(guò)濾對(duì)象中的字符串類型;過(guò)濾 User 中 name = haimeimei 的請(qǐng)求

watch moe.cnkirito.actuator.demo.HelloController methodForWatch "params[1].{? #this.name == 'hanmeimei'}" -x 2

示例 2 和示例 5 的對(duì)比

聊到這里，如果你對(duì) Arthas 比較熟悉，應(yīng)該已經(jīng)意識(shí)到示例 5 ognl 過(guò)濾和示例 2 直接使用條件過(guò)濾表達(dá)式的區(qū)別了。ognl 這種過(guò)濾的方式，是針對(duì)對(duì)象的屬性的過(guò)濾，無(wú)論是否匹配，都會(huì)被算進(jìn) watch 的匹配次數(shù)中，只不過(guò)沒(méi)有匹配到的對(duì)象沒(méi)有輸出;而示例 2 中直接使用條件過(guò)濾表達(dá)式這種方式，更匹配我文首提出的需求，只有被條件表示式命中的請(qǐng)求，才會(huì)被算進(jìn) watch 次數(shù)中。你可以使用 -n 1 來(lái)限定 watch 匹配次數(shù)，直觀地觀察到這兩個(gè)匹配方式的差異。