最近我参与的业务系统在生产环境运行出了点问题,没有得到自己预期的结果,排查了好长一段时间也没有结果。正当我犯愁之际,突然想起了我曾使用过的Arthas工具。于是联系运维在业务系统所在的服务器部署了该工具,借助该工具的排查,没过多久就顺利找到了问题点,简直不要太愉快!鉴于Arthas优秀的功能,我觉得有必要分享一下该工具,还没使用过它的小伙伴,不妨先了解一下它,指不定哪天就能派上大用场。
1、简介
Arthas 是一款线上监控诊断产品,通过全局视角实时查看java应用 load、内存、gc、线程的状态信息,并能在不修改应用代码的情况下,对业务问题进行诊断,包括查看方法调用的出入参、异常,监测方法执行耗时,类加载信息等,大大提升线上问题排查效率。
2、使用场景
正如官方所说,如果我们遇到了如下问题,Arthas都能帮我们解决。
(1)这个类从哪个 jar 包加载的?为什么会报各种类相关的 Exception?
(2)我改的代码为什么没有执行到?难道是我没 commit?分支搞错了?
(3)遇到问题无法在线上 debug,难道只能通过加日志再重新发布吗?
(4)线上遇到某个用户的数据处理有问题,但线上同样无法 debug,线下无法重现!
(5)是否有一个全局视角来查看系统的运行状况?
(6)有什么办法可以监控到 JVM 的实时运行状态?
(7)怎么快速定位应用的热点,生成火焰图?
(8)怎样直接从 JVM 内查找某个类的实例?
拿我来说,我最近遇到的问题就是:我的系统要把用户数据推送到别的业务系统,在传输给别的系统之前打了即将推送的用户数据的日志,但日志里面显示用户数据是空的,而系统又没别的报错日志。如果我要加日志的话,那系统就得重新测试,走上线流程,就太麻烦了。好在Arthas提供了监控方法调用的功能,能让我直观的看到程序的执行情况,定位到数据缺失的原因。
3、安装Arthas
3.1、安装Arthas(公网)
当我们的电脑可以访问外网时,可以参考本部分完成arthas的安装。
3.1.1、下载安装包
首先执行下列命令,下载Arthas工具
curl -O https://arthas.aliyun.com/arthas-boot.jar
3.1.2、启动Arthas
针对上一步下载的jar包,通过执行java -jar启动Arthas
java -jar arthas-boot.jar
可以得到以下结果:
D:\>java -jar arthas-boot.jar
[INFO] JAVA_HOME: D:\developer\Java\jdk1.8\jre
[INFO] arthas-boot version: 3.6.8
[INFO] Found existing java process, please choose one and input the serial number of the process, eg : 1. Then hit ENTER.
* [1]: 20048 org.jetbrains.idea.maven.server.RemoteMavenServer36
[2]: 21184 org.jetbrains.idea.maven.server.RemoteMavenServer36
[3]: 15412
[4]: 324 org.jetbrains.jps.cmdline.Launcher
[5]: 3568 com.xk.mybatis.springboot.App
输出的结果可以看到当前arthas的版本是3.6.8,以及操作系统运行的java进程。编号1对应进程id是20048,编号5对应的进程id是3568。由于现在命令行是处于交互模式,我们可以通过输入编号来让arthas绑定指定的进程,方便进行后续的操作。
此处我们输入编号5,监控本地启动的业务系统,得出以下输出:
* [1]: 20048 org.jetbrains.idea.maven.server.RemoteMavenServer36
[2]: 21184 org.jetbrains.idea.maven.server.RemoteMavenServer36
[3]: 15412
[4]: 324 org.jetbrains.jps.cmdline.Launcher
[5]: 3568 com.xk.mybatis.springboot.App
[6]: 31740 C:\Users\scau_\Desktop\jd-gui.exe
5
[INFO] Start download arthas from remote server: https://arthas.aliyun.com/download/3.6.8?mirror=aliyun
[INFO] File size: 12.97 MB, downloaded size: 554.62 KB, downloading ...
[INFO] File size: 12.97 MB, downloaded size: 1.21 MB, downloading ...
[INFO] File size: 12.97 MB, downloaded size: 2.00 MB, downloading ...
[INFO] File size: 12.97 MB, downloaded size: 2.88 MB, downloading ...
[INFO] File size: 12.97 MB, downloaded size: 3.76 MB, downloading ...
[INFO] File size: 12.97 MB, downloaded size: 4.85 MB, downloading ...
[INFO] File size: 12.97 MB, downloaded size: 6.19 MB, downloading ...
[INFO] File size: 12.97 MB, downloaded size: 7.77 MB, downloading ...
[INFO] File size: 12.97 MB, downloaded size: 9.47 MB, downloading ...
[INFO] File size: 12.97 MB, downloaded size: 11.56 MB, downloading ...
[INFO] Download arthas success.
[INFO] arthas home: C:\Users\scau_\.arthas\lib\3.6.8\arthas
[INFO] Try to attach process 3568
[INFO] Attach process 3568 success.
[INFO] arthas-client connect 127.0.0.1 3658
,---. ,------. ,--------.,--. ,--. ,---. ,---.
/ O \ | .--. ''--. .--'| '--' | / O \ ' .-'
| .-. || '--'.' | | | .--. || .-. |`. `-.
| | | || |\ \ | | | | | || | | |.-' |
`--' `--'`--' '--' `--' `--' `--'`--' `--'`-----'
wiki https://arthas.aliyun.com/doc
tutorials https://arthas.aliyun.com/doc/arthas-tutorials.html
version 3.6.8
main_class
pid 3568
time 2023-05-05 17:53:25
[arthas@3568]$
arthas会联网下载一些必须的文件,然后和目标进程进行绑定。至此,arthas就启动成功了。我们可以通过arthas提供的命令来对我们的业务系统进行监控。
注意:如果我们已经知道了Java进程的ID(比如上面编号5对应的进程ID是3568),那么可以直接执行下面命令,启动Artthas,并将其和业务系统绑定。
java -jar arthas-boot.jar 3568
3.2、安装Arthas(内网)
如果我们要在内网服务器(或者个人办公电脑)上安装arthas,由于无法访问互联网,没办法通过3.1中的命令在线下载arthas组件,此时我们可以去外网下载arthas完整的安装包,然后再去内网部署。
3.2.1、下载完整安装包
访问下面的GitHub地址,去选择合适的发行版来下载
https://github.com/alibaba/arthas/releases
例:3.6.8版本的github下载地址如下
https://github.com/alibaba/arthas/releases/download/arthas-all-3.6.8/arthas-bin.zip
或者直接访问下述地址,下载最新版本的Arthas完整安装包
https://arthas.aliyun.com/download/latest_version?mirror=aliyun
3.2.2、安装Arthas
将上述的zip包的内容直接解压到arthas目录下,arthas目录便是Arthas的安装目录,由此便完成了安装。
3.2.3、启动Arthas
首先确保我们的业务系统已启动,通过jps命令找到进程ID,比如ID是3568
进入arthas目录。
如果是Windows系统,执行下述命令启动
as.bat 3568
如果是Linux系统,执行下述命令启动
./as.sh 3568
或者直接通过下述命令启动(不分操作系统)
#此处命令也可以不携带结尾的进程ID参数3568,可以根据提示在后面的操作中选择Arthas查询到的进程ID并完成启动操作
java -jar arthas-boot.jar 3568
3.3、远程连接Arthas
Arthas目前支持Web Console,我们可以通过浏览器访问Arthas。Arthas绑定应用成功后,我们可以直接访问
http://127.0.0.1:8563,会打开如下界面:
上图的arthas已经绑定了应用系统,所以我们可以像在本地命令行界面操作那样,输入arthas相应的命令。当然,我们还可以输入ip,访问其他的arthas服务。
注意:默认情况下,arthas 只 listen 127.0.0.1,所以如果想从远程连接(比如在本地浏览器访问服务器上的arthas),则可以在启动服务器上的arthas时使用 --target-ip参数指定 listen 的 IP,示例如下:
java -jar arthas-boot.jar 3568 --target-ip 192.168.83.206
然后就可以浏览器访问http://192.168.83.206:8563/,查看服务器上的arthas服务。
3.4、退出Arthas
当我们处于以下和arthas交互的状态时,可以选择退出连接。
[arthas@3568]$
[arthas@3568]$
输入quit或exit退出当前连接:
[arthas@3568]$
[arthas@3568]$ quit
D:\developer\arthas-packaging-3.6.8-bin>
但是arthas进程还在,arthas自身监听所使用的端口也未关闭,下次启动arthas时仍会连接到之前的应用。可以输入stop,完全停止arthas进程,将其和目标应用解绑:
[arthas@3568]$
[arthas@3568]$ stop
Resetting all enhanced classes ...
Affect(class count: 1 , method count: 0) cost in 15 ms, listenerId: 0
Arthas Server is going to shutdown...
[arthas@3568]$ session (9785d839-da6a-4c13-a7c9-e13bdafafb18) is closed because server is going to shutdown.
D:\developer\arthas-packaging-3.6.8-bin>
4、常用命令
4.1、memory
该命令用于查看JVM内存情况
4.2、heapdump
该命令用于dump Java堆信息
(1)指定存储的路径
[arthas@3568]$ heapdump arthas-output/dump.hprof
Dumping heap to arthas-output/dump.hprof ...
Heap dump file created
[arthas@3568]$
上述命令dump堆信息到arthas-output目录下的dump.hprof文件中,注意arthas-output目录是固定的,后面的文件名可以自定义。
然后可以通过访问下述地址,将堆文件下载下来
#这块和Arthas提供的web console功能有关,如果是个人电脑执行的命令,可以直接访问下述地址。否则需要在Arthas启动的时候配置ip地址
http://localhost:8563/arthas-output/
(2)不指定存储的路径
[arthas@3568]$ heapdump
Dumping heap to C:\Users\ADMINI~1\AppData\Local\Temp\heapdump2023-05-05-22-245366907463725074073.hprof ...
Heap dump file created
[arthas@3568]$
上述命令将dump文件存储到临时文件。
4.3、watch(超实用的命令)
该命令用于观测指定函数的执行情况,非常实用。语法如下:
watch 类名的全路径名 类的方法名 观察表达式
其中,类的方法名不限制方法对应的访问权限,即使是私有方法也可以。
观察表达式可以省略,它的默认值是:
{params,target,returnObj}
params代表方法的入参,target代表我们观察的目标对象(当前类的实例),returnObj代表方法的返回值,它们之间用英文逗号分隔。如果只需要观察方法的入参和返回值,观察表达式可以这么写:
{params,returnObj}
如果只需要观察返回值,观察表达式可以直接写:
returnObj
在 watch 命令的结果里,会打印出location信息。location有三种可能值:AtEnter,AtExit和AtExceptionExit。分别对应函数入口,函数正常 return,函数抛出异常。
示例如下:
我们业务系统有如下代码:
package com.xk.mybatis.springboot.service;
import com.xk.mybatis.springboot.entity.Order;
import com.xk.mybatis.springboot.mapper.OrderMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
/**
* @author xk
* @since 2023.04.24 14:26
*/
@Service
public class OrderService {
@Autowired
private OrderMapper orderMapper;
/**
* 根据订单id获取订单
* @param id
* @return
*/
public Order findById(Long id){
return orderMapper.findById(id);
}
}
我们观察其中的findById方法:
[arthas@3568]$ watch com.xk.mybatis.springboot.service.OrderService findById {params,returnObj}
Press Q or Ctrl+C to abort.
Affect(class count: 1 , method count: 1) cost in 29 ms, listenerId: 2
method=com.xk.mybatis.springboot.service.OrderService.findById location=AtExit
ts=2023-05-06 08:40:24; [cost=5.9093ms] result=@ArrayList[
@Object[][isEmpty=false;size=1],
@Order[com.xk.mybatis.springboot.entity.Order@734346e3],
]
可以看到location=AtExit,说明函数正常返回。而result=@ArrayList代表我们要观察的数据。数组中有两项,@Object[]代表我们的入参params,@Order就对应我们的返回对象returnObj。findById会返回一个Order对象,而示例中returnObj对应的值正是一个Order对象.
如果不写观察表达式,就会输出如下的结果:
[arthas@3568]$
[arthas@3568]$ watch com.xk.mybatis.springboot.service.OrderService findById
Press Q or Ctrl+C to abort.
Affect(class count: 1 , method count: 1) cost in 28 ms, listenerId: 3
method=com.xk.mybatis.springboot.service.OrderService.findById location=AtExit
ts=2023-05-06 08:50:06; [cost=2.886499ms] result=@ArrayList[
@Object[][isEmpty=false;size=1],
@OrderService[com.xk.mybatis.springboot.service.OrderService@32acb99a],
@Order[com.xk.mybatis.springboot.entity.Order@36933b17],
]
4.4、jad(超实用的命令)
该命令用于反编译.class文件,可以将其反编译成java源码的形式,方便我们观察类文件的代码。如果我们怀疑我们新增或修改的代码没有得到执行,就可以使用该命令来看看class文件中是否有我们新增或修改的那部分代码。
语法如下:
jad --source-only 类的全路径名 类中的方法名 --lineNumber true(或false)
参数说明如下:
参数 | 说明 | 是否必填 |
---|---|---|
–source-only | 代表只输出源码信息,不包括classloader信息 | 否 |
类的全路径名 | 代表类的全路径名 | 是 |
类中的方法名 | 代表类中的方法名 | 否 |
–lineNumber | 是否打印行号,如果不写,默认为true | 否 |
实际有下列的用法:
(1)jad --source-only 类的全路径名
等价于jad --source-only 类的全路径名 --lineNumber true
(2)jad 类的全路径名 类中的方法名
等价于jad 类的全路径名 类中的方法名 --lineNumber true
(3)jad --source-only 类的全路径名 类中的方法名 --lineNumber false
(4)jad --source-only 类的全路径名 类中的方法名 --lineNumber false
示例如下:
反编译我们的OrderService字节码(class)文件,得出如下结果:
[arthas@3568]$ jad com.xk.mybatis.springboot.service.OrderService
ClassLoader:
+-sun.misc.Launcher$AppClassLoader@18b4aac2
+-sun.misc.Launcher$ExtClassLoader@5cbc508c
Location:
/D:/programs/ideaProject/study/mybatis/springboot-mybatis/target/classes/
/*
* Decompiled with CFR.
*
* Could not load the following classes:
* com.xk.mybatis.springboot.entity.Order
* com.xk.mybatis.springboot.mapper.OrderMapper
*/
package com.xk.mybatis.springboot.service;
import com.xk.mybatis.springboot.entity.Order;
import com.xk.mybatis.springboot.mapper.OrderMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
@Service
public class OrderService {
@Autowired
private OrderMapper orderMapper;
public Order findById(Long id) {
/*24*/ return this.orderMapper.findById(id);
}
}
Affect(row-cnt:1) cost in 537 ms.
[arthas@3568]$
我们可以很直观的看出class文件的内容,如果是类文件中没有包括我们修改的代码,可能就是我们的代码没提交成功,导致打出的jar包没包括我们的代码。通过jad命令就能快速的定位出这种问题。
4.5、trace(超实用的命令
该命令用于监控方法内部调用路径,并输出方法路径上的每个节点上耗时。如果我们发现生产环境某个接口响应速度慢,就可以通过该命令观察主要耗时时间在哪个环节。
语法如下:
trace 类的全路径名 类的方法名
示例如下:
我们监控下根据订单id查询订单详情的http接口的调用链路及耗时情况,输出结果如下:
[arthas@3568]$ trace com.xk.mybatis.springboot.controller.OrderController findById
Press Q or Ctrl+C to abort.
Affect(class count: 1 , method count: 1) cost in 72 ms, listenerId: 1
`---ts=2023-05-06 09:29:20;thread_name=http-nio-8080-exec-1;id=19;is_daemon=true;priority=5;TCCL=org.springframework.boot.web.embedded.tomcat.TomcatEmbeddedWebappClassLoader@48b0e701
`---[6.1043ms] com.xk.mybatis.springboot.controller.OrderController:findById()
`---[95.87% 5.852ms ] com.xk.mybatis.springboot.service.OrderService:findById() #24
可以看到,controller接口执行耗时6.1043ms,而它内部调用的service层接口执行了5.852ms。如果我们的链路涉及到了很复杂的调用过程(比如调用了很多方法来处理业务),就可以通过trace命令来监控哪些方法比较耗时。
结束语
本文先分享到这里,觉得有收获的朋友,可以点击"关注",或者进行分享或收藏,有疑惑的也可以来私聊评论,我会及时进行回复~