Commit 0367208e authored by QIANGLU's avatar QIANGLU
Browse files

update read me

Showing with 15 additions and 10 deletions
+15 -10
......@@ -5,31 +5,36 @@ Cubic 是一个对应用透明,无侵入的java应用诊断工具,用于提
Cubic 的目标是一站式java应用诊断解决方案,让开发人员无需登录机器或修改系统,就可以从日志、内存、线程、类信息、调试、机器和系统属性等各个方面对应用进行诊断,提升开发人员诊断问题的效率和能力。
Cubic agent集成Alibaba开源的arthas,提供了更加丰富的功能,感谢他们做出的优秀工作
Cubic 可调用内部自定义命令和动态加载arthas使用arthas 命令集
#### 软件架构
目前整体项目分为如下几个部署模块
cubic-agent 探针数据采集,以及动态命令执行
cubic-proxy 代理,用于维护通道和命令下发,目前包含简单的web-ui
#### 目录结构
agent-dist 存放打包的agent.jar(打包后出现)
agent-proxy-dist 存放打包的proxy.jar(打包后出现)
arthas-dist 用于支持arthas命令集
config agent配置文件
cubic-agent agent start
cubic-core agent核心
cubic-proxy 代理应用,目前集成了简单的页面
cubic-ui 新版UI,目前只是demo,开发中
docs 文档
scripts 包含打包脚本、启动脚本(用于测试)
#### 安装教程
1. git clone https://gitee.com/sanjiankethree/cubic.git
2. 执行./mvnw package -DskipTests 或执行打包脚本 ./script/build.sh
2. 执行./mvnw clean package -DskipTests 或执行打包脚本 ./script/build.sh
3. 打包完成的agent 在agent-dist目录下
4. 打包完成的proxy 在agent-proxy-dist目录下
#### 使用说明
1. agent 加载如下
1. agent 加载如下,将agent-dist整体拷贝到一个目录进行加载,里面的结构请不要进行变动,不要单独拷贝一个jar
java -jar -javaagent:/xxx/agent-dist/cubic-agent.jar yyy.jar
2. 启动代理服务
2. 启动代理服务 ,用于连接agent 和web
java -jar cubic-proxy.jar
3. 访问web ui localhost:6080
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment