聊聊部署在docker容器里面的springboot項目如何啟用arthas

前言

arthas是啥可能大家都知道了，為了湊字數，我把官方的介紹再抄一下

Arthas 是Alibaba開源的Java診斷工具，深受開發者喜愛。當你遇到以下類似問題而束手無策時，Arthas可以幫助你解決：

1. 這個類從哪個 jar 包加載的？為什么會報各種類相關的 Exception？
2. 我改的代碼為什么沒有執行到？難道是我沒 commit？分支搞錯了？
3. 遇到問題無法在線上 debug，難道只能通過加日志再重新發布嗎？
4. 線上遇到某個用戶的數據處理有問題，但線上同樣無法 debug，線下無法重現！
5. 是否有一個全局視角來查看系統的運行狀況？
6. 有什么辦法可以監控到JVM的實時運行狀態？
7. 怎么快速定位應用的熱點，生成火焰圖？

今天不詳細講如何使用arthas，因為之前有專門寫了一篇博文介紹過，感興趣的朋友可以查看如下鏈接

java應用線上診斷神器--Arthas

隨着容器化的火熱，可能有相當一部分的項目都是基於docker部署，今天主要就聊下運行在docker環境中的springboot項目，如何啟用arthas

docker環境中的springboot項目，如何啟用arthas

方案一、進入容器內部執行相應命令

 docker exec -it d2ce06ad8855 /bin/bash
 進入容器后，再運行
 curl -O https://arthas.aliyun.com/arthas-boot.jar
 java -jar arthas-boot.jar

這種方案的弊端在於容器銷毀后，下次運行容器后，要再次下載arthas-boot.jar

方案二、把arthas安裝到基礎鏡像

FROM openjdk:8-jdk-alpine
VOLUME /tmp
#ENV JAVA_OPTS="-Dcom.sun.management.jmxremote.port=39083 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false"
ENV JAVA_OPTS=""
COPY localtime /etc/localtime
RUN echo "Asia/Shanghai" > /etc/timezone
ONBUILD COPY app.jar app.jar

ARG ARTHAS_VERSION="3.5.0"
ARG MIRROR=false

ENV MAVEN_HOST=https://repo1.maven.org/maven2 \
    ALPINE_HOST=dl-cdn.alpinelinux.org \
    MIRROR_MAVEN_HOST=https://maven.aliyun.com/repository/public \
    MIRROR_ALPINE_HOST=mirrors.aliyun.com 

# if use mirror change to aliyun mirror site
RUN if $MIRROR; then MAVEN_HOST=${MIRROR_MAVEN_HOST} ;ALPINE_HOST=${MIRROR_ALPINE_HOST} ; sed -i "s/dl-cdn.alpinelinux.org/${ALPINE_HOST}/g" /etc/apk/repositories ; fi && \
    # https://github.com/docker-library/openjdk/issues/76
    apk add --no-cache tini && \ 
    # download & install arthas
    wget -qO /tmp/arthas.zip "${MAVEN_HOST}/com/taobao/arthas/arthas-packaging/${ARTHAS_VERSION}/arthas-packaging-${ARTHAS_VERSION}-bin.zip" && \
    mkdir -p /opt/arthas && \
    unzip /tmp/arthas.zip -d /opt/arthas && \
    rm /tmp/arthas.zip

ENTRYPOINT ["/sbin/tini", "--", "sh", "-c", "java $JAVA_OPTS -Djava.security.egd=file:/dev/./urandom -jar /app.jar" ]

方案三、使用arthas-spring-boot-starter

1、在項目的pom.xml引入

 <dependency>
            <groupId>com.taobao.arthas</groupId>
            <artifactId>arthas-spring-boot-starter</artifactId>
            <version>${arthas.version}</version>
        </dependency>

2、在yml進行配置

這邊配置又有兩種方式

• 2.1、配置arthas tunnel server實現遠程管理

注： 通過Arthas Tunnel Server/Client 來遠程管理/連接多個Agent

因此我們首先要先安裝Arthas Tunnel Server/Client

a、 下載部署arthas tunnel server

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

b、啟動arthas-tunnel-server

示例

java -jar  arthas-tunnel-server-3.5.0-fatjar.jar

注： 默認情況下，arthas tunnel server的web端口是8080，arthas agent連接的端口是7777

c、 在項目的yml做如下配置

arthas:
  agent-id: ${ARTHAS_AGENT_ID:hsehdfsfghhwertyfad}
  app-name: ${spring.application.name}
  tunnel-server: ${ARTHAS_TUNNEL_SERVER:ws://localhost:7777/ws}

注： agentId要保持唯一，否則會在tunnel server上沖突，不能正常工作

d、 效果演示

• 2.2、直接在項目的yml做如下配置

arthas:
 # 通過http訪問的端口
  http-port: 8563
  # 通過telnet訪問的端口
  telnet-port: 3658
  session-timeout: 1800
  # 綁定的ip
  ip: 0.0.0.0

注： 如果配置 arthas.telnetPort為 -1 ，則不監聽 telnet端口。如果配置 arthas.telnetPort為 0 ，則隨機telnet端口。arthas.httpPort類似

效果演示

• a、通過http訪問
  
• b、通過telnet訪問

arthas入門使用

核心思想通過help命令，先通過help了解一下arthas有啥命令

然后過help 你感興趣的命令，比如你對thread這個命令很感興趣，則在命令行輸入

help thread

示例演示，比如排查項目中是否存在死鎖

thread -b

我們也比較常用dashboard命令來查看cpu、gc等信息

dashboard

總結

arthas確實降低我們排查java問題的難度，但arthas的命令那么多，很多時候我們都記不住，就算能記，我也不會去記，我正常使用的套路是先help 命令，然后找到相應的示例，最后照貓畫虎。

如果使用http或者telnet的話，基於安全考量，那個ip最好是使用內網ip，不要像我示例直接0.0.0.0，我是為了演示方便。

demo鏈接

https://github.com/lyb-geek/springboot-learning/tree/master/springboot-arthas