Cubic 项目安装与使用教程
1. 项目目录结构及介绍
Cubic 项目的目录结构如下:
cubic
├── cubic-agent
│ ├── config
│ └── ...
├── cubic-proxy
│ ├── cubic-proxy-common
│ ├── cubic-proxy-websocket
│ └── ...
├── cubic-ui
├── docs
├── scripts
├── agent-dist
├── agent-proxy-dist
├── arthas-dist
├── mvn
├── db
├── LICENSE
├── README.md
├── mvnw
├── mvnw.cmd
└── pom.xml
目录结构介绍
- cubic-agent: 应用数据采集的 agent,包含配置文件和其他相关文件。
- config: 存放 agent 的配置文件。
- cubic-proxy: 代理应用,用于接收 agent 数据。
- cubic-proxy-common: 公共基础参数。
- cubic-proxy-websocket: 代理应用,用于接收页面与 proxy 之间的数据通信。
- cubic-ui: 页面 UI,提供前端各种功能展示。
- docs: 文档目录,包含项目的相关文档。
- scripts: 包含打包脚本、启动脚本等。
- agent-dist: 存放打包后的 agent 完整组件。
- agent-proxy-dist: 存放打包后 proxy 部署的 jar 文件。
- arthas-dist: 用于支持 arthas 命令集。
- mvn: Maven 相关文件。
- db: 数据库相关文件,包含初始化 SQL 脚本。
- LICENSE: 项目许可证文件。
- README.md: 项目介绍文件。
- mvnw: Maven 包装器脚本。
- mvnw.cmd: Maven 包装器脚本的 Windows 版本。
- pom.xml: Maven 项目配置文件。
2. 项目启动文件介绍
Cubic 项目的启动文件主要包括以下几个部分:
2.1 build-start.sh
这是一个用于打包和启动项目的脚本文件。执行该脚本可以完成项目的打包和部署。
2.2 mvnw
和 mvnw.cmd
这两个文件是 Maven 包装器脚本,用于在不同操作系统上执行 Maven 命令。mvnw
适用于 Unix/Linux 系统,mvnw.cmd
适用于 Windows 系统。
2.3 pom.xml
这是 Maven 项目的配置文件,定义了项目的依赖、插件、构建配置等信息。
3. 项目的配置文件介绍
Cubic 项目的配置文件主要集中在 cubic-agent/config
目录下,具体包括以下几个文件:
3.1 application.properties
这是 Spring Boot 项目的标准配置文件,包含了项目的各种配置项,如数据库连接、端口配置、日志配置等。
3.2 agent.properties
这是 agent 的配置文件,包含了 agent 的相关配置项,如数据采集频率、数据存储路径等。
3.3 logback.xml
这是日志配置文件,定义了日志的输出格式、日志级别、日志文件路径等。
3.4 init.sql
这是数据库初始化脚本,位于 cubic-proxy/resources/db
目录下,用于创建项目所需的数据库表结构。
通过以上配置文件,可以对 Cubic 项目进行详细的配置和调整,以满足不同的应用场景和需求。