Arthas 命令 - 技术栈

文章目录

- 安装
- 常用命令
- - [jvm 相关](#jvm 相关)
  - [class/classloader 相关](#class/classloader 相关)
  - [monitor/watch/trace 相关](#monitor/watch/trace 相关)
  - profiler/火焰图
  - 鉴权
  - options
  - 管道
  - 后台异步任务
  - 基础命令
  - [Arthas 实践](#Arthas 实践)

安装

Arthas 是阿里巴巴开源的一款 Java 诊断工具，能够帮助开发者快速定位和解决 Java 应用中的问题。

bash 复制代码

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

常用命令

https://arthas.aliyun.com/doc/commands.html

jvm 相关

bash 复制代码

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

class/classloader 相关

bash 复制代码

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 相关

注意

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

bash 复制代码

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

profiler/火焰图

profiler - 使用async-profiler对应用采样，生成火焰图

jfr - 动态开启关闭 JFR 记录

鉴权

bash 复制代码

auth - 鉴权

options

bash 复制代码

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

管道

Arthas 支持使用管道对上述命令的结果进行进一步的处理，如sm java.lang.String * | grep 'index'

bash 复制代码

grep - 搜索满足条件的结果
plaintext - 将命令的结果去除 ANSI 颜色
wc - 按行统计输出结果

后台异步任务

当线上出现偶发的问题，比如需要 watch 某个条件，而这个条件一天可能才会出现一次时，异步后台任务就派上用场了，详情请参考这里

使用 > 将结果重写向到日志文件，使用 & 指定命令是后台运行，session 断开不影响任务执行（生命周期默认为 1 天）

bash 复制代码

jobs - 列出所有 job
kill - 强制终止任务
fg - 将暂停的任务拉到前台执行
bg - 将暂停的任务放到后台执行

基础命令

bash 复制代码

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 版本号

Arthas 实践

bash 复制代码

# 启动后，Arthas 会列出当前运行的 Java 进程，你可以选择要诊断的进程。÷
java -jar arthas-boot.jar
# 使用 `help` 命令可以查看所有可用的命令及其说明。
help
# 输入dashboard，按回车/enter，会展示当前进程的信息，按ctrl+c可以中断执行。
dashboard
#使用 `sc` 命令可以查看类的加载信息。
sc com.example.MyClass
#使用 `sm` 命令可以查看类的方法信息。
sm com.example.MyClass
#使用 `jad` 命令可以反编译指定的类。
jad com.example.MyClass
#使用 `watch` 命令可以监控方法的执行情况，包括参数、返回值、异常等。
watch com.example.MyClass myMethod "{params, returnObj, throwExp}" -x 2
#使用 `thread` 命令可以查看线程的信息。
thread
#使用 `thread -b` 命令可以查看线程的堆栈信息。
thread -b
#使用 `jvm` 命令可以查看 JVM 的信息。
jvm
#使用 `sysprop` 命令可以查看系统的属性。
sysprop
#使用 `sysenv` 命令可以查看环境变量。
sysenv
#使用 `quit` 或 `exit` 命令可以退出 Arthas。
quit
#使用 `classloader` 命令可以查看类加载器的信息。
classloader
#使用 `getstatic` 命令可以查看类的静态字段。
getstatic com.example.MyClass myStaticField
#使用 `ognl` 命令可以查看类的实例字段。
ognl '@com.example.MyClass@myInstanceField'
#使用 `trace` 命令可以查看方法的调用路径。
trace com.example.MyClass myMethod
#使用 `monitor` 命令可以查看方法的调用次数、成功次数、失败次数等。
monitor -c 5 com.example.MyClass myMethod
#使用 `trace` 命令可以查看方法的调用耗时。
trace com.example.MyClass myMethod
#使用 `watch` 命令可以查看方法的调用参数。
watch com.example.MyClass myMethod "{params}" -x 2
#使用 `watch` 命令可以查看方法的返回值。
watch com.example.MyClass myMethod "{returnObj}" -x 2
#使用 `watch` 命令可以查看方法的异常。
watch com.example.MyClass myMethod "{throwExp}" -x 2
#使用 `stack` 命令可以查看方法的调用链。
stack com.example.MyClass myMethod