如何在Docker容器中使用Arthas

Arthas(阿尔萨斯) 能为你做什么?

Arthas 是Alibaba开源的Java诊断工具,深受开发者喜爱。

当你遇到以下类似问题而束手无策时,Arthas可以帮助你解决:

  1. 这个类从哪个 jar 包加载的?为什么会报各种类相关的 Exception?
  2. 我改的代码为什么没有执行到?难道是我没 commit?分支搞错了?
  3. 遇到问题无法在线上 debug,难道只能通过加日志再重新发布吗?
  4. 线上遇到某个用户的数据处理有问题,但线上同样无法 debug,线下无法重现!
  5. 是否有一个全局视角来查看系统的运行状况?
  6. 有什么办法可以监控到JVM的实时运行状态?
  7. 怎么快速定位应用的热点,生成火焰图?
  8. 怎样直接从JVM内查找某个类的实例?

Arthas支持JDK 6+,支持Linux/Mac/Windows,采用命令行交互模式,同时提供丰富的 Tab 自动补全功能,进一步方便进行问题的定位和诊断。

具体内容请查看官方文档,各个命令有详细的说明: //arthas.aliyun.com/doc/

本文不是介绍arthas怎么用的。这里要说的是,如何在我们的docker容器中,使用arthas。

鉴于我们在docker容器中使用arthas十分复杂,需要找到容器id,需要复制整个arthas目录到容器中,需要进入容器,需要切换到目标服务的用户,需要启动arthas,这些步骤对于很多对linux命令和docker命令不熟悉的同学并不友好。

因此我写了个脚本,可以直接替代以上步骤,使用方法如下图所示:

直接在脚本后,输入完整的服务名(这里取的是容器的IMAGE名称),即可使用,简单便捷。

使用方法:

  1. 首先需要在linux服务器上解压arhas-bin.zip,解压出来即是arthas软件。确保本机已安装docker

下载目录://github.com/alibaba/arthas/releases

  1. 将arthasDocker.sh脚本,放到刚才解压的arthas目录中,打开脚本,编辑ARTHAS_PATH变量,改为你arthas放置的目录。

arthasDocker.sh脚本内容:

#!/bin/bash
#
# author: 刘力源
# date: 2020-8-20 18:14:38
# desc: 本脚本需要放到arthas的目录中,连同整个目录一起复制到docker容器中去。主要用途为在容器中切换目标服务的用户,并启动arthas

echo "开始查询目标服务的进程id和用户..."
PID=`ps -eo pid,user=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa -o args | grep java | grep -v grep | awk '{print $1}'`
echo "目标服务的进程id为${PID}"
USER=`ps -eo pid,user=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa -o args | grep java | grep -v grep | awk '{print $2}'`
echo "目标服务的用户为${USER}"

if [[ ! -d "/home/${USER}" ]]
then
  mkdir -p /home/${USER}
  echo "创建目录/home/${USER}"
fi
chmod 777 /home/${USER}

echo "开始切换用户并启动arthas..."
# 下面的arthas路径需要修改,并且要和startArthas.sh脚本中保持一致
ARTHAS_PATH="/opt/arthas"
su ${USER} -c "java -jar ${ARTHAS_PATH}/arthas-client.jar 127.0.0.1 3658 -c 'stop'"
su ${USER} -c "java -jar ${ARTHAS_PATH}/arthas-boot.jar ${PID}"
  1. 将startArthas.sh脚本,放到linux服务器上,建议放到~目录下,打开脚本,编辑ARTHAS_PATH变量,改为你arthas放置的目录。然后赋予脚本执行权限

startArthas.sh脚本内容:

#! /bin/bash
#
# author: 刘力源
# date: 2020-9-18 10:36:27
# desc: 本脚本主要用途为启动arthas诊断工具来诊断某个docker中java服务

if [[ ${1} == '' ]]
then
  echo "请选择一个服务:"
  sudo docker ps | awk 'NR>1 {print $2}'
  exit 0
fi

echo "开始寻找服务${1}的容器..."
DOCKER_LIST=`sudo docker ps | awk 'NR>1 {print $2}'`
FLAG=0
for i in ${DOCKER_LIST[@]}
do
  if [[ ${i} == ${1} ]]
  then
    FLAG=1
    break
  fi
done

if [[ ${FLAG} == 0 ]]
then
  DOCKER_NAME=`sudo docker ps | awk 'NR>1 {print $2}' | grep ${1}`
  if [[ ${DOCKER_NAME} == '' ]]
  then
    echo "未找到该服务的容器,请重新选择服务:"
    sudo docker ps | awk 'NR>1 {print $2}'
  else
    echo "请输入服务的完整名称:"
    sudo docker ps | awk 'NR>1 {print $2}' | grep ${1}
  fi

else
  ID=`sudo docker ps --filter ancestor=${1} | awk '{print $1}' | sed -n '2p'`
  echo "找到容器${ID}"

  echo "开始复制arthas到容器中..."
  # 下面的arthas路径需要修改,并且要和arthasDocker.sh脚本中保持一致
  ARTHAS_PATH="/opt/arthas"
  sudo docker exec -it ${ID} /bin/bash -c "rm -rf ${ARTHAS_PATH}"
  sudo docker cp ${ARTHAS_PATH} ${ID}:${ARTHAS_PATH}
  echo "复制完成"

  echo "即将进入容器中..."
  sudo docker exec -it ${ID} /bin/bash -c "bash ${ARTHAS_PATH}/arthasDocker.sh"
fi
  1. 最后直接运行 startArthas.sh 脚本就可以了