# cubic

**Repository Path**: shufengC/cubic

## Basic Information

- **Project Name**: cubic
- **Description**: 分布式应用监控工具，提供agent  ui,可快速进行arthas 嵌入
- **Primary Language**: Java
- **License**: WTFPL
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 589
- **Created**: 2020-06-03
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# cubic

#### 介绍
Cubic 是一个对应用透明，无侵入的java应用诊断工具，用于提升开发人员的诊断效率和能力。

Cubic 的目标是一站式java应用诊断解决方案，让开发人员无需登录机器或修改系统，就可以从日志、内存、线程、类信息、调试、机器和系统属性等各个方面对应用进行诊断，提升开发人员诊断问题的效率和能力。

Cubic agent集成Alibaba开源的arthas，提供了更加丰富的功能，感谢他们做出的优秀工作。




#### 软件架构
目前整体项目分为如下几个部署模块
cubic-agent 探针数据采集，以及动态命令执行
cubic-proxy 代理，用于维护通道和命令下发，目前包含简单的web-ui



#### 安装教程

1.  git clone https://gitee.com/sanjiankethree/cubic.git
2.  执行打包脚本 ./script/build.sh
3.  打包完成的agent 在agent-dist目录下
4.  打包完成的proxy 在agent-proxy-dist目录下

#### 使用说明

1.  agent 加载如下
    java -jar -javaagent:/xxx/agent-dist/cubic-agent.jar  yyy.jar
    
2.  启动代理服务 
    java -jar cubic-proxy.jar 
    
3.  访问web ui localhost:6080
    进入默认页面，输入ip 和 agentId(id 第一次随意输入)，点击connect 进入命令交互模式
    ![输入图片说明](https://images.gitee.com/uploads/images/2020/0519/184040_83550767_1168339.png "屏幕截图.png")

    命令分为两部分，输入1 基础命令， 3位arthas 命令
    
    输入1 然后输入help 可查看帮助
    ![输入图片说明](https://images.gitee.com/uploads/images/2020/0519/184155_075ae651_1168339.png "屏幕截图.png")

    使用search 命令来查询我们项目配置的agent, 比如在agent config 我们配置了参数 agent.service_name = cubic,则进行查询并获取到应用的agentId
    ![输入图片说明](https://images.gitee.com/uploads/images/2020/0519/184353_ea961ae8_1168339.png "屏幕截图.png")
    

    然后将agentId 填入上面的输入框 点击connect 按钮重新加载，则进入当前应用的命令模式
    ![输入图片说明](https://images.gitee.com/uploads/images/2020/0519/184650_c54d80bf_1168339.png "屏幕截图.png")

    ![输入图片说明](https://images.gitee.com/uploads/images/2020/0519/184759_67e0f845_1168339.png "屏幕截图.png")

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 码云特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  码云官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目，是码云综合评定出的优秀开源项目
5.  码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)