自帶IDEA插件的阿裡開源診斷神器Arthas線上項目BUG調試

Posted on 2022-06-21 by WalkonNet

前言

記得之前寫過一篇Arthas使用教程，通過使用Arthas我們既可以實現線上調試，還可以實現熱修復。最近逛瞭下Arthas的官網，發現它已經支持直接集成到SpringBoot應用中去，並且還出瞭專用的IDEA插件。今天我們再來體驗下它，看看它的功能是不是更強大瞭！

SpringBoot實戰電商項目mall（50k+star）地址：https://github.com/macrozheng/mall

Arthas簡介

Arthas是Alibaba開源的Java診斷利器，深受開發者喜愛，目前在Github上已有29K+Star。它采用命令行交互模式，同時提供豐富的 Tab 自動補全功能，進一步方便進行問題的定位和診斷。

ArthasTunnel

為瞭演示一個更加真實的線上環境，接下來我們將對Docker容器中的SpringBoot應用進行診斷。我們將使用ArthasTunnel來實現，ArthasTunnel相當於一個Web控制臺，使用它我們無需進入應用容器即可對應用進行診斷，非常方便。

首先我們需要下載ArthasTunnel的安裝包，下載地址：

https://github.com/alibaba/arthas/releases

由於官方隻提供瞭JAR包，如果你想通過Docker方式啟動的話，可以自行打包Docker鏡像，打包使用的Dockerfile腳本如下：

# 該鏡像需要依賴的基礎鏡像
FROM java:8
# 將當前目錄下的jar包復制到docker容器的/目錄下
ADD arthas-tunnel-server.jar /arthas-tunnel-server.jar
# 聲明服務運行的端口
EXPOSE 8080 7777
# 指定docker容器啟動時運行jar包
ENTRYPOINT ["java", "-jar","/arthas-tunnel-server.jar"]
# 指定維護者的名字
MAINTAINER macro

這裡再提供一個一鍵打包運行ArthasTunnel容器的執行腳本run.sh，腳本內容如下；

#!/usr/bin/env bash
# 定義應用組名
group_name='mall-tiny'
# 定義應用名稱
app_name='arthas-tunnel-server'
# 定義應用版本
app_version='1.0-SNAPSHOT'
echo '----copy jar----'
docker stop ${app_name}
echo '----stop container----'
docker rm ${app_name}
echo '----rm container----'
docker rmi ${group_name}/${app_name}:${app_version}
echo '----rm image----'
# 打包編譯docker鏡像
docker build -t ${group_name}/${app_name}:${app_version} .
echo '----build image----'
docker run -p 8080:8080 -p 7777:7777 --name ${app_name} \
-e TZ="Asia/Shanghai" \
-v /etc/localtime:/etc/localtime \
-v /mydata/app/${app_name}/logs:/var/logs \
-d ${group_name}/${app_name}:${app_version}
echo '----start container----'

接下來吧ArthasTunnel的JAR包、Dockerfile文件、執行腳本run.sh上傳到Linux服務器上，然後使用./run.sh命令運行即可；

運行成功後，可以直接訪問ArthasTunnel的Web控制臺，訪問地址：http://192.168.3.105:8080

SpringBoot集成

在SpringBoot應用中直接集成Arthas並使用，無疑是最方便的，接下來我們將采用此種方法。

首先在項目的pom.xml中添加如下依賴，可以對比下Arthas使用教程中的使用方法，直接集成確實簡單不少；

<!--集成Java診斷利器Arthas-->
<dependency>
    <groupId>com.taobao.arthas</groupId>
    <artifactId>arthas-spring-boot-starter</artifactId>
    <version>3.6.1</version>
</dependency>

然後修改配置文件application.yml，記住這個agent-id，ArthasTunnel連接需要使用，由於我們將會把應用容器通過--link的方式連接到ArthasTunnel容器，這裡的tunnel-server按下面進行配置；

management:
  endpoints:
    web:
      exposure:
        # 暴露端點`/actuator/arthas`
        include: 'arthas'
arthas:
  agent-id: mall-tiny-arthas
  tunnel-server: ws://arthas-tunnel-server:7777/ws

接下來通過之前的Dockerfile和run.sh打包應用，run.sh與之前對比，隻多瞭一行通過--link連接到ArthasTunnel容器的命令；