arthas详细使用教程

天龙拳

已于 2023-12-17 11:59:50 修改

阅读量1.7k

点赞数 2

分类专栏： java 文章标签： java

于 2023-11-30 22:51:17 首次发布

本文链接：https://blog.csdn.net/ls18802694089/article/details/134678902

版权

java 专栏收录该内容

16 篇文章 0 订阅

订阅专栏

一、介绍

Arthas 是Alibaba开源的Java诊断工具。可实时查看应用 load、内存、gc、线程的状态信息，并能在不修改应用代码的情况下，对业务问题进行诊断，包括查看方法调用的出入参、异常，监测方法执行耗时，类加载信息等，大大提升线上问题排查效率。
Arthas 支持JDK 6+，支持Linux/Mac/Windows，采用命令行交互模式，同时提供丰富的 Tab 自动补全功能，进一步方便进行问题的定位和诊断。

二、解决的问题

1.这个类从哪个 jar 包加载的？为什么会报各种类相关的 Exception？
2.我改的代码为什么没有执行到？难道是我没 commit？分支搞错了？
3.遇到问题无法在线上 debug，难道只能通过加日志再重新发布吗？
4.线上遇到某个用户的数据处理有问题，但线上同样无法 debug，线下无法重现！
5.是否有一个全局视角来查看系统的运行状况？
6.有什么办法可以监控到JVM的实时运行状态？

三、下载安装

1.下载启动demo java程序
是一个简单的程序，每隔一秒生成一个随机数，再执行质因数分解，并打印出分解结果

curl -O https://arthas.aliyun.com/math-game.jar
java -jar math-game.jar

2.下载启动 arthas
在命令行下面执行（使用和目标进程一致的用户启动，否则可能 attach 失败）：

curl -O https://arthas.aliyun.com/arthas-boot.jar
java -jar arthas-boot.jar

执行该程序的用户需要和目标进程具有相同的权限。比如以admin用户来执行：sudo su admin && java -jar arthas-boot.jar 或 sudo -u admin -EH java -jar arthas-boot.jar。
如果 attach 不上目标进程，可以查看~/logs/arthas/ 目录下的日志。
如果下载速度比较慢，可以使用 aliyun 的镜像：java -jar arthas-boot.jar --repo-mirror aliyun --use-http
java -jar arthas-boot.jar -h 打印更多参数信息。

启动后会让我们选择java进程，如下

$ $ java -jar arthas-boot.jar
* [1]: 35542
  [2]: 71560 math-game.jar

如我们的demo 程序是2，则进程是第 2 个，则输入 2，再输入回车/enter。Arthas 会 attach 到目标进程上。

3.工具界面及介绍
输入dashboard，按回车/enter，会展示类似如下的进程信息，按ctrl+c可以中断执行
在这里插入图片描述

四、常用命令

1.常用命令

jvm相关：

dashboard - 当前系统的实时数据面板
getstatic - 查看类的静态属性
heapdump - dump java heap, 类似 jmap 命令的 heap dump 功能
jvm - 查看当前 JVM 的信息
logger - 查看和修改 logger
memory - 查看 JVM 的内存信息
ognl - 执行 ognl 表达式
perfcounter - 查看当前 JVM 的 Perf Counter 信息
sysenv - 查看 JVM 的环境变量
sysprop - 查看和修改 JVM 的系统属性
thread - 查看当前 JVM 的线程堆栈信息
vmoption - 查看和修改 JVM 里诊断相关的 option
vmtool - 从 jvm 里查询对象，执行 forceGc

class/classloader 相关：

classloader - 查看 classloader 的继承树，urls，类加载信息，使用 classloader 去 getResource
dump - dump 已加载类的 byte code 到特定目录
jad - 反编译指定已加载类的源码
mc - 内存编译器，内存编译.java文件为.class文件
redefine - 加载外部的.class文件，redefine 到 JVM 里
retransform - 加载外部的.class文件，retransform 到 JVM 里
sc - 查看 JVM 已加载的类信息
sm - 查看已加载类的方法信息

monitor/watch/trace 相关：
ps:请注意，这些命令，都通过字节码增强技术来实现的，会在指定类的方法中插入一些切面来实现数据统计和观测，因此在线上、预发使用时，请尽量明确需要观测的类、方法以及条件，诊断结束要执行 stop 或将增强过的类执行 reset 命令。

monitor - 方法执行监控
stack - 输出当前方法被调用的调用路径
trace - 方法内部调用路径，并输出方法路径上的每个节点上耗时
tt - 方法执行数据的时空隧道，记录下指定方法每次调用的入参和返回信息，并能对这些不同的时间下
watch - 方法执行数据观测

profiler/火焰图

profiler - 使用async-profiler对应用采样，生成火焰图
jfr - 动态开启关闭 JFR 记录

options - 查看或设置 Arthas 全局开关

options - 查看或设置 Arthas 全局开关

管道：

Arthas 支持使用管道对上述命令的结果进行进一步的处理，如sm java.lang.String * | grep 'index'
grep - 搜索满足条件的结果
plaintext - 将命令的结果去除 ANSI 颜色
wc - 按行统计输出结果

基础命令：

base64 - base64 编码转换，和 linux 里的 base64 命令类似
cat - 打印文件内容，和 linux 里的 cat 命令类似
cls - 清空当前屏幕区域
echo - 打印参数，和 linux 里的 echo 命令类似
grep - 匹配查找，和 linux 里的 grep 命令类似
help - 查看命令帮助信息
history - 打印命令历史
keymap - Arthas 快捷键列表及自定义快捷键
pwd - 返回当前的工作目录，和 linux 命令类似
quit - 退出当前 Arthas 客户端，其他 Arthas 客户端不受影响
reset - 重置增强类，将被 Arthas 增强过的类全部还原，Arthas 服务端关闭时会重置所有增强过的类
session - 查看当前会话的信息
stop - 关闭 Arthas 服务端，所有 Arthas 客户端全部退出
tee - 复制标准输入到标准输出和指定的文件，和 linux 里的 tee 命令类似
version - 输出当前目标 Java 进程所加载的 Arthas 版本号

2.一些常用具体命令的参数说明：

thread
在这里插入图片描述
thread -n 5：打印前5个最忙的线程并打印堆栈
thread -all ：显示所有匹配的线程
thread -n 3 -i 1000 ：列出1000ms内最忙的3个线程栈
thread –state WAITING，查看指定状态的线程,（TIMED_WAITI、WAITING、RUNNABLE等等）
thread -b：找出阻塞其他线程的线程,当出现死锁后，会提示你出现死锁的位置，代码如下

    static Object obj = new Object();
    public static void main(String[] args) throws InterruptedException, IOException {
        new Thread(new Runnable() {
            @Override
            public void run() {
                try {
                    synchronized (obj) {
                        System.out.println("我是第一个线程");
                        Thread.sleep(100000);
                    }
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }
            }
        },"yexindong-one").start();

        Thread.sleep(1000);
        new Thread(new Runnable() {
            @Override
            public void run() {
                synchronized (obj) {
                    System.out.println("我是第二个线程");
                }
            }
        },"yexindong-two").start();
    }

在这里插入图片描述

jad
这里的反编译用起来比较简单，只需要输入全类名即可反编译源码：jad com.test.Test，执行jad命令后还会打印出类加载器和class文件的所在目录；
除此之外jad还可以反编译类中的某个方法，下面的代码只编译main方法，并且不显示行号，lineNumber默认的值是true，现在我们把它设为false就不显示行号了；

jad com.test.Test main --lineNumber false

watch
watch命令可以让用户能方便的观察到指定方法的调用情况。能观察到的范围为：返回值、抛出异常、入参，通过编写 OGNL 表达式进行对应变量的查看。
1、以下命令用于观察方法出参和返回值，

watch com.test.Test show "{params,returnObj}" -x 2 -b -e -s -f

观察的方法为Test类下的show()方法，
"{params,returnObj}"是观察表达式，是一个ognl表达式，
-x 2是指定输出结果的属性遍历深度，默认值为1，为1时看不到参数的具体值，只能看到类型；
-b：在方法调用之前观察，用此命令可查看方法的入参
-e：在方法异常之后观察。用此命令可查看方法抛出的异常
-s：在方法返回之后观察，可查看方法的返回值
-f：在方法结束之后(正常返回和异常返回)观察，可查看方法的返回值和异常信息，默认打开-f
PS：更多的时候，是用于这个方法代码里面你没输出日志，临时看一下入参&返回结果定位问题。而不用重新去加日志打印的代码，重新发布应用。

trace
trace 命令能主动搜索方法调用路径，，并输出方法路径上的每个节点上耗时，渲染和统计整个调用链路上的所有性能开销和追踪调用链路。
监听Test类下show方法的调用链：trace com.test.Test show

[arthas@4805]$ trace com.test.Test show
Press Q or Ctrl+C to abort.
Affect(class count: 1 , method count: 1) cost in 28 ms, listenerId: 2
`---ts=2021-07-18 21:41:52;thread_name=main;id=1;is_daemon=false;priority=5;TCCL=sun.misc.Launcher$AppClassLoader@18b4aac2
    `---[0.884064ms] com.test.Test:show()
        `---[0.135646ms] com.test.Test:showChild() #38

通过结果可以看到，在main线程中show()方法调用了showChild()方法，前面的ms数是调用方法所花费的时间，

调用链属性说明

thread_name ：线程名称
id：内部线程id
is_daemon ：是否为守护线程
priority：线程优先级
TCCL：类加载器

五、Arthas 在 docker 容器中使用配置

1.在 Docker 里使用 JDK
很多时候，应用在 docker 里出现 arthas 无法工作的问题，是因为应用没有安装 JDK ，而是安装了 JRE 。如果只安装了 JRE，则会缺少很多 JAVA 的命令行工具和类库，Arthas 也没办法正常工作。下面介绍两种常见的在 Docker 里使用 JDK 的方式
2.使用公开的 JDK 镜像
https://hub.docker.com/_/openjdk/
比如：

FROM openjdk:8-jdk

或者

FROM openjdk:8-jdk-alpine

3.通过包管理软件来安装

# Install OpenJDK-8
RUN apt-get update && \
    apt-get install -y openjdk-8-jdk && \
    apt-get install -y ant && \
    apt-get clean;

# Fix certificate issues
RUN apt-get update && \
    apt-get install ca-certificates-java && \
    apt-get clean && \
    update-ca-certificates -f;

# Setup JAVA_HOME -- useful for docker commandline
ENV JAVA_HOME /usr/lib/jvm/java-8-openjdk-amd64/
RUN export JAVA_HOME

或者：

RUN yum install -y \
   java-1.8.0-openjdk \
   java-1.8.0-openjdk-devel

ENV JAVA_HOME /usr/lib/jvm/java-1.8.0-openjdk/
RUN export JAVA_HOME

4.通过 Docker 快速入门
删除本地已有的math-game docker container（非必要）

$ docker stop math-game || true && docker rm math-game || true

启动math-game

$ docker run --name math-game -it hengyunabc/arthas:latest /bin/sh -c "java -jar /opt/arthas/math-game.jar"

启动arthas-boot来进行诊断

$ docker exec -it math-game /bin/sh -c "java -jar /opt/arthas/arthas-boot.jar"
* [1]: 9 jar

[INFO] arthas home: /opt/arthas
[INFO] Try to attach process 9
[INFO] Attach process 9 success.
[INFO] arthas-client connect 127.0.0.1 3658
,---.  ,------. ,--------.,--.  ,--.  ,---.   ,---.
/  O  \ |  .--. ''--.  .--'|  '--'  | /  O  \ '   .-'
|  .-.  ||  '--'.'   |  |   |  .--.  ||  .-.  |`.  `-.
|  | |  ||  |\  \    |  |   |  |  |  ||  | |  |.-'    |
`--' `--'`--' '--'   `--'   `--'  `--'`--' `--'`-----'


wiki: https://arthas.aliyun.com/doc
version: 3.0.5
pid: 9
time: 2018-12-18 11:30:36

诊断 Docker 里的 Java 进程

docker exec -it  ${containerId} /bin/bash -c "wget https://arthas.aliyun.com/arthas-boot.jar && java -jar arthas-boot.jar"

诊断 k8s 里容器里的 Java 进程

kubectl exec -it ${pod} --container ${containerId} -- /bin/bash -c "wget https://arthas.aliyun.com/arthas-boot.jar && java -jar arthas-boot.jar"

把 Arthas 安装到基础镜像里

FROM openjdk:8-jdk-alpine

# copy arthas
COPY --from=hengyunabc/arthas:latest /opt/arthas /opt/arthas

参考资料：https://arthas.aliyun.com/
https://blog.csdn.net/qq_27184497/article/details/118875205

天龙拳

关注

2
点赞
踩
10

收藏

觉得还不错? 一键收藏
0
评论
arthas详细使用教程

Arthas 是Alibaba开源的Java诊断工具。可实时查看应用 load、内存、gc、线程的状态信息，并能在不修改应用代码的情况下，对业务问题进行诊断，包括查看方法调用的出入参、异常，监测方法执行耗时，类加载信息等，大大提升线上问题排查效率。Arthas 支持JDK 6+，支持Linux/Mac/Windows，采用命令行交互模式，同时提供丰富的 Tab 自动补全功能，进一步方便进行问题的定位和诊断。
复制链接

扫一扫