架构师

您现在的位置是:首页 > 技术博客 > 开发环境

开发环境

Java开发环境系列:在线诊断工具arthas入门及使用教程

架构师小跟班 2019-07-22开发环境
当你遇到以下类似问题而束手无策时,Arthas可以帮助你解决:这个类从哪个 jar 包加载的?为什么会报各种类相关的 Exception?我改的代码为什么没有执行到?难道是我没 commit?分支搞错了?遇到问题无法在线上 debug,难道只能通过加日志再重新发布吗?

安装

官方网站:

https://alibaba.github.io/arthas/index.html

一、下载arthas-boot.jar,然后用java -jar的方式启动:

wget https://alibaba.github.io/arthas/arthas-boot.jar

启动程序:

java -jar arthas-boot.jar

打印帮助信息:

java -jar arthas-boot.jar -h

如果下载速度比较慢,可以使用aliyun的镜像:

java -jar arthas-boot.jar --repo-mirror aliyun --use-http

如果从github下载有问题,可以使用gitee镜像

wget https://arthas.gitee.io/arthas-boot.jar

使用入门

一、启动Demo

wget https://alibaba.github.io/arthas/arthas-demo.jar

java -jar arthas-demo.jar

二、启动arthas

使用和目标进程一致的用户启动,否则可能attach失败

wget https://alibaba.github.io/arthas/arthas-boot.jar

java -jar arthas-boot.jar

输入demo对应的数字

三、查看dashboard面板

四、通过thread命令来获取到arthas-demo进程的Main Class

thread 1会打印线程ID 1的栈,通常是main函数的线程。

五、通过jad来反编译Main Class

六、通过watch命令来查看demo.MathGame#primeFactors函数的返回值

该方法的源码:返回的是一个数字类型的List

七、退出arthas

如果只是退出当前的连接,可以用quit或者exit命令。Attach到目标进程上的arthas还会继续运行,端口会保持开放,下次连接时可以直接连接上。

如果想完全退出arthas,可以执行shutdown命令。

webconsole

Arthas目前支持Web Console,用户在attach成功之后,可以直接访问:

http://127.0.0.1:8563/

可以填入IP,远程连接其它机器上的arthas

开启执行结果存日志功能

默认是关闭的,options save-result true,结果会异步保存在:{user.home}/logs/arthas-cache/result.log

通过sysprop user.home命令查看用户根路径


常用命令

help——查看命令帮助信息

cat——打印文件内容,和linux里的cat命令类似

pwd——返回当前的工作目录,和linux命令类似

cls——清空当前屏幕区域

session——查看当前会话的信息

reset——重置增强类,将被 Arthas 增强过的类全部还原,Arthas 服务端关闭时会重置所有增强过的类

version——输出当前目标 Java 进程所加载的 Arthas 版本号

history——打印命令历史

quit——退出当前 Arthas 客户端,其他 Arthas 客户端不受影响

shutdown——关闭 Arthas 服务端,所有 Arthas 客户端全部退出

keymap——Arthas快捷键列表及自定义快捷键

jvm相关

dashboard——当前系统的实时数据面板

thread——查看当前 JVM 的线程堆栈信息

jvm——查看当前 JVM 的信息

sysprop——查看和修改JVM的系统属性

sysenv——查看JVM的环境变量

getstatic——查看类的静态属性

New!ognl——执行ognl表达式

New!mbean——查看 Mbean 的信息

class/classloader相关

sc——查看JVM已加载的类信息

sm——查看已加载类的方法信息

jad——反编译指定已加载类的源码

mc——内存编绎器,内存编绎.java文件为.class文件

redefine——加载外部的.class文件,redefine到JVM里

dump——dump 已加载类的 byte code 到特定目录

classloader——查看classloader的继承树,urls,类加载信息,使用classloader去getResource

monitor/watch/trace相关

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

monitor——方法执行监控

watch——方法执行数据观测

trace——方法内部调用路径,并输出方法路径上的每个节点上耗时

stack——输出当前方法被调用的调用路径

tt——方法执行数据的时空隧道,记录下指定方法每次调用的入参和返回信息,并能对这些不同的时间下调用进行观测

options

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

管道

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

grep——搜索满足条件的结果

plaintext——将命令的结果去除ANSI颜色

wc——按行统计输出结果

后台异步任务

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

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

jobs——列出所有job

kill——强制终止任务

fg——将暂停的任务拉到前台执行

bg——将暂停的任务放到后台执行

Web Console

通过websocket连接Arthas。

Web Console

文章评论