自带IDEA插件的阿里开源诊断神器Arthas线上项目BUG调试
目录
- 前言
- Arthas简介
- ArthasTunnel
- SpringBoot集成
- IDEA插件
- 总结
前言 记得之前写过一篇Arthas使用教程 ,通过使用Arthas我们既可以实现线上调试,还可以实现热修复。最近逛了下Arthas的官网,发现它已经支持直接集成到SpringBoot应用中去,并且还出了专用的IDEA插件。今天我们再来体验下它,看看它的功能是不是更强大了!
SpringBoot实战电商项目mall(50k+star)地址:https://github.com/macrozheng/mall
Arthas简介 Arthas是Alibaba开源的Java诊断利器,深受开发者喜爱,目前在Github上已有29K+Star。它采用命令行交互模式,同时提供丰富的 Tab 自动补全功能,进一步方便进行问题的定位和诊断。
文章图片
ArthasTunnel 为了演示一个更加真实的线上环境,接下来我们将对Docker容器中的SpringBoot应用进行诊断。我们将使用
ArthasTunnel
来实现,ArthasTunnel
相当于一个Web控制台,使用它我们无需进入应用容器即可对应用进行诊断,非常方便。首先我们需要下载
ArthasTunnel
的安装包,下载地址:https://github.com/alibaba/arthas/releases
文章图片
由于官方只提供了JAR包,如果你想通过Docker方式启动的话,可以自行打包Docker镜像,打包使用的Dockerfile脚本如下:
# 该镜像需要依赖的基础镜像FROM java:8# 将当前目录下的jar包复制到docker容器的/目录下ADD arthas-tunnel-server.jar /arthas-tunnel-server.jar# 声明服务运行的端口EXPOSE 8080 7777# 指定docker容器启动时运行jar包ENTRYPOINT ["java", "-jar","/arthas-tunnel-server.jar"]# 指定维护者的名字MAINTAINER macro
这里再提供一个一键打包运行
ArthasTunnel
容器的执行脚本run.sh
,脚本内容如下;#!/usr/bin/env bash# 定义应用组名group_name='mall-tiny'# 定义应用名称app_name='arthas-tunnel-server'# 定义应用版本app_version='1.0-SNAPSHOT'echo '----copy jar----'docker stop ${app_name}echo '----stop container----'docker rm ${app_name}echo '----rm container----'docker rmi ${group_name}/${app_name}:${app_version}echo '----rm image----'# 打包编译docker镜像docker build -t ${group_name}/${app_name}:${app_version} .echo '----build image----'docker run -p 8080:8080 -p 7777:7777 --name ${app_name} \-e TZ="Asia/Shanghai" \-v /etc/localtime:/etc/localtime \-v /mydata/app/${app_name}/logs:/var/logs \-d ${group_name}/${app_name}:${app_version}echo '----start container----'
接下来吧
ArthasTunnel
的JAR包、Dockerfile文件、执行脚本run.sh
上传到Linux服务器上,然后使用./run.sh
命令运行即可;文章图片
运行成功后,可以直接访问
ArthasTunnel
的Web控制台,访问地址:http://192.168.3.105:8080文章图片
SpringBoot集成 在SpringBoot应用中直接集成Arthas并使用,无疑是最方便的,接下来我们将采用此种方法。
首先在项目的
pom.xml
中添加如下依赖,可以对比下Arthas使用教程 中的使用方法,直接集成确实简单不少;com.taobao.arthas arthas-spring-boot-starter3.6.1
然后修改配置文件
application.yml
,记住这个agent-id
,ArthasTunnel
连接需要使用,由于我们将会把应用容器通过--link
的方式连接到ArthasTunnel
容器,这里的tunnel-server
按下面进行配置;management:endpoints:web:exposure:# 暴露端点`/actuator/arthas`include: 'arthas'arthas:agent-id: mall-tiny-arthastunnel-server: ws://arthas-tunnel-server:7777/ws
接下来通过之前的Dockerfile和
run.sh
打包应用,run.sh
与之前对比,只多了一行通过--link
连接到ArthasTunnel
容器的命令;文章图片
打包使用的Dockerfile和运行脚本
run.sh
都已经包含在示例代码中了,结构如下;文章图片
接下来在
ArthasTunnel
的Web控制台中输入AgentId
为mall-tiny-arthas
,并点击Connect
按钮即可开始诊断Java应用了;文章图片
比如通过
dashboard
命令来显示当前系统的实时数据面板,包括线程信息、JVM内存信息及JVM运行时参数;文章图片
再比如说使用
thread
命令查看当前线程信息,查看线程的堆栈,可以找出当前最占CPU的线程;文章图片
当然Arthas的功能非常强大,远不止这些,支持动态修改日志和热更新等,具体可以参考Arthas使用教程 。
IDEA插件 由于Arthas的功能很强大,需要记住的命令很多,有时候实在记不住,于是有了这款IDEA插件,该插件主要用于帮助生成Arthas命令。
直接在IDEA的插件市场搜索
arthas
即可找到该插件,然后点击安装即可;文章图片
安装完成后我们来聊聊如何使用,比如当我们觉得线上代码和预期不一致,可以使用
jad
命令反编译下看看,直接选择类,右键选择Arthas命令然后选择Jad反编译;文章图片
此时将会直接把命令拷贝到剪切板,然后到
ArthasTunnel
右键粘贴即可使用,比手打命令简单多了吧!文章图片
如果你想观察方法执行过程中的参数和返回值,可以使用
watch
命令,选择需要观察的方法右键选择即可;文章图片
这里观察下Controller中的方法的执行过程;
文章图片
我们还可单独修改某个类的日志级别,选中类名后右键选择
logger
命令;文章图片
先拷贝下
logger sc
命令查看下当前类的日志级别为INFO
;文章图片
拷贝下ClassLoader的Hash值,这里由于在Linux中
Ctrl+C
键有冲突,使用Ctrl+Insert
组合来拷贝;文章图片
接下来输入ClassLoader的Hash值,修改下日志级别,然后拷贝修改日志级别的命令;
文章图片
执行完后再查看下日志级别,已经被改为了
DEBUG
级别文章图片
总结 今天体验了一把新版的Arthas,搭配ArthasTunnel和IDEA插件使用,确实非常方便!并且它还能和SpringBoot无缝集成,确实非常给力,更多Arthas的使用可以参考Arthas使用教程 。
参考资料
项目官网:https://github.com/alibaba/arthas
官方文档:https://arthas.aliyun.com/doc/index.html
【自带IDEA插件的阿里开源诊断神器Arthas线上项目BUG调试】DEA插件使用文档:https://www.yuque.com/arthas-idea-plugin
项目源码地址
https://github.com/macrozheng/mall-learning/tree/master/mall-tiny-arthas2
更多关于Arthas线上项目BUG调试的资料请关注脚本之家其它相关文章!
推荐阅读
- #|Mybatis源码分析——插件详解
- 使用IDEA学习JSP代码第008课
- 使用IDEA学习JSP代码第007课
- 使用IDEA学习JSP代码第004课
- 使用IDEA学习JSP代码第006课
- IDEA复制方法的全路径
- IntelliJ|IntelliJ IDEA版Postman强大功能介绍
- web|web 前端签名插件_signature_pad插件实现电子签名功能
- web|web 前端签名插件_手写签名插件—jSignature
- IDEA|IDEA 中使用 Hudi的示例代码