天天看點

Arthas 開源一周年,GitHub Star 16 K ,我們一直在堅持什麼?

緣起

最近看到一個很流行的标題,《開源XX年,star XXX,我是如何堅持的》。

看到這樣的标題,忽然發覺 Arthas 從 2018 年 9 月開源以來,剛好一年了,正好在這個秋高氣爽的時節做下總結和回顧。

Arthas 開源一周年,GitHub Star 16 K ,我們一直在堅持什麼?

Arthas 是 Alibaba 開源的 Java 診斷工具,深受開發者喜愛。

Github:

https://github.com/alibaba/arthas[1]

文檔:

https://alibaba.github.io/arthas[2]

回顧 Arthas Star 數的曆史,一直保持快速增長,目前已經突破 16 K。

Arthas 開源一周年,GitHub Star 16 K ,我們一直在堅持什麼?

Arthas Github Star曆史曲線

感謝使用者的支援,既是壓力也是動力。在過去開源的一年裡, Arthas 釋出了 7 個 Release 版本,我們一直堅持三點:

  • 持續改進易用性
  • 持續增加好用的指令
  • 從開源社群中擷取力量,回報社群

Arthas 一直把易用性放在第一位,在開源之後,我們做了下面的改進:

  • 開發 arthas boot ,支援 Windows/Linux/Mac 統一體驗
  • 絲滑的自動補全,參考了 jshell 的體驗
  • 高效的曆史指令比對, Up/Down 直達
  • 改進類搜尋比對功能,更好支援 lambda 和内部類
  • 完善重定向機制
  • 支援 JDK 9/10/11
  • 支援 Docker
  • 支援 rpm/deb 包安裝

盡管我們在易用性下了很大的功夫,但是發現很多時候使用者比較難入門,是以,我們參考了 k8s 的 Interactive Tutorial ,推出了 Arthas 的線上教程:

  • Arthas 基礎教程[3]
  • Arthas 進階教程[4]

通過基礎教程,可以在互動終端裡一步步入門,通過進階教程可以深入了解 Arthas 排查問題的案例。

另外,為了友善使用者大規模部署,我們實作了 tunnel server 和使用者資料回報功能:

增加 tunnel server ,統一管理 Agent 連接配接

增加使用者資料回報功能,友善做安全管控

Arthas 号稱是 Java 應用診斷利器,那麼我們自己要對得起這個口号。在開源之後, Arthas 持續增加了 10 多個指令。

  • ognl 指令任意代碼執行
  • mc 線上記憶體編譯器
  • redefine 指令線上熱更新代碼
  • logger 指令一鍵檢視應用裡的所有 logger 配置
  • sysprop 檢視更新 System Properties
  • sysenv 檢視環境變量
  • vmoption 檢視更新 VM option
  • logger 檢視 logger 配置,更新 level
  • mbean 檢視 JMX 資訊
  • heapdump 堆記憶體快照

下面重點介紹兩個功能。

jad/mc/redefine 一條龍熱更新線上代碼

以 Arthas 線上教程 裡的 UserController 為例:

1、使用 jad 反編譯代碼

jad --source-only com.example.demo.arthas.user.UserController > /tmp/UserController.java           

2、使用 vim 編譯代碼

當 user id 小于 1 時,也正常傳回,不抛出異常:

@GetMapping("/user/{id}")
    public User findUserById(@PathVariable Integer id) {
        logger.info("id: {}" , id);

        if (id != null && id < 1) {
            return new User(id, "name" + id);
            // throw new IllegalArgumentException("id < 1");
        } else {
            return new User(id, "name" + id);
        }
    }           

3、使用 mc 指令編譯修改後的 UserController.java

$ mc /tmp/UserController.java -d /tmp
Memory compiler output:
/tmp/com/example/demo/arthas/user/UserController.class
Affect(row-cnt:1) cost in 346 ms           

4、使用 redefine 指令,因為可以熱更新代碼

$ redefine /tmp/com/example/demo/arthas/user/UserController.class
redefine success, size: 1           

通過 logger 指令檢視配置,修改 level

在網站壓力大的時候(比如雙 11 ),有個緩解措施就是把應用的日志 level 修改為 ERROR 。那麼有兩個問題:

  • 複雜應用的日志系統可能會有多個,那麼哪個日志系統配置真正生效了?
  • 怎樣線上上動态修改 logger 的 level ?

    通過 logger 指令,可以檢視應用裡 logger 的詳細配置資訊,比如 FileAppender輸出的檔案, AsyncAppender 是否 blocking 。

[arthas@2062]$ logger
 name                                   ROOT
 class                                  ch.qos.logback.classic.Logger
 classLoader                            sun.misc.Launcher$AppClassLoader@2a139a55
 classLoaderHash                        2a139a55
 level                                  INFO
 effectiveLevel                         INFO
 additivity                             true
 codeSource                             file:/Users/hengyunabc/.m2/repository/ch/qos/logback/logback-classic/1.2.3/logback-classic-1.2.3.jar
 appenders                              name            CONSOLE
                                        class           ch.qos.logback.core.ConsoleAppender
                                        classLoader     sun.misc.Launcher$AppClassLoader@2a139a55
                                        classLoaderHash 2a139a55
                                        target          System.out
                                        name            APPLICATION
                                        class           ch.qos.logback.core.rolling.RollingFileAppender
                                        classLoader     sun.misc.Launcher$AppClassLoader@2a139a55
                                        classLoaderHash 2a139a55
                                        file            app.log
                                        name            ASYNC
                                        class           ch.qos.logback.classic.AsyncAppender
                                        classLoader     sun.misc.Launcher$AppClassLoader@2a139a55
                                        classLoaderHash 2a139a55
                                        blocking        false
                                        appenderRef     [APPLICATION]
           

也可以線上修改 logger 的 level :

[arthas@2062]$ logger --name ROOT --level debug
update logger level success.           

感謝 67 位 Contributors

Arthas 開源以來,一共有 67 位 Contributors ,感謝他們貢獻的改進:

Arthas Contributors

社群送出了一系列的改進,下面列出一些點(不完整):

  • 翻譯了大部分英文文檔的
  • trace 指令支援行号
  • 打包格式支援 rpm/deb
  • 改進指令行提示符為 arthas@pid
  • 改進對 windows 的支援
  • 增加 mbean 指令
  • 改進 webconsole 的體驗

另外,有 83 個公司/組織登記了他們的使用資訊,歡迎更多的使用者來登記:

Arthas 開源一周年,GitHub Star 16 K ,我們一直在堅持什麼?

洐生項目

基于 Arthas ,還産生了一些洐生項目,下面是其中兩個:

  • Bistoury : 去哪兒網開源的內建了 Arthas 的項目
  • arthas-mvel : 一個使用 MVEL 腳本的 fork

使用者案例分享

廣大使用者在使用 Arthas 排查問題過程中,分享了很多排查過程和心得,歡迎大家來分享。

Arthas 開源一周年,GitHub Star 16 K ,我們一直在堅持什麼?

回饋開源

Arthas 本身使用了很多開源項目的代碼,在開源過程中,我們給 netty, ognl, cfr 等都貢獻了改進代碼,回饋上遊。

後記

在做 Arthas 宣傳小冊子時, Arthas 的宣傳語是:

“贈人玫瑰之手,經久猶有餘香”

希望 Arthas 未來能幫助到更多的使用者解決問題,也希望廣大的開發者對 Arthas 提出更多的改進和建議。

參考資料

[1]Arthas Github:

https://github.com/alibaba/arthas

[2]Arthas 文檔:

https://alibaba.github.io/arthas

[3]Arthas基礎教程:

https://alibaba.github.io/arthas/arthas-tutorials?language=cn&id=arthas-basics

[4]Arthas進階教程:

https://alibaba.github.io/arthas/arthas-tutorials?language=cn&id=arthas-advanced