Big Whale 项目安装与使用教程

1. 项目目录结构及介绍

Big Whale 项目的目录结构如下：

big-whale/
├── bin/
├── doc/
├── script/
├── src/
│   ├── main/
│   └── test/
├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
├── pom.xml

目录结构介绍

• bin/: 存放项目的可执行脚本文件。
• doc/: 存放项目的文档文件。
• script/: 存放项目的脚本文件。
• src/: 存放项目的源代码文件，包括 main/ 和 test/ 两个子目录。
  • main/: 存放项目的主要源代码。
  • test/: 存放项目的测试代码。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• pom.xml: Maven 项目的配置文件。

2. 项目启动文件介绍

Big Whale 项目的启动文件是 big-whale.jar，位于 target/ 目录下。启动项目的命令如下：

java -jar big-whale.jar

启动文件介绍

• big-whale.jar: 这是项目的可执行 JAR 文件，包含了所有必要的依赖和代码。通过上述命令可以启动项目。

3. 项目的配置文件介绍

Big Whale 项目的主要配置文件是 big-whale.properties，位于 src/main/resources/ 目录下。以下是配置文件的主要内容和配置项说明：

配置文件内容

# SSH 配置
ssh.user=your_ssh_user
ssh.password=your_ssh_password

# 钉钉告警配置
dingding.enabled=true
dingding.watcher-token=your_dingding_token

# Yarn 应用管理配置
yarn.app-memory-threshold=1024
yarn.app-white-list=app1,app2

# 其他配置项
# ...

配置项说明

• ssh.user: 拥有脚本执行权限的 SSH 远程登录用户名。
• ssh.password: SSH 远程登录用户的密码。
• dingding.enabled: 是否开启钉钉告警，true 表示开启，false 表示关闭。
• dingding.watcher-token: 钉钉公共群机器人的 Token。
• yarn.app-memory-threshold: Yarn 应用内存上限，单位为 MB，-1 表示禁用检测。
• yarn.app-white-list: Yarn 应用白名单列表，列表中的应用申请的内存超过上限时不会进行告警。

通过以上配置文件，可以对 Big Whale 项目进行详细的参数设置，以满足不同的运行环境和需求。