/ETrace

由Java代码编写的,基于agent技术实现动态操作目标进程

Primary LanguageJava

ETrace

已经上传至**maven仓库 https://mvnrepository.com/search?q=com.github.nobugboy

详细博客介绍:https://juejin.cn/post/6976178524608544775

引言

在使用Arthas的过程中,感觉有些功能很好用,但是有些不敢敲命令行的用起来会比较麻烦,,本着学习的态度,自己设计了一套无需停机,无侵入,埋点,热修复,监控等功能的应用,并提供了WEB页面进行操作,并且会不断集成一些常用的功能 。

在日常的工作中,经常会遇到一些让人头疼的问题,比如在上线前测试量不够,导致生产环境出现了一个小bug,影响了功能的正常使用,这个时候可能就是因为一小行代码所导致,但是为了修复bug不得不重启程序(没办法),这时候客户和老板可能就不满意了(用户量小还好),所以针对这种情况,自己设计了一套可以在线补偿的工具。

简介

在决定好要设计这个程序的时候,调研了一些关键的技术,如下

技术名称 作用
Javaagent 在运行前加载,或在运行中对字节码进行操作
VirtualMachine 在运行中附着到目标进程上,并调用agent

整个工程分为三个部分,前端页面,与页面交互的服务端,操作目标Java进程的agent 在这里插入图片描述

工程 技术
web Vue + Ant design
server Springboot+Websocket
agent Javassist + cfr + JavaCompiler

操作指南

  1. 如果是linux系统,
#版本号去git上查看
wget http://maven.aliyun.com/nexus/content/groups/public/com/github/nobugboy/ETrace/1.2.4/ETrace-1.2.4.jar
java -Xbootclasspath/a:$JAVA_HOME/lib/tools.jar -jar ETrace-1.2.4.jar
  1. 其他操作系统可以直接点击连接下载,然后指定tools.jar对应的目录

打开浏览器输入运行程序的ip:9675,进入首页输入admin,admin123进入控制台页面

  1. 配置ip,如果是本地运行localhost即可,如果是内网(比如VM跑了linux)就输入内网ip例如(192.168.121.130),如果是在服务器部署则输入服务器外网IP,若不知道IP可点击查询外网IP 在这里插入图片描述

  2. 找到对应的操作按照步骤操作即可,需要注意的是点击agnet到进程后需要等待返回 '连接成功,等待发送指令' 然后继续操作,如果没有反应,则上一步的ip配置有误


目前已经实现的功能

  1. 热修复,输入目标工程的完整包名,比如有一个类叫com.abc,将该类反编译到目录(同时会把旧的字节码也导出,为了防止出现问题快速恢复),对反编译出的java文件进行修改,然后重新编译,最后重新load字节码(不是所有的类都能成功编译,因为反编译出的字节码可能被HotSpot优化,或其他未知原因,会将失败日志导出到当前目录)
  2. 补加执行时间,在指定的类中,比如com.abc中,对其中的所有方法或某一个方法(需要方法名),进行追加打印执行时间
  3. 打印高cpu线程堆栈,快速定位cpu高居不下线程执行的代码位置,以便解决问题
  4. 监控大盘,监控内存,gc,线程等数据
  5. 快速查看线程当前堆栈

版本迭代

  1. 1.1版本更新了aop功能,可以打印方法入参和返回值
  2. 1.2版本更新了监控大盘,监控更多信息
  3. 1.2.1版本更名为ETrace,新增线程堆栈追踪功能(该本版线程cpu显示有bug)
  4. 1.2.2修复重连bug和一些小bug(建议使用该版本)
  5. 1.2.3新增查看工作目录和虚拟机参数等信息
  6. 1.2.4将client改为netty,解决默认参数问题,优化操作方式,解决Spring代理类无法被动态织入代码

server端源码(vue已经打包在了static下,启动直接访问lp:9675即可),授权这里其实没做,默认是同户名是admin,密码是admin123,如果需要打包记得关闭单元测试 github地址

代码在IDEA可以直接运行,如果通过jar包运行需要额外指定参数:

java -Xbootclasspath/a:$JAVA_HOME/lib/tools.jar -jar ETrace-1.2.4.jar
# 如果java环境变量默认是$JAVA_HOME则不需要加参数
java -jar ETrace-1.2.4.jar