Bill Lau
💻
 tomsun28 💻 📖 🎨 |
-  会编程的王学长 💻 📖 🎨 |
-  zcx 💻 🐛 🎨 |
-  进击的阿晨 💻 🎨 🐛 |
-  铁甲小宝 🐛 💻 📖 |
-  cuipiheqiuqiu 💻 ⚠️ 🎨 |
-
javax.validation.requirements
+
+3. 如果方法中的代码行数太多，请尝试在适当的点上使用多个子方法来分段方法体。
+
+ 一般来说，需要坚持以下原则：
+ - 便于测试
+ - 有好的语义
+ - 易于阅读
+
+ 此外，还需要考虑在组件、逻辑、抽象和场景等方面的切割是否合理。
+
+ > 然而，目前还没有明确的演示定义。在演变过程中，我们将为开发者提供更多的示例，以便他们有更清晰的参考和理解。
+
+
+### 3.4 集合规则
+
+1. 对于返回的 `collection` 值，除非有特殊的 `concurrent` (如线程安全)，总是返回 `interface`，例如：
+
+ - 如果使用 `ArrayList`，则返回 List
+ - 如果使用 `HashMap`，则返回 Map
+ - 如果使用 `HashSet`，则返回 Set
+
+2. 如果存在多线程，可以使用以下声明或返回类型：
+
+ ```java
+ private CurrentHashMap map;
+ public CurrentHashMap funName();
+ ```
+
+3. 使用 `isEmpty()` 而不是 `length() == 0` 或者 `size() == 0`
+
+ - 负面示例：
+
+ ```java
+ if (pathPart.length() == 0) {
+ return;
+ }
+ ```
+
+ - 正面示例：
+
+ ```java
+ if (pathPart.isEmpty()) {
+ return;
+ }
+ ```
+
+### 3.5 并发处理
+
+1. 需要管理 `线程池`，使用统一的入口点获取 `线程池`。
+
+ 注意：在演变过程中，我们将为开发者提供更多的示例，以便他们有更清晰的参考和理解。
+
+2. `线程池` 需要进行资源约束，以防止因处理不当导致的资源泄露。
+
+### 3.6 控制/条件语句
+
+1. 避免因不合理的 `条件/控制` 分支顺序导致：
+
+ - 多个代码行的 `深度` 为 `n+1`
+ - 多余的行
+
+一般来说，如果一个方法的代码行深度由于连续嵌套的 `if... else..` 超过了 `2+ Tabs`，那么应该考虑试图
+- `合并分支`，
+- `反转分支条件`
+- `提取私有方法`
+
+以减少代码行深度并提高可读性，例如：
+- 联合或将逻辑合并到下一级调用中
+ - 负面示例：
+ ```java
+ if (isInsert) {
+ save(platform);
+ } else {
+ updateById(platform);
+ }
+ ```
+ - 正面示例：
+ ```java
+ saveOrUpdate(platform);
+ ```
+- 合并条件
+ - 负面示例：
+ ```java
+ if (expression1) {
+ if(expression2) {
+ ......
+ }
+ }
+ ```
+ - 正面示例：
+ ```java
+ if (expression1 && expression2) {
+ ......
+ }
+ ```
+- 反转条件
+ - 负面示例：
+
+ ```java
+ public void doSomething() {
+ // 忽略更深的代码块行
+ // .....
+ if (condition1) {
+ ...
+ } else {
+ ...
+ }
+ }
+ ```
+
+ - 正面示例：
+
+ ```java
+ public void doSomething() {
+ // 忽略更深的代码块行
+ // .....
+ if (!condition1) {
+ ...
+ return;
+ }
+ // ...
+ }
+ ```
+- 使用单一变量或方法减少复杂的条件表达式
+ - 负面示例：
+ ```java
+ if (dbType.indexOf("sqlserver") >= 0 || dbType.indexOf("sql server") >= 0) {
+ ...
+ }
+ ```
+
+ - 正面示例：
+ ```java
+ if (containsSqlServer(dbType)) {
+ ....
+ }
+ //.....
+ // containsSqlServer的定义
+ ```
+
+> 在未来，使用 `sonarlint` 和 `better highlights` 检查代码深度看起来是个不错的选择。
+
+### 3.7 代码注释规则
+
+1. 方法缺少注释：
+
+ - `When`：该方法何时可以被调用
+ - `How`：如何使用此方法以及如何传递参数等
+ - `What`：此方法实现了哪些功能
+ - `Note`：在调用此方法时开发人员应注意什么
+
+2. 缺少必要的类头部描述注释。
+
+ 添加 `What`，`Note` 等，如上述 `1` 中提到的。
+
+3. 在接口中的方法声明必须被注释。
+
+ - 如果实现的语义和接口声明的注释内容不一致，则具体的实现方法也需要用注释重写。
+
+ - 如果方法实现的语义与接口声明的注释内容一致，则建议不写注释以避免重复的注释。
+
+4. 在注释行中的第一个词需要大写，如 `param` 行，`return` 行。
+ 如果特殊引用作为主题不需要大写，需要注意特殊符号，例如引号。
+
+### 3.8 Java Lambda 表达式
+
+1. 更倾向于使用 `non-capturing` lambda（不包含对外部范围的引用的lambda）。
+ Capturing lambda 在每次调用时都需要创建一个新的对象实例。`Non-capturing` lambda 可以为每次调用使用相同的实例。
+
+ - 负面示例：
+
+ ```java
+ map.computeIfAbsent(key, x -> key.toLowerCase())
+ ```
+
+ - 正面示例：
+
+ ```java
+ map.computeIfAbsent(key, k -> k.toLowerCase());
+ ```
+
+2. 考虑使用方法引用而不是内联lambda
+
+ - 负面示例：
+
+ ```java
+ map.computeIfAbsent(key, k-> Loader.load(k));
+ ```
+
+ - 正面示例：
+
+ ```java
+ map.computeIfAbsent(key, Loader::load);
+ ```
+
+### 3.9 Java Streams
+
+- 在任何对性能敏感的代码中避免使用 Java Streams。
+
+- 使用 Java Streams 的主要动机是为了提高代码的可读性。因此，它们可以在代码的某些部分中很好地匹配，这些部分不是数据密集型的，而是处理协调。
+
+- 即使在后一种情况下，也试图限制范围到一个方法，或者一个内部类中的几个私有方法。
+
+### 3.10 前置条件检查
+
+1. 使用统一的 `Utils.requireXXX` 来完成前提的验证，如果可能的话，用新的前置条件检查替换 `AlertXXException.throwIfXXX`。
+
+### 3.11 StringUtils
+
+1. 使用 `StringUtils.isBlank` 而不是 `StringUtils.isEmpty`
+
+ - 负面示例：
+
+ ```java
+ if (StringUtils.isEmpty(name)) {
+ return;
+ }
+ ```
+
+ - 正面示例：
+
+ ```java
+ if (StringUtils.isBlank(name)) {
+ return;
+ }
+ ```
+
+2. 使用 `StringUtils.isNotBlank` 而不是 `StringUtils.isNotEmpty`
+
+ - 负面示例：
+
+ ```java
+ if (StringUtils.isNotEmpty(name)) {
+ return;
+ }
+ ```
+
+ - 正面示例：
+
+ ```java
+ if (StringUtils.isNotBlank(name)) {
+ return;
+ }
+ ```
+
+3. 使用 `StringUtils.isAllBlank` 而不是 `StringUtils.isAllEmpty`
+
+ - 负面示例：
+
+ ```java
+ if (StringUtils.isAllEmpty(name, age)) {
+ return;
+ }
+ ```
+
+ - 正面示例：
+
+ ```java
+ if (StringUtils.isAllBlank(name, age)) {
+ return;
+ }
+ ```
+
+### 3.12 `Enum` 类
+
+1. 枚举值比较
+
+ - 负面示例：
+
+ ```java
+ if (status.equals(JobStatus.RUNNING)) {
+ return;
+ }
+ ```
+
+ - 正面示例：
+
+ ```java
+ if (status == JobStatus.RUNNING) {
+ return;
+ }
+ ```
+
+2. 枚举类不需要实现 Serializable
+
+ - 负面示例：
+
+ ```java
+ public enum JobStatus implements Serializable {
+ ...
+ }
+ ```
+
+ - 正面示例：
+
+ ```java
+ public enum JobStatus {
+ ...
+ }
+ ```
+
+3. 使用 `Enum.name()` 而不是 `Enum.toString()`
+
+ - 负面示例：
+
+ ```java
+ System.out.println(JobStatus.RUNNING.toString());
+ ```
+
+ - 正面示例：
+
+ ```java
+ System.out.println(JobStatus.RUNNING.name());
+ ```
+
+4. 枚举类名称统一使用 Enum 后缀
+
+ - 负面示例：
+
+ ```java
+ public enum JobStatus {
+ ...
+ }
+ ```
+
+ - 正面示例：
+
+ ```java
+ public enum JobStatusEnum {
+ ...
+ }
+ ```
+
+### 3.13 `Deprecated` 注解
+
+ - 负面示例:
+
+ ```java
+ @deprecated
+ public void process(String input) {
+ ...
+ }
+ ```
+
+ - 正面示例:
+
+ ```java
+ @Deprecated
+ public void process(String input) {
+ ...
+ }
+ ```
+
+## 4 日志
+
+1. 使用 `占位符` 进行日志输出：
+
+ - 负面示例
+ ```java
+ log.info("Deploy cluster request " + deployRequest);
+ ```
+ - 正面示例
+ ```java
+ log.info("load plugin:{} to {}", file.getName(), appPlugins);
+ ```
+
+2. 打印日志时，注意选择 `日志级别`
+
+ 当打印日志内容时，如果传递了日志占位符的实际参数，必须避免过早评估，以避免由日志级别导致的不必要评估。
+
+ - 负面示例：
+
+ 假设当前日志级别为 `INFO`：
+
+ ```java
+ // 忽略声明行。
+ Listtomsun28 💻 📖 🎨 |
- 会编程的王学长 💻 📖 🎨 |
- zcx 💻 🐛 🎨 |
- 进击的阿晨 💻 🎨 🐛 |
- 铁甲小宝 🐛 💻 📖 |
- cuipiheqiuqiu 💻 ⚠️ 🎨 |
-
-
-
-感谢[吉实信息(构建全新的微波+光交易网络)](https://www.flarespeed.com) 赞助服务器采集节点
-感谢[蓝易云(全新智慧上云)](https://www.tsyvps.com/aff/BZBEGYLX) 赞助服务器采集节点
-感谢[Postcat(开源 API 管理工具)](https://datayi.cn/w/xRxVBBko) 赞助
-
-
-
-
diff --git a/home/versioned_docs/version-v1.1.x/start/iotdb-init.md b/home/versioned_docs/version-v1.1.x/start/iotdb-init.md
deleted file mode 100644
index dca6a89d0a3..00000000000
--- a/home/versioned_docs/version-v1.1.x/start/iotdb-init.md
+++ /dev/null
@@ -1,78 +0,0 @@
----
-id: iotdb-init
-title: 依赖时序数据库服务IoTDB安装初始化
-sidebar_label: 使用IoTDB存储指标数据(可选)
----
-
-HertzBeat的历史数据存储依赖时序数据库 IoTDB 或 TDengine，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置)
-
-Apache IoTDB是一体化收集、存储、管理与分析物联网时序数据的软件系统，我们使用其存储分析采集到的监控指标历史数据。支持V0.12 - V0.13版本，推荐使用V0.13.*版本。
-
-**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能和高性能**
-
-> 如果您已有IoTDB环境，可直接跳到YML配置那一步。
-
-
-### 通过Docker方式安装IoTDB
-> 可参考官方网站[安装教程](https://iotdb.apache.org/zh/UserGuide/V0.13.x/QuickStart/WayToGetIoTDB.html)
-1. 下载安装Docker环境
- Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。
- 安装完毕后终端查看Docker版本是否正常输出。
- ```
- $ docker -v
- Docker version 20.10.12, build e91ed57
- ```
-2. Docker安装IoTDB
-
-```shell
-$ docker run -d -p 6667:6667 -p 31999:31999 -p 8181:8181 \
- -v /opt/iotdb/data:/iotdb/data \
- --name iotdb \
- apache/iotdb:0.13.3-node
-```
-
- `-v /opt/iotdb/data:/iotdb/data` 为tdengine数据目录本地持久化挂载，需将`/iotdb/data`替换为实际本地存在的目录
- 使用```$ docker ps```查看数据库是否启动成功
-
-3. 在hertzbeat的`application.yml`配置文件配置IoTDB数据库连接
-
- 配置HertzBeat的配置文件
- 修改位于 `hertzbeat/config/application.yml` 的配置文件
- 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地，安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可
-
-**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置`warehouse.store.iot-db`数据源参数，HOST账户密码等，并启用`enabled`为`true`**
-
-```yaml
-warehouse:
- store:
- # 关闭默认JPA
- jpa:
- enabled: false
- # 启用IotDB
- iot-db:
- enabled: true
- host: 127.0.0.1
- rpc-port: 6667
- username: root
- password: root
- # V_O_12 || V_0_13
- version: V_0_13
- # if iotdb version >= 0.13 use default queryTimeoutInMs = -1; else use default queryTimeoutInMs = 0
- query-timeout-in-ms: -1
- # 数据存储时间：默认'7776000000'（90天,单位为毫秒,-1代表永不过期）
- expire-time: '7776000000'
-```
-
-### 常见问题
-
-1. 时序数据库IoTDB和TDengine是否都需要配置，能不能都用
-> 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，只影响历史图表数据。
-
-2. 监控页面历史图表不显示，弹出 [无法提供历史图表数据，请配置依赖时序数据库]
-> 如弹窗所示，历史图表展示的前提是需要安装配置hertzbeat的依赖服务 - IotDB数据库或TDengine数据库
-
-3. 安装配置了IotDB数据库，但页面依旧显示弹出 [无法提供历史图表数据，请配置依赖时序数据库]
-> 请检查配置参数是否正确
-> iot-db enable是否设置为true
-> 注意⚠️若hertzbeat和IotDB都为docker容器在同一主机下启动，容器之间默认不能用127.0.0.1通讯，改为主机IP
-> 可根据logs目录下启动日志排查
diff --git a/home/versioned_docs/version-v1.1.x/start/mysql-change.md b/home/versioned_docs/version-v1.1.x/start/mysql-change.md
deleted file mode 100644
index 92aed428332..00000000000
--- a/home/versioned_docs/version-v1.1.x/start/mysql-change.md
+++ /dev/null
@@ -1,67 +0,0 @@
----
-id: mysql-change
-title: 依赖的关系型数据库 H2 切换 为MYSQL
-sidebar_label: 使用Mysql替换内置H2数据库(可选)
----
-MYSQL是一款值得信赖的关系型数据库，HertzBeat除了支持使用默认内置的H2数据库外，还可以切换为使用MYSQL存储监控信息，告警信息，配置信息等结构化关系数据。
-
-注意⚠️ 使用外置Mysql数据库替换内置H2数据库为可选项，但建议生产环境配置，以提供更好的性能
-
-> 如果您已有MYSQL环境，可直接跳到数据库创建那一步。
-
-### 通过Docker方式安装MYSQL
-1. 下载安装Docker环境
- Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。
- 安装完毕后终端查看Docker版本是否正常输出。
- ```
- $ docker -v
- Docker version 20.10.12, build e91ed57
- ```
-2. Docker安装MYSQl
- ```
- $ docker run -d --name mysql \
- -p 3306:3306 \
- -v /opt/data:/var/lib/mysql \
- -e MYSQL_ROOT_PASSWORD=123456 \
- --restart=always \
- mysql:5.7
- ```
- `-v /opt/data:/var/lib/mysql` 为mysql数据目录本地持久化挂载，需将`/opt/data`替换为实际本地存在的目录
- 使用```$ docker ps```查看数据库是否启动成功
-
-### 数据库创建
-1. 进入MYSQL或使用客户端连接MYSQL服务
- `mysql -uroot -p123456`
-2. 创建名称为hertzbeat的数据库
- `create database hertzbeat default charset utf8mb4 collate utf8mb4_general_ci;`
-3. 查看hertzbeat数据库是否创建成功
- `show databases;`
-
-### 修改hertzbeat的配置文件application.yml切换数据源
-
-1. 配置HertzBeat的配置文件
- 修改位于 `hertzbeat/config/application.yml` 的配置文件
- 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可
- 替换里面的`spring.database`数据源参数，IP端口账户密码驱动
- ⚠️注意`application.yml`文件内容需完整，除下方修改内容外其他参数需保留，完整内容见[/script/application.yml](https://gitee.com/hertzbeat/hertzbeat/raw/master/script/application.yml)
-
-需修改部分原参数:
-```yaml
-spring:
- datasource:
- driver-class-name: org.h2.Driver
- username: sa
- password: 123456
- url: jdbc:h2:./data/hertzbeat;MODE=MYSQL
-```
-具体替换参数如下,需根据mysql环境配置账户密码IP:
-```yaml
-spring:
- datasource:
- driver-class-name: com.mysql.cj.jdbc.Driver
- username: root
- password: 123456
- url: jdbc:mysql://localhost:3306/hertzbeat?useUnicode=true&characterEncoding=utf-8&useSSL=false
-```
-
-**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警，默认账户密码 admin/hertzbeat**
diff --git a/home/versioned_docs/version-v1.1.x/start/package-deploy.md b/home/versioned_docs/version-v1.1.x/start/package-deploy.md
deleted file mode 100644
index b3566ec2608..00000000000
--- a/home/versioned_docs/version-v1.1.x/start/package-deploy.md
+++ /dev/null
@@ -1,68 +0,0 @@
----
-id: package-deploy
-title: 通过安装包安装 HertzBeat
-sidebar_label: 安装包方式部署
----
-> HertzBeat支持在Linux Windows Mac系统安装运行，CPU支持X86/ARM64。
-> 由于安装包自身不包含JAVA运行环境，需您提前准备JAVA运行环境。
-
-1. 安装JAVA运行环境-可参考[官方网站](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
- 要求：JAVA11环境
- 下载JAVA安装包: [镜像站](https://repo.huaweicloud.com/java/jdk/)
- 安装后命令行检查是否成功安装
- ```
- $ java -version
- java version "11.0.12"
- Java(TM) SE Runtime Environment 18.9 (build 11.0.12+8-LTS-237)
- Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.12+8-LTS-237, mixed mode)
-
- ```
-2. 下载HertzBeat安装包
- 下载您系统环境对应的安装包
- - 从[GITEE Release](https://gitee.com/hertzbeat/hertzbeat/releases) 仓库下载
- - 从[GITHUB Release](https://github.com/apache/hertzbeat/releases) 仓库下载
-
-3. 配置HertzBeat的配置文件(可选)
- 解压安装包到主机 eg: /opt/hertzbeat
- ```
- $ tar zxvf hertzbeat-[版本号].tar.gz
- ```
- 修改位于 `hertzbeat/config/application.yml` 的配置文件(可选)，您可以根据需求修改配置文件
- - 若需使用邮件发送告警，需替换`application.yml`里面的邮件服务器参数
- - **推荐**若需使用外置Mysql数据库替换内置H2数据库，需替换`application.yml`里面的`spring.datasource`参数 具体步骤参见 [H2数据库切换为MYSQL](mysql-change)）
- - **推荐**若需使用时序数据库TDengine来存储指标数据，需替换`application.yml`里面的`warehouse.store.td-engine`参数 具体步骤参见 [使用TDengine存储指标数据](tdengine-init)
- - **推荐**若需使用时序数据库IotDB来存储指标数据库，需替换`application.yml`里面的`warehouse.storeiot-db`参数 具体步骤参见 [使用IotDB存储指标数据](iotdb-init)
-
-4. 配置用户配置文件(可选,自定义配置用户密码)
- HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat
- 若需要新增删除修改账户或密码，可以通过修改位于 `hertzbeat/config/sureness.yml` 的配置文件实现，若无此需求可忽略此步骤
- 具体参考 [配置修改账户密码](account-modify)
-
-5. 部署启动
- 执行位于安装目录hertzbeat/bin/下的启动脚本 startup.sh, windows环境下为 startup.bat
- ```
- $ ./startup.sh
- ```
-6. 开始探索HertzBeat
- 浏览器访问 http://ip:1157/ 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。
-
-**HAVE FUN**
-
-### 安装包部署常见问题
-
-**最多的问题就是网络问题，请先提前排查**
-
-1. **按照流程部署，访问 http://ip:1157/ 无界面**
- 请参考下面几点排查问题：
-> 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功
-> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确
-> 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈
-
-2. **日志报错TDengine连接或插入SQL失败**
-> 一：排查配置的数据库账户密码是否正确，数据库是否创建
-> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter
-
-3. **监控历史图表长时间都一直无数据**
-> 一：Tdengine或IoTDB是否配置，未配置则无历史图表数据
-> 二：若使用了Tdengine，排查Tdengine的数据库`hertzbeat`是否创建
-> 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 IotDB 或 Tdengine IP账户密码等配置是否正确
diff --git a/home/versioned_docs/version-v1.1.x/start/quickstart.md b/home/versioned_docs/version-v1.1.x/start/quickstart.md
deleted file mode 100644
index 135a762657b..00000000000
--- a/home/versioned_docs/version-v1.1.x/start/quickstart.md
+++ /dev/null
@@ -1,88 +0,0 @@
----
-id: quickstart
-title: 快速开始
-sidebar_label: 快速开始
----
-
-### 🐕 开始使用
-
-- 如果您不想部署而是直接使用，我们提供SAAS监控云-[TanCloud探云](https://console.tancloud.cn)，即刻[登录注册](https://console.tancloud.cn)免费使用。
-- 如果您是想将HertzBeat部署到内网环境搭建监控系统，请参考下面的部署文档进行操作。
-
-### 🐵 依赖服务部署(可选)
-
-> HertzBeat依赖于 **关系型数据库** H2(默认已内置无需安装) 或 [Mysql](mysql-change) 和 **时序性数据库** [TDengine2+](tdengine-init) 或 [IOTDB](iotdb-init) (可选)
-
-**注意⚠️ 若需要部署时序数据库，IotDB 和 TDengine 任选其一即可！**
-
-##### 安装Mysql(可选)
-
-1. docker安装Mysql
- ` $ docker run -d --name mysql -p 3306:3306 -v /opt/data:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=123456 mysql:5.7`
- `-v /opt/data:/var/lib/mysql` - 为mysql数据目录本地持久化挂载，需将`/opt/data`替换为实际本地存在的目录
-2. 创建名称为hertzbeat的数据库
- `create database hertzbeat default charset utf8mb4 collate utf8mb4_general_ci;`
-3. 在hertzbeat的配置文件`application.yml`配置Mysql数据库替换H2内置数据库连接参数
-
-详细步骤参考 [使用Mysql替换内置H2数据库](mysql-change)
-
-##### 安装TDengine(可选)
-
-1. docker安装TDengine
- `docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp --name tdengine tdengine/tdengine:2.4.0.12`
-2. 创建名称为hertzbeat的数据库
-3. 在hertzbeat的配置文件`application.yml`配置tdengine连接
-
-详细步骤参考 [使用时序数据库TDengine存储指标数据(可选)](tdengine-init)
-
-##### 安装IotDB(可选)
-
-1. Docker安装IoTDB
-
-```shell
-$ docker run -d -p 6667:6667 -p 31999:31999 -p 8181:8181 \
- -v /opt/iotdb/data:/iotdb/data \
- --name iotdb \
- apache/iotdb:0.13.3-node
-```
-
-详细步骤参考 [使用时序数据库IoTDB存储指标数据(可选)](iotdb-init)
-
-### 🍞 HertzBeat安装
-> HertzBeat支持通过源码安装启动，Docker容器运行和安装包方式安装部署，CPU架构支持X86/ARM64。
-
-#### 方式一：Docker方式快速安装
-
-1. `docker` 环境仅需一条命令即可开始
-
-`docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat`
-
-2. 浏览器访问 `localhost:1157` 即可开始，默认账号密码 `admin/hertzbeat`
-
-更多配置详细步骤参考 [通过Docker方式安装HertzBeat](docker-deploy)
-
-#### 方式二：通过安装包安装
-
-1. 下载您系统环境对应的安装包 [GITEE Release](https://gitee.com/hertzbeat/hertzbeat/releases) [GITHUB Release](https://github.com/apache/hertzbeat/releases)
-2. 需要已安装java环境, `jdk11`
-3. [可选]配置 HertzBeat 的配置文件 `hertzbeat/config/application.yml`
-4. 部署启动 `$ ./startup.sh `
-5. 浏览器访问 `localhost:1157` 即可开始，默认账号密码 `admin/hertzbeat`
-
-更多配置详细步骤参考 [通过安装包安装HertzBeat](package-deploy)
-
-#### 方式三：本地代码启动
-1. 此为前后端分离项目，本地代码调试需要分别启动后端工程manager和前端工程web-app
-2. 后端：需要`maven3+`, `java11`和`lombok`环境，修改YML配置信息并启动manager服务
-3. 前端：需要`nodejs npm angular-cli`环境，待本地后端启动后，在web-app目录下启动 `ng serve --open`
-4. 浏览器访问 `localhost:4200` 即可开始，默认账号密码 `admin/hertzbeat`
-
-详细步骤参考 [参与贡献之本地代码启动](../others/contributing)
-
-##### 方式四：Docker-Compose 统一安装 hertzbeat+mysql+iotdb/tdengine
-
-通过 [docker-compose部署脚本](https://github.com/apache/hertzbeat/tree/master/script/docker-compose) 一次性把 mysql 数据库, iotdb/tdengine 时序数据库和 hertzbeat 安装部署。
-
-详细步骤参考 [docker-compose部署方案](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/README.md)
-
-**HAVE FUN**
diff --git a/home/versioned_docs/version-v1.4.x/introduce.md b/home/versioned_docs/version-v1.4.x/introduce.md
index a72703e6a33..63a35e80ab9 100644
--- a/home/versioned_docs/version-v1.4.x/introduce.md
+++ b/home/versioned_docs/version-v1.4.x/introduce.md
@@ -11,7 +11,7 @@ slug: /
[](https://www.reddit.com/r/hertzbeat/)
[](https://twitter.com/hertzbeat1024)
[](https://www.bestpractices.dev/projects/8139)
-[](https://hub.docker.com/repository/docker/apache/hertzbeat/general)
+[](https://hub.docker.com/r/apache/hertzbeat)
[](https://artifacthub.io/packages/search?repo=hertzbeat)
[](https://qm.qq.com/q/FltGGGIX2m)
[](https://www.youtube.com/channel/UCri75zfWX0GHqJFPENEbLow)
diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http-default.md b/home/versioned_docs/version-v1.5.x/advanced/extend-http-default.md
similarity index 93%
rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http-default.md
rename to home/versioned_docs/version-v1.5.x/advanced/extend-http-default.md
index ba3df44cd68..cb8cec5b7aa 100644
--- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http-default.md
+++ b/home/versioned_docs/version-v1.5.x/advanced/extend-http-default.md
@@ -1,10 +1,10 @@
---
id: extend-http-default
title: HTTP Protocol System Default Parsing Method
-sidebar_label: System Default Parsing Method
+sidebar_label: Default Parsing Method
---
-> After calling the HTTP interface to obtain the response data, use the default parsing method of hertzbeat to parse the response data.
+> After calling the HTTP api to obtain the response data, use the default parsing method of hertzbeat to parse the response data.
**The interface response data structure must be consistent with the data structure rules specified by hertzbeat**
@@ -76,7 +76,7 @@ If there are multiple virtual machines, the multilayer format is: :
]
```
-**The corresponding monitoring configuration definition file YML can be configured as follows**
+**The corresponding monitoring template yml can be configured as follows**
```yaml
# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring
@@ -122,7 +122,7 @@ metrics:
# Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit
- field: hostname
type: 1
- instance: true
+ label: true
- field: usage
type: 0
unit: '%'
diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-hertzbeat.md b/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-hertzbeat.md
new file mode 100644
index 00000000000..4c65e29b8da
--- /dev/null
+++ b/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-hertzbeat.md
@@ -0,0 +1,237 @@
+---
+id: extend-http-example-hertzbeat
+title: Tutorial 1 Adapting a monitoring type based on HTTP protocol
+sidebar_label: Tutorial 1 Adapting an HTTP protocol monitoring
+---
+
+Through this tutorial, we describe step by step how to add a monitoring type based on the http protocol under the hertzbeat monitoring tool.
+
+Before reading this tutorial, we hope that you are familiar with how to customize types, metrics, protocols, etc. from [Custom Monitoring](extend-point) and [http Protocol Customization](extend-http).
+
+
+### HTTP protocol parses the general response structure to obtain metric data
+
+> In many scenarios, we need to monitor the provided HTTP API interface and obtain the index value returned by the interface. In this article, we use the http custom protocol to parse our common http interface response structure, and obtain the fields in the returned body as metric data.
+
+
+```
+{
+ "code": 200,
+ "msg": "success",
+ "data": {}
+}
+
+```
+As above, usually our background API interface will design such a general return. The same is true for the background of the hertzbeat system. Today, we will use the hertzbeat API as an example, add a new monitoring type **hertzbeat**, and monitor and collect its system summary statistics API
+`http://localhost:1157/api/summary`, the response data is:
+
+```
+{
+ "msg": null,
+ "code": 0,
+ "data": {
+ "apps": [
+ {
+ "category": "service",
+ "app": "jvm",
+ "status": 0,
+ "size": 2,
+ "availableSize": 0,
+ "unManageSize": 2,
+ "unAvailableSize": 0,
+ "unReachableSize": 0
+ },
+ {
+ "category": "service",
+ "app": "website",
+ "status": 0,
+ "size": 2,
+ "availableSize": 0,
+ "unManageSize": 2,
+ "unAvailableSize": 0,
+ "unReachableSize": 0
+ }
+ ]
+ }
+}
+```
+
+**This time we get the metric data such as `category`, `app`, `status`, `size`, `availableSize` under the app. **
+
+### Add custom monitoring template `hertzbeat`
+
+**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type**
+
+> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring.
+
+
+> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc.
+
+
+Here we define a custom monitoring type `app` named `hertzbeat` which use the HTTP protocol to collect data.
+
+**Monitoring Templates** -> **Config New Monitoring Template Yml** -> **Save and Apply**
+
+
+```yaml
+# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring
+category: custom
+# The monitoring type eg: linux windows tomcat mysql aws...
+app: hertzbeat
+# The monitoring i18n name
+name:
+ zh-CN: HertzBeat监控系统
+ en-US: HertzBeat Monitor
+# Input params define for monitoring(render web ui by the definition)
+params:
+ # field-param field key
+ - field: host
+ # name-param field display i18n name
+ name:
+ zh-CN: 主机Host
+ en-US: Host
+ # type-param field type(most mapping the html input type)
+ type: host
+ # required-true or false
+ required: true
+ # field-param field key
+ - field: port
+ # name-param field display i18n name
+ name:
+ zh-CN: 端口
+ en-US: Port
+ # type-param field type(most mapping the html input type)
+ type: number
+ # when type is number, range is required
+ range: '[0,65535]'
+ # required-true or false
+ required: true
+ # default value
+ defaultValue: 1157
+ - field: ssl
+ name:
+ zh-CN: 启用HTTPS
+ en-US: HTTPS
+ type: boolean
+ required: true
+ - field: timeout
+ name:
+ zh-CN: 超时时间(ms)
+ en-US: Timeout(ms)
+ type: number
+ required: false
+ hide: true
+ - field: authType
+ name:
+ zh-CN: 认证方式
+ en-US: Auth Type
+ type: radio
+ required: false
+ hide: true
+ options:
+ - label: Basic Auth
+ value: Basic Auth
+ - label: Digest Auth
+ value: Digest Auth
+ - field: username
+ name:
+ zh-CN: 用户名
+ en-US: Username
+ type: text
+ limit: 50
+ required: false
+ hide: true
+ - field: password
+ name:
+ zh-CN: 密码
+ en-US: Password
+ type: password
+ required: false
+ hide: true
+metrics:
+ # the first metrics summary
+ # attention: Built-in monitoring metrics contains (responseTime - Response time)
+ - name: summary
+ # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel
+ # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue
+ priority: 0
+ # collect metrics content
+ fields:
+ # metrics content contains field-metric name, type-metric type:0-number,1-string, label-if is metrics label, unit-metric unit('%','ms','MB')
+ - field: app
+ type: 1
+ label: true
+ - field: category
+ type: 1
+ - field: status
+ type: 0
+ - field: size
+ type: 0
+ - field: availableSize
+ type: 0
+ # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk, we use HTTP protocol here
+ protocol: http
+ # the config content when protocol is http
+ http:
+ # http host: ipv4 ipv6 domain
+ host: ^_^host^_^
+ # http port
+ port: ^_^port^_^
+ # http url, we don't need to enter a parameter here, just set the fixed value to /api/summary
+ url: /api/summary
+ timeout: ^_^timeout^_^
+ # http method: GET POST PUT DELETE PATCH, default fixed value is GET
+ method: GET
+ # if enabled https, default value is false
+ ssl: ^_^ssl^_^
+ # http auth
+ authorization:
+ # http auth type: Basic Auth, Digest Auth, Bearer Token
+ type: ^_^authType^_^
+ basicAuthUsername: ^_^username^_^
+ basicAuthPassword: ^_^password^_^
+ digestAuthUsername: ^_^username^_^
+ digestAuthPassword: ^_^password^_^
+ # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, we use jsonpath to parse response data here
+ parseType: jsonPath
+ parseScript: '$.data.apps.*'
+
+```
+
+**The addition is complete, now we save and apply. We can see that the system page has added a `hertzbeat` monitoring type. **
+
+
+
+
+
+### The system page adds the monitoring of `hertzbeat` monitoring type
+
+> We click Add `HertzBeat Monitoring Tool`, configure monitoring IP, port, collection cycle, account password in advanced settings, etc., click OK to add monitoring.
+
+
+
+
+
+
+
+> After a certain period of time (depending on the collection cycle), we can see the specific metric data and historical charts in the monitoring details!
+
+
+
+
+
+
+### Set threshold alarm notification
+
+> Next, we can set the threshold normally. After the alarm is triggered, we can view it in the alarm center, add recipients, set alarm notifications, etc. Have Fun!!!
+
+
+----
+
+#### over!
+
+This is the end of the practice of custom monitoring of the HTTP protocol. The HTTP protocol also has other parameters such as headers and params. We can define it like postman, and the playability is also very high!
+
+If you think hertzbeat is a good open source project, please star us on GitHub Gitee, thank you very much.
+
+**github: https://github.com/apache/hertzbeat**
diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http-example-token.md b/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-token.md
similarity index 88%
rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http-example-token.md
rename to home/versioned_docs/version-v1.5.x/advanced/extend-http-example-token.md
index 2d8389e193d..b9bbb61e72d 100644
--- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http-example-token.md
+++ b/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-token.md
@@ -4,9 +4,9 @@ title: Tutorial 2 Obtain TOKEN index value based on HTTP protocol for subsequent
sidebar_label: Tutorial 2 Get TOKEN for subsequent authentication
---
-Through this tutorial, we will describe step by step how to modify on the basis of tutorial 1, add an metrics, first call the authentication interface to obtain the TOKEN, and use the TOKEN as a parameter for the subsequent metrics collection and authentication.
+Through this tutorial, we will describe step by step how to modify on the basis of tutorial 1, add metrics, first call the authentication interface to obtain the TOKEN, and use the TOKEN as a parameter for the subsequent metrics collection and authentication.
-Before reading this tutorial, we hope that you are familiar with how to customize types, metrics, protocols, etc. from [Custom Monitoring] (extend-point) and [http Protocol Customization] (extend-http).
+Before reading this tutorial, we hope that you are familiar with how to customize types, metrics, protocols, etc. from [Custom Monitoring](extend-point) and [http Protocol Customization](extend-http).
### Request process
@@ -37,12 +37,19 @@ Before reading this tutorial, we hope that you are familiar with how to customiz
### Add custom monitoring type `hertzbeat_token`
-1. The custom monitoring type needs to add a new configuration YML file. We directly reuse the `hertzbeat` monitoring type in Tutorial 1 and modify it based on it
+**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type**
-A monitoring configuration definition file named after the monitoring type - app-hertzbeat_token.yml needs to be located in the installation directory /hertzbeat/define/
+> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring.
-The monitoring configuration definition file is used to define the collection type, which protocol collection method needs to be used, the collection metrics, protocol configuration parameters, etc.
-We directly reuse the definition content in app-hertzbeat.yml and modify it to our current monitoring type `hertzbeat_auth` configuration parameters, such as `app, category, etc`.
+
+> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc.
+
+
+1. The custom monitoring type needs to add a new configuration monitoring template yml. We directly reuse the `hertzbeat` monitoring type in Tutorial 1 and modify it based on it
+
+A monitoring configuration definition file named after the monitoring type - hertzbeat_token
+
+We directly reuse the definition content in `hertzbeat` and modify it to our current monitoring type `hertzbeat_auth` configuration parameters, such as `app, category, etc`.
```yaml
# This monitoring type belongs to the category: service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring
@@ -103,7 +110,7 @@ metrics: ....
### Define metrics `auth` login request to get `token`
-1. Add an index group definition `auth` in `app-hertzbeat_token.yml`, set the collection priority to the highest 0, and collect the index `token`.
+1. Add an index group definition `auth` in `hertzbeat_token`, set the collection priority to the highest 0, and collect the index `token`.
```yaml
@@ -196,7 +203,7 @@ metrics:
```
-**At this time, restart the hertzbeat system, add `hertzbeat_token` type monitoring on the system page, configure input parameters, `content-type` fill in `application/json`, `request Body` fill in the account password json as follows: **
+**At this time, save and apply, add `hertzbeat_token` type monitoring on the system page, configure input parameters, `content-type` fill in `application/json`, `request Body` fill in the account password json as follows: **
```json
{
@@ -233,7 +240,7 @@ metrics:
bearerTokenToken: ^o^token^o^
```
-**The final `app-hertzbeat_token.yml` is defined as follows:**
+**The final `hertzbeat_token` template yml is defined as follows:**
```yaml
@@ -368,7 +375,7 @@ metrics:
```
-**After the configuration is complete, restart the `hertzbeat` system again, and check the monitoring details page**
+**After the configuration is complete, save and apply, and check the monitoring details page**
@@ -384,8 +391,6 @@ metrics:
This is the end of the practice of custom monitoring of the HTTP protocol. The HTTP protocol also has other parameters such as headers and params. We can define it like postman, and the playability is also very high!
-If you think hertzbeat is a good open source project, please star us on GitHub Gitee, thank you very much. Thanks for the old iron support. Refill!
+If you think hertzbeat is a good open source project, please star us on GitHub Gitee, thank you very much.
**github: https://github.com/apache/hertzbeat**
-
-**gitee: https://gitee.com/hertzbeat/hertzbeat**
diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http-jsonpath.md b/home/versioned_docs/version-v1.5.x/advanced/extend-http-jsonpath.md
similarity index 94%
rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http-jsonpath.md
rename to home/versioned_docs/version-v1.5.x/advanced/extend-http-jsonpath.md
index c38a5582d06..772c96d20d3 100644
--- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http-jsonpath.md
+++ b/home/versioned_docs/version-v1.5.x/advanced/extend-http-jsonpath.md
@@ -3,7 +3,7 @@ id: extend-http-jsonpath
title: HTTP Protocol JsonPath Parsing Method
sidebar_label: JsonPath Parsing Method
---
-> After calling the HTTP interface to obtain the response data, use JsonPath script parsing method to parse the response data.
+> After calling the HTTP api to obtain the response data, use JsonPath script parsing method to parse the response data.
Note⚠️ The response data is JSON format.
@@ -80,7 +80,7 @@ The raw data returned by the interface is as follows：
}
```
-We use the jsonpath script to parse, and the corresponding script is: `$.number[*]` ，The parsed data structure is as follows：
+We use the jsonpath script to parse, and the corresponding script is: `$.number[*]`，The parsed data structure is as follows：
```json
[
{
@@ -95,7 +95,7 @@ We use the jsonpath script to parse, and the corresponding script is: `$.number[
```
This data structure conforms to the data format specification of HertzBeat, and the Metric `type,num` is successfully extracted.
-**The corresponding monitoring configuration definition file YML can be configured as follows**
+**The corresponding monitoring template yml can be configured as follows**
```yaml
# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring
@@ -141,7 +141,7 @@ metrics:
# Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit
- field: type
type: 1
- instance: true
+ label: true
- field: num
type: 0
# protocol for monitoring and collection eg: sql, ssh, http, telnet, wmi, snmp, sdk
diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http.md b/home/versioned_docs/version-v1.5.x/advanced/extend-http.md
similarity index 84%
rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http.md
rename to home/versioned_docs/version-v1.5.x/advanced/extend-http.md
index de20f82d944..242b63e8cf0 100644
--- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http.md
+++ b/home/versioned_docs/version-v1.5.x/advanced/extend-http.md
@@ -7,7 +7,8 @@ sidebar_label: HTTP Protocol Custom Monitoring
> From [Custom Monitoring](extend-point), you are familiar with how to customize types, Metrics, protocols, etc. Here we will introduce in detail how to use HTTP protocol to customize Metric monitoring
### HTTP protocol collection process
-【**call HTTP interface**】->【**response verification **】->【**parse reponse data**】->【**default method parsing｜JsonPath script parsing | XmlPath parsing(todo) | Prometheus parsing(todo)**】->【**Metric data extraction**】
+
+【**Call HTTP API**】->【**Response Verification**】->【**Parse Response Data**】->【**Default method parsing｜JsonPath script parsing | XmlPath parsing(todo) | Prometheus parsing**】->【**Metric data extraction**】
It can be seen from the process that we define a monitoring type of HTTP protocol. We need to configure HTTP request parameters, configure which Metrics to obtain, and configure the parsing method and parsing script for response data.
HTTP protocol supports us to customize HTTP request path, request header, request parameters, request method, request body, etc.
@@ -18,19 +19,22 @@ HTTP protocol supports us to customize HTTP request path, request header, reques
### Custom Steps
-In order to configure a custom monitoring type, you need to add and configure YML file.
-1. Monitoring configuration definition file named after monitoring type - eg：example.yml in the installation directory /hertzbeat/define/
-2. Restart hertzbeat system, we successfully fit a new custom monitoring type.
+**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type**
-------
-Configuration usages of the two files are detailed below. Please pay attention to usage annotation.
-### Monitoring configuration definition file
+Configuration usages of the monitoring templates yml are detailed below. Please pay attention to usage annotation.
+
+### Monitoring Templates YML
+
+> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring.
+
+
+> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc.
-> Monitoring configuration definition file is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc.
+eg：Define a custom monitoring type `app` named `example_http` which use the HTTP protocol to collect data.
-eg：Define a custom monitoring type named example_http which use the HTTP protocol to collect data.
-The file name: example_http.yml in /define/example_http.yml
+**Monitoring Templates** -> **Config New Monitoring Template Yml** -> **Save and Apply**
```yaml
# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring
@@ -69,7 +73,7 @@ params:
en-US: Username
type: text
# When type is text, use limit to indicate the string limit size
- limit: 20
+ limit: 50
required: false
- field: password
name:
@@ -113,7 +117,7 @@ metrics:
# Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit
- field: hostname
type: 1
- instance: true
+ label: true
- field: usage
type: 0
unit: '%'
@@ -174,7 +178,7 @@ metrics:
fields:
- field: hostname
type: 1
- instance: true
+ label: true
- field: total
type: 0
unit: kb
@@ -191,6 +195,7 @@ metrics:
method: GET
headers:
apiVersion: v1
+ # query params,support time expression
params:
param1: param1
param2: param2
diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-jdbc.md b/home/versioned_docs/version-v1.5.x/advanced/extend-jdbc.md
similarity index 90%
rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-jdbc.md
rename to home/versioned_docs/version-v1.5.x/advanced/extend-jdbc.md
index 89db9658a98..3527ba60d5d 100644
--- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-jdbc.md
+++ b/home/versioned_docs/version-v1.5.x/advanced/extend-jdbc.md
@@ -49,19 +49,20 @@ Here by mapping the Metric field with the key of the response data, we can obta
### Custom Steps
-In order to configure a custom monitoring type, you need to add and configure YML file.
-1. Monitoring configuration definition file named after monitoring type - eg：example_sql.yml in the installation directory /hertzbeat/app/
-2. Restart hertzbeat system, we successfully fit a new custom monitoring type.
+**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type**
-------
-Configuration usages of the file is detailed below. Please pay attention to usage annotation.
+Configuration usages of the monitoring templates yml are detailed below.
-### Monitoring configuration definition file
+### Monitoring Templates YML
-> Monitoring configuration definition file is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc.
+> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring.
-eg：Define a custom monitoring type named example_sql which use the JDBC protocol to collect data.
-The file name: example_sql.yml in /define/example_sql.yml
+
+> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc.
+
+eg：Define a custom monitoring type `app` named `example_sql` which use the JDBC protocol to collect data.
+
```yaml
# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring
@@ -99,7 +100,7 @@ params:
zh-CN: 用户名
en-US: Username
type: text
- limit: 20
+ limit: 50
required: false
- field: password
name:
@@ -124,7 +125,7 @@ metrics:
# Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit
- field: version
type: 1
- instance: true
+ label: true
- field: port
type: 1
- field: datadir
diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-jmx.md b/home/versioned_docs/version-v1.5.x/advanced/extend-jmx.md
new file mode 100644
index 00000000000..5284118f8a7
--- /dev/null
+++ b/home/versioned_docs/version-v1.5.x/advanced/extend-jmx.md
@@ -0,0 +1,193 @@
+---
+id: extend-jmx
+title: JMX Protocol Custom Monitoring
+sidebar_label: JMX Protocol Custom Monitoring
+---
+> From [Custom Monitoring](extend-point), you are familiar with how to customize types, Metrics, protocols, etc. Here we will introduce in detail how to use JMX to customize Metric monitoring.
+> JMX protocol custom monitoring allows us to easily monitor Metrics we want by config JMX Mbeans Object.
+
+### JMX protocol collection process
+【**Peer Server Enable Jmx Service**】->【**HertzBeat Connect Peer Server Jmx**】->【**Query Jmx Mbean Object Data**】->【**Metric data extraction**】
+
+It can be seen from the process that we define a monitoring type of JMX protocol. We need to configure JMX request parameters, configure which Metrics to obtain, and configure Mbeans Object.
+
+### Data parsing method
+
+By configuring the monitoring template YML metrics `field`, `aliasFields`, `objectName` of the `jmx` protocol to map and parse the `Mbean` object information exposed by the peer system.
+
+### Custom Steps
+
+**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type**
+
+
+
+-------
+Configuration usages of the monitoring templates yml are detailed below.
+
+### Monitoring Templates YML
+
+> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring.
+
+
+> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc.
+
+eg：Define a custom monitoring type `app` named `example_jvm` which use the JVM protocol to collect data.
+
+
+```yaml
+# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring
+category: service
+# The monitoring type eg: linux windows tomcat mysql aws...
+app: example_jvm
+# The monitoring i18n name
+name:
+ zh-CN: 自定义JVM虚拟机
+ en-US: CUSTOM JVM
+# Input params define for monitoring(render web ui by the definition)
+params:
+ # field-param field key
+ - field: host
+ # name-param field display i18n name
+ name:
+ zh-CN: 主机Host
+ en-US: Host
+ # type-param field type(most mapping the html input type)
+ type: host
+ # required-true or false
+ required: true
+ # field-param field key
+ - field: port
+ # name-param field display i18n name
+ name:
+ zh-CN: 端口
+ en-US: Port
+ # type-param field type(most mapping the html input type)
+ type: number
+ # when type is number, range is required
+ range: '[0,65535]'
+ # required-true or false
+ required: true
+ # default value
+ defaultValue: 9999
+ # field-param field key
+ - field: url
+ # name-param field display i18n name
+ name:
+ zh-CN: JMX URL
+ en-US: JMX URL
+ # type-param field type(most mapping the html input type)
+ type: text
+ # required-true or false
+ required: false
+ # hide param-true or false
+ hide: true
+ # param field input placeholder
+ placeholder: 'service:jmx:rmi:///jndi/rmi://host:port/jmxrmi'
+ # field-param field key
+ - field: username
+ # name-param field display i18n name
+ name:
+ zh-CN: 用户名
+ en-US: Username
+ # type-param field type(most mapping the html input type)
+ type: text
+ # when type is text, use limit to limit string length
+ limit: 50
+ # required-true or false
+ required: false
+ # hide param-true or false
+ hide: true
+ # field-param field key
+ - field: password
+ # name-param field display i18n name
+ name:
+ zh-CN: 密码
+ en-US: Password
+ # type-param field type(most mapping the html input tag)
+ type: password
+ # required-true or false
+ required: false
+ # hide param-true or false
+ hide: true
+# collect metrics config list
+metrics:
+ # metrics - basic
+ - name: basic
+ # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel
+ # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue
+ priority: 0
+ # collect metrics content
+ fields:
+ # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-if is metrics label
+ - field: VmName
+ type: 1
+ - field: VmVendor
+ type: 1
+ - field: VmVersion
+ type: 1
+ - field: Uptime
+ type: 0
+ unit: ms
+ # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
+ protocol: jmx
+ # the config content when protocol is jmx
+ jmx:
+ # host: ipv4 ipv6 domain
+ host: ^_^host^_^
+ # port
+ port: ^_^port^_^
+ username: ^_^username^_^
+ password: ^_^password^_^
+ # jmx mbean object name
+ objectName: java.lang:type=Runtime
+ url: ^_^url^_^
+
+ - name: memory_pool
+ priority: 1
+ fields:
+ - field: name
+ type: 1
+ label: true
+ - field: committed
+ type: 0
+ unit: MB
+ - field: init
+ type: 0
+ unit: MB
+ - field: max
+ type: 0
+ unit: MB
+ - field: used
+ type: 0
+ unit: MB
+ units:
+ - committed=B->MB
+ - init=B->MB
+ - max=B->MB
+ - used=B->MB
+ # (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field
+ aliasFields:
+ - Name
+ - Usage->committed
+ - Usage->init
+ - Usage->max
+ - Usage->used
+ # mapping and conversion expressions, use these and aliasField above to calculate metrics value
+ # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime
+ calculates:
+ - name=Name
+ - committed=Usage->committed
+ - init=Usage->init
+ - max=Usage->max
+ - used=Usage->used
+ protocol: jmx
+ jmx:
+ # host: ipv4 ipv6 domain
+ host: ^_^host^_^
+ # port
+ port: ^_^port^_^
+ username: ^_^username^_^
+ password: ^_^password^_^
+ objectName: java.lang:type=MemoryPool,name=*
+ url: ^_^url^_^
+```
diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-ngql.md b/home/versioned_docs/version-v1.5.x/advanced/extend-ngql.md
new file mode 100644
index 00000000000..c07c5ae8ca0
--- /dev/null
+++ b/home/versioned_docs/version-v1.5.x/advanced/extend-ngql.md
@@ -0,0 +1,167 @@
+---
+id: extend-ngql
+title: NGQL Custom Monitoring
+sidebar_label: NGQL Custom Monitoring
+---
+
+> From [Custom Monitoring](extend-point), you are familiar with how to customize types, Metrics, protocols, etc. Here we will introduce in detail how to use JDBC(support mysql,mariadb,postgresql,sqlserver at present) to customize Metric monitoring.
+> NGQL custom monitoring allows us to easily query metric data from the NebulaGraph graph database using NGQL or OpenCypher, supporting NebulaGraph 3.X versions.
+
+### Data Parsing Methods
+
+Mapping the fields returned by NGQL queries to the metrics we need allows us to obtain corresponding metric data. Currently, there are four mapping and parsing methods: filterCount, oneRow, multiRow, columns.
+
+#### **filterCount**
+
+> Counts the number of results returned by a query based on specified fields, usually used in `SHOW ...` statements. If NGQL statements can directly return the count, it is recommended to use NGQL statements for counting.
+> Syntax for the `commands` field: aliasField#NGQL#filterName#filterValue
+> `aliasField`: corresponds to the value in the `aliasFields` in the monitoring template
+> `NGQL`: query statement
+> `filterName`: filter attribute name (optional)
+> `filterValue`: filter attribute value (optional)
+
+For example:
+- online_meta_count#SHOW HOSTS META#Status#ONLINE
+ Counts the number of rows returned by `SHOW HOSTS META` where Status equals ONLINE.
+- online_meta_count#SHOW HOSTS META##
+ Counts the number of rows returned by `SHOW HOSTS META`.
+
+#### **oneRow**
+
+> Queries a single row of data by mapping the column names of the query result set to the queried fields.
+
+For example:
+- Metrics fields: a, b
+- NGQL query: match (v:metrics) return v.metrics.a as a, v.metrics.b as b;
+
+Here, the metric fields can be mapped to the response data row by row.
+
+Notes:
+- When using the `oneRow` method, if a single query statement returns multiple rows of results, only the first row of results will be mapped to the metric fields.
+- When the `commands` field contains two or more query statements and the returned fields of multiple query statements are the same, the fields returned by the subsequent statement will overwrite those returned by the previous statement.
+- It is recommended to use the limit statement to limit the number of rows returned in the result set when defining `commands`.
+
+#### **multiRow**
+
+> Queries multiple rows of data by mapping the column names of the query result set to the queried fields.
+
+For example:
+- Metrics fields: a, b
+- NGQL query: match (v:metrics) return v.metrics.a as a, v.metrics.b as b;
+
+Here, the metric fields can be mapped to the response data row by row.
+Notes:
+- When using the `multiRow` method, the `commands` field can only contain one query statement.
+
+#### **columns**
+
+> Collects a single row of metric data by mapping two columns of data (key-value), where the key matches the queried fields and the value is the value of the queried field.
+
+Notes:
+- When using the `columns` method, the first two columns of the result set are mapped to collect data by default, where the first column corresponds to the metric name and the second column corresponds to the metric value.
+- When the `commands` field contains two or more query statements and the first column of data returned by multiple query statements is duplicated, the result of the last statement will be retained.
+
+### Customization Steps
+
+**HertzBeat Page** -> **Monitoring Template Menu** -> **Add Monitoring Type** -> **Configure Custom Monitoring Template YML** -> **Click Save Application** -> **Use the New Monitoring Type to Add Monitoring**
+
+
+
+-------
+Configuration usages of the monitoring templates yml are detailed below.
+
+### Monitoring Template YML
+
+> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring.
+> Monitoring template is used to define the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information, etc.
+
+eg: Customize a monitoring type named example_ngql, which collects metric data using NGQL.
+
+```yaml
+# Monitoring category: service-application service program-application program db-database custom-custom os-operating system bigdata-big data mid-middleware webserver-web server cache-cache cn-cloud native network-network monitoring, etc.
+category: db
+# Monitoring application type (consistent with the file name) eg: linux windows tomcat mysql aws...
+app: example_ngql
+name:
+ zh-CN: NGQL Custom Monitoring Application
+ en-US: NGQL Custom APP
+# Monitoring parameter definition. These are input parameter variables, which can be written in the format of ^_^host^_^ to be replaced by system variable values in the later configuration
+# This part is usually not modified
+params:
+ # field-param field key
+ - field: host
+ name:
+ zh-CN: Target Host
+ en-US: Target Host
+ type: host
+ required: true
+ - field: graphPort
+ name:
+ zh-CN: Graph Port
+ en-US: Graph Port
+ type: number
+ range: '[0,65535]'
+ required: true
+ defaultValue: 9669
+ - field: username
+ name:
+ zh-CN: Username
+ en-US: Username
+ type: text
+ required: true
+ - field: password
+ name:
+ zh-CN: Password
+ en-US: Password
+ type: password
+ required: true
+ - field: spaceName
+ name:
+ zh-CN: Space Name
+ en-US: Space Name
+ type: text
+ required: false
+ - field: timeout
+ name:
+ zh-CN: Connect Timeout(ms)
+ en-US: Connect Timeout(ms)
+ type: number
+ unit: ms
+ range: '[0,100000]'
+ required: true
+ defaultValue: 6000
+# Metric collection configuration list
+metrics:
+ - name: base_info
+ i18n:
+ zh-CN: Vertex statistics
+ en-US: Vertex statistics
+ priority: 0
+ fields:
+ - field: tag1
+ type: 1
+ i18n:
+ zh-CN: tag1
+ en-US: tag1
+ - field: tag1
+ type: 1
+ i18n:
+ zh-CN: tag2
+ en-US: tag2
+ aliasFields:
+ - tag1
+ - tag2
+ protocol: ngql
+ ngql:
+ host: ^_^host^_^
+ username: ^_^username^_^
+ password: ^_^password^_^
+ port: ^_^graphPort^_^
+ spaceName: ^_^spaceName^_^
+ parseType: columns
+ # Define the query statements used to collect data
+ commands:
+ - match (v:tag1) return "tag1" as name ,count(v) as cnt
+ - match (v:tag2) return "tag2" as name ,count(v) as cnt
+ timeout: ^_^timeout^_^
+```
diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-point.md b/home/versioned_docs/version-v1.5.x/advanced/extend-point.md
new file mode 100644
index 00000000000..eba1811e4fc
--- /dev/null
+++ b/home/versioned_docs/version-v1.5.x/advanced/extend-point.md
@@ -0,0 +1,134 @@
+---
+id: extend-point
+title: Custom Monitoring
+sidebar_label: Custom Monitoring
+---
+> HertzBeat has custom monitoring ability. You only need to configure monitoring template yml to fit a custom monitoring type.
+> Custom monitoring currently supports [HTTP protocol](extend-http)，[JDBC protocol](extend-jdbc), [SSH protocol](extend-ssh), [JMX protocol](extend-jmx), [SNMP protocol](extend-snmp). And it will support more general protocols in the future.
+
+### Custom Monitoring Steps
+
+**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type**
+
+
+-------
+
+Configuration usages of the monitoring templates yml are detailed below.
+
+### Monitoring Templates YML
+
+> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring.
+
+
+> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc.
+
+eg：Define a custom monitoring type `app` named `example2` which use the HTTP protocol to collect data.
+
+**Monitoring Templates** -> **Config New Monitoring Template Yml** -> **Save and Apply**
+
+
+```yaml
+# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring
+category: custom
+# The monitoring type eg: linux windows tomcat mysql aws...
+app: example2
+# The monitoring i18n name
+name:
+ zh-CN: 模拟网站监测
+ en-US: EXAMPLE WEBSITE
+# Input params define for monitoring(render web ui by the definition)
+params:
+ # field-param field key
+ - field: host
+ # name-param field display i18n name
+ name:
+ zh-CN: 主机Host
+ en-US: Host
+ # type-param field type(most mapping the html input type)
+ type: host
+ # required-true or false
+ required: true
+ # field-param field key
+ - field: port
+ # name-param field display i18n name
+ name:
+ zh-CN: 端口
+ en-US: Port
+ # type-param field type(most mapping the html input type)
+ type: number
+ # when type is number, range is required
+ range: '[0,65535]'
+ # required-true or false
+ required: true
+ # default value
+ defaultValue: 80
+ # field-param field key
+ - field: uri
+ # name-param field display i18n name
+ name:
+ zh-CN: 相对路径
+ en-US: URI
+ # type-param field type(most mapping the html input tag)
+ type: text
+ # when type is text, use limit to limit string length
+ limit: 200
+ # required-true or false
+ required: false
+ # param field input placeholder
+ placeholder: 'Website uri path(no ip port) EG:/console'
+ # field-param field key
+ - field: ssl
+ # name-param field display i18n name
+ name:
+ zh-CN: 启用HTTPS
+ en-US: HTTPS
+ # type-param field type(most mapping the html input type)
+ type: boolean
+ # required-true or false
+ required: true
+ # field-param field key
+ - field: timeout
+ # name-param field display i18n name
+ name:
+ zh-CN: 超时时间(ms)
+ en-US: Timeout(ms)
+ # type-param field type(most mapping the html input tag)
+ type: number
+ # required-true or false
+ required: false
+ # hide param-true or false
+ hide: true
+
+metrics:
+ # metrics - summary, inner monitoring metrics (responseTime - response time, keyword - number of keywords)
+ - name: summary
+ # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel
+ # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue
+ priority: 0
+ # collect metrics content
+ fields:
+ # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-if is metrics label
+ - field: responseTime
+ type: 0
+ unit: ms
+ - field: keyword
+ type: 0
+ # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
+ protocol: http
+ # the config content when protocol is http
+ http:
+ # http host: ipv4 ipv6 domain
+ host: ^_^host^_^
+ # http port
+ port: ^_^port^_^
+ # http url
+ url: ^_^uri^_^
+ timeout: ^_^timeout^_^
+ # http method: GET POST PUT DELETE PATCH
+ method: GET
+ # if enabled https
+ ssl: ^_^ssl^_^
+ # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule
+ parseType: website
+
+```
diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-push.md b/home/versioned_docs/version-v1.5.x/advanced/extend-push.md
new file mode 100644
index 00000000000..18e190d7f5d
--- /dev/null
+++ b/home/versioned_docs/version-v1.5.x/advanced/extend-push.md
@@ -0,0 +1,26 @@
+---
+id: extend-push
+title: Push Style Custom Monitoring
+sidebar_label: Push Style Custom Monitoring
+---
+
+> Push style curstom monitor is a type of monitor which allow user to configure metrics format and push metrics to hertzbeat with their own service.
+> Here we will introduce how to use this feature.
+
+### Push style custom monitor collection process
+
+【Peer Server Start Pushing Metrics】 -> 【HertzBeat Push Module Stage Metrics】-> 【HertzBeat Collect Module collect Metrics Periodically】
+
+### Data parsing method
+
+HertzBeat will parsing metrics with the format configured by user while adding new monitor.
+
+### Create Monitor Steps
+
+HertzBeat DashBoard -> Service Monitor -> Push Style Monitor -> New Push Style Monitor -> set Push Module Host (hertzbeat server ip, usually 127.0.0.1/localhost) -> set Push Module Port (hertzbeat server port, usually 1157) -> configure metrics field (unit: string, type: 0 number / 1 string) -> end
+
+---
+
+### Monitor Configuration Example
+
+
diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-snmp.md b/home/versioned_docs/version-v1.5.x/advanced/extend-snmp.md
new file mode 100644
index 00000000000..c97aea1f766
--- /dev/null
+++ b/home/versioned_docs/version-v1.5.x/advanced/extend-snmp.md
@@ -0,0 +1,173 @@
+---
+id: extend-snmp
+title: SNMP Protocol Custom Monitoring
+sidebar_label: SNMP Protocol Custom Monitoring
+---
+
+> From [Custom Monitoring](extend-point), you are familiar with how to customize types, Metrics, protocols, etc. Here we will introduce in detail how to use SNMP to customize Metric monitoring.
+> JMX protocol custom monitoring allows us to easily monitor Metrics we want by config SNMP MIB OIDs.
+
+### SNMP protocol collection process
+【**Peer Server Enable SNMP Service**】->【**HertzBeat Connect Peer Server SNMP**】->【**Query Oids Data**】->【**Metric data extraction**】
+
+It can be seen from the process that we define a monitoring type of Snmp protocol. We need to configure Snmp request parameters, configure which Metrics to obtain, and configure oids.
+
+
+### Data parsing method
+
+By configuring the metrics `field`, `aliasFields`, and `oids` under the `snmp` protocol of the monitoring template YML to capture the data specified by the peer and parse the mapping.
+
+
+### Custom Steps
+
+**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type**
+
+
+
+-------
+Configuration usages of the monitoring templates yml are detailed below.
+
+### Monitoring Templates YML
+
+> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring.
+
+
+> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc.
+
+eg：Define a custom monitoring type `app` named `example_windows` which use the SNMP protocol to collect data.
+
+
+```yaml
+# The monitoring type category：service-application service monitoring db-database monitoring mid-middleware custom-custom monitoring os-operating system monitoring
+category: os
+# The monitoring type eg: linux windows tomcat mysql aws...
+app: windows
+# The monitoring i18n name
+name:
+ zh-CN: Windows操作系统
+ en-US: OS Windows
+# Input params define for monitoring(render web ui by the definition)
+params:
+ # field-param field key
+ - field: host
+ # name-param field display i18n name
+ name:
+ zh-CN: 主机Host
+ en-US: Host
+ # type-param field type(most mapping the html input type)
+ type: host
+ # required-true or false
+ required: true
+ # field-param field key
+ - field: port
+ # name-param field display i18n name
+ name:
+ zh-CN: 端口
+ en-US: Port
+ # type-param field type(most mapping the html input type)
+ type: number
+ # when type is number, range is required
+ range: '[0,65535]'
+ # required-true or false
+ required: true
+ # default value
+ defaultValue: 161
+ # field-param field key
+ - field: version
+ # name-param field display i18n name
+ name:
+ zh-CN: SNMP 版本
+ en-US: SNMP Version
+ # type-param field type(radio mapping the html radio tag)
+ type: radio
+ # required-true or false
+ required: true
+ # when type is radio checkbox, use option to show optional values {name1:value1,name2:value2}
+ options:
+ - label: SNMPv1
+ value: 0
+ - label: SNMPv2c
+ value: 1
+ # field-param field key
+ - field: community
+ # name-param field display i18n name
+ name:
+ zh-CN: SNMP 团体字
+ en-US: SNMP Community
+ # type-param field type(most mapping the html input type)
+ type: text
+ # when type is text, use limit to limit string length
+ limit: 100
+ # required-true or false
+ required: true
+ # param field input placeholder
+ placeholder: 'Snmp community for v1 v2c'
+ # field-param field key
+ - field: timeout
+ # name-param field display i18n name
+ name:
+ zh-CN: 超时时间(ms)
+ en-US: Timeout(ms)
+ # type-param field type(most mapping the html input type)
+ type: number
+ # when type is number, range is required
+ range: '[0,100000]'
+ # required-true or false
+ required: false
+ # hide-is hide this field and put it in advanced layout
+ hide: true
+ # default value
+ defaultValue: 6000
+# collect metrics config list
+metrics:
+ # metrics - system
+ - name: system
+ # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel
+ # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue
+ priority: 0
+ # collect metrics content
+ fields:
+ # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-if is metrics label
+ - field: name
+ type: 1
+ - field: descr
+ type: 1
+ - field: uptime
+ type: 1
+ - field: numUsers
+ type: 0
+ - field: services
+ type: 0
+ - field: processes
+ type: 0
+ - field: responseTime
+ type: 0
+ unit: ms
+ - field: location
+ type: 1
+ # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
+ protocol: snmp
+ # the config content when protocol is snmp
+ snmp:
+ # server host: ipv4 ipv6 domain
+ host: ^_^host^_^
+ # server port
+ port: ^_^port^_^
+ # snmp connect timeout
+ timeout: ^_^timeout^_^
+ # snmp community
+ community: ^_^community^_^
+ # snmp version
+ version: ^_^version^_^
+ # snmp operation: get, walk
+ operation: get
+ # metrics oids: metric_name - oid_value
+ oids:
+ name: 1.3.6.1.2.1.1.5.0
+ descr: 1.3.6.1.2.1.1.1.0
+ uptime: 1.3.6.1.2.1.25.1.1.0
+ numUsers: 1.3.6.1.2.1.25.1.5.0
+ services: 1.3.6.1.2.1.1.7.0
+ processes: 1.3.6.1.2.1.25.1.6.0
+ location: 1.3.6.1.2.1.1.6.0
+```
diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-ssh.md b/home/versioned_docs/version-v1.5.x/advanced/extend-ssh.md
similarity index 87%
rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-ssh.md
rename to home/versioned_docs/version-v1.5.x/advanced/extend-ssh.md
index 741a959e8e8..772ee315207 100644
--- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-ssh.md
+++ b/home/versioned_docs/version-v1.5.x/advanced/extend-ssh.md
@@ -7,7 +7,7 @@ sidebar_label: SSH Protocol Custom Monitoring
> SSH protocol custom monitoring allows us to easily monitor and collect the Linux Metrics we want by writing sh command script.
### SSH protocol collection process
-【**System directly connected to Linux**】->【**Run shell command script statement**】->【**parse reponse data: oneRow, multiRow**】->【**Metric data extraction**】
+【**System directly connected to Linux**】->【**Run shell command script statement**】->【**parse response data: oneRow, multiRow**】->【**Metric data extraction**】
It can be seen from the process that we define a monitoring type of SSH protocol. We need to configure SSH request parameters, configure which Metrics to obtain, and configure query script statements.
@@ -39,7 +39,7 @@ Here the Metric field and the response data can be mapped into a row of collecte
eg：
Linux memory related Metric fields queried：total-Total memory, used-Used memory,free-Free memory, buff-cache-Cache size, available-Available memory
-Memory indicaotr original query command：`free -m`, Console response：
+Memory metrics original query command：`free -m`, Console response：
```shell
total used free shared buff/cache available
Mem: 7962 4065 333 1 3562 3593
@@ -55,21 +55,22 @@ total used free buff_cache available
Here the Metric field and the response data can be mapped into collected data one by one.
-### Custom Steps
+### Custom Steps
-In order to configure a custom monitoring type, you need to add and configure YML file.
-1. Monitoring configuration definition file named after monitoring type - eg：example_linux.yml in the installation directory /hertzbeat/app/
-2. Restart hertzbeat system, we successfully fit a new custom monitoring type.
+**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type**
-------
-Configuration usages of the file are detailed below. Please pay attention to usage annotation.
+Configuration usages of the monitoring templates yml are detailed below.
-### Monitoring configuration definition file
+### Monitoring Templates YML
-> Monitoring configuration definition file is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc.
+> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring.
+
+
+> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc.
+
+eg：Define a custom monitoring type `app` named `example_linux` which use the SSH protocol to collect data.
-eg：Define a custom monitoring type named example_linux which use the SSH protocol to collect data.
-The file name: example_linux.yml in /define/example_linux.yml
```yaml
# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring
@@ -100,7 +101,7 @@ params:
zh-CN: 用户名
en-US: Username
type: text
- limit: 20
+ limit: 50
required: true
- field: password
name:
@@ -121,7 +122,7 @@ metrics:
# Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit
- field: hostname
type: 1
- instance: true
+ label: true
- field: version
type: 1
- field: uptime
diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-tutorial.md b/home/versioned_docs/version-v1.5.x/advanced/extend-tutorial.md
new file mode 100644
index 00000000000..9f21219a29f
--- /dev/null
+++ b/home/versioned_docs/version-v1.5.x/advanced/extend-tutorial.md
@@ -0,0 +1,236 @@
+---
+id: extend-tutorial
+title: Quick Tutorial Customize and adapt a monitoring based on HTTP protocol
+sidebar_label: Tutorial Case
+---
+
+Through this tutorial, we describe step by step how to customize and adapt a monitoring type based on the http protocol under the Apache HertzBeat (incubating).
+
+Before reading this tutorial, we hope that you are familiar with how to customize types, metrics, protocols, etc. from [Custom Monitoring](extend-point) and [Http Protocol Customization](extend-http).
+
+
+### HTTP protocol parses the general response structure to obtain metrics data
+
+> In many scenarios, we need to monitor the provided HTTP API interface and obtain the index value returned by the interface. In this article, we use the http custom protocol to parse our common http interface response structure, and obtain the fields in the returned body as metric data.
+
+
+```
+{
+ "code": 200,
+ "msg": "success",
+ "data": {}
+}
+
+```
+As above, usually our background API interface will design such a general return. The same is true for the background of the hertzbeat system. Today, we will use the hertzbeat API as an example, add a new monitoring type **hertzbeat**, and monitor and collect its system summary statistics API
+`http://localhost:1157/api/summary`, the response data is:
+
+```
+{
+ "msg": null,
+ "code": 0,
+ "data": {
+ "apps": [
+ {
+ "category": "service",
+ "app": "jvm",
+ "status": 0,
+ "size": 2,
+ "availableSize": 0,
+ "unManageSize": 2,
+ "unAvailableSize": 0,
+ "unReachableSize": 0
+ },
+ {
+ "category": "service",
+ "app": "website",
+ "status": 0,
+ "size": 2,
+ "availableSize": 0,
+ "unManageSize": 2,
+ "unAvailableSize": 0,
+ "unReachableSize": 0
+ }
+ ]
+ }
+}
+```
+
+**This time we get the metrics data such as `category`, `app`, `status`, `size`, `availableSize` under the app. **
+
+
+### Add Monitoring Template Yml
+
+**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type**
+
+> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring.
+
+
+> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc.
+
+
+Here we define a custom monitoring type `app` named `hertzbeat` which use the HTTP protocol to collect data.
+
+**Monitoring Templates** -> **Config New Monitoring Template Yml** -> **Save and Apply**
+
+```yaml
+# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring
+category: custom
+# The monitoring type eg: linux windows tomcat mysql aws...
+app: hertzbeat
+# The monitoring i18n name
+name:
+ zh-CN: HertzBeat监控系统
+ en-US: HertzBeat Monitor
+# Input params define for monitoring(render web ui by the definition)
+params:
+ # field-param field key
+ - field: host
+ # name-param field display i18n name
+ name:
+ zh-CN: 主机Host
+ en-US: Host
+ # type-param field type(most mapping the html input type)
+ type: host
+ # required-true or false
+ required: true
+ # field-param field key
+ - field: port
+ # name-param field display i18n name
+ name:
+ zh-CN: 端口
+ en-US: Port
+ # type-param field type(most mapping the html input type)
+ type: number
+ # when type is number, range is required
+ range: '[0,65535]'
+ # required-true or false
+ required: true
+ # default value
+ defaultValue: 1157
+ - field: ssl
+ name:
+ zh-CN: 启用HTTPS
+ en-US: HTTPS
+ type: boolean
+ required: true
+ - field: timeout
+ name:
+ zh-CN: 超时时间(ms)
+ en-US: Timeout(ms)
+ type: number
+ required: false
+ hide: true
+ - field: authType
+ name:
+ zh-CN: 认证方式
+ en-US: Auth Type
+ type: radio
+ required: false
+ hide: true
+ options:
+ - label: Basic Auth
+ value: Basic Auth
+ - label: Digest Auth
+ value: Digest Auth
+ - field: username
+ name:
+ zh-CN: 用户名
+ en-US: Username
+ type: text
+ limit: 50
+ required: false
+ hide: true
+ - field: password
+ name:
+ zh-CN: 密码
+ en-US: Password
+ type: password
+ required: false
+ hide: true
+metrics:
+ # the first metrics summary
+ # attention: Built-in monitoring metrics contains (responseTime - Response time)
+ - name: summary
+ # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel
+ # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue
+ priority: 0
+ # collect metrics content
+ fields:
+ # metrics content contains field-metric name, type-metric type:0-number,1-string, label-if is metrics label, unit-metric unit('%','ms','MB')
+ - field: app
+ type: 1
+ label: true
+ - field: category
+ type: 1
+ - field: status
+ type: 0
+ - field: size
+ type: 0
+ - field: availableSize
+ type: 0
+ # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk, we use HTTP protocol here
+ protocol: http
+ # the config content when protocol is http
+ http:
+ # http host: ipv4 ipv6 domain
+ host: ^_^host^_^
+ # http port
+ port: ^_^port^_^
+ # http url, we don't need to enter a parameter here, just set the fixed value to /api/summary
+ url: /api/summary
+ timeout: ^_^timeout^_^
+ # http method: GET POST PUT DELETE PATCH, default fixed value is GET
+ method: GET
+ # if enabled https, default value is false
+ ssl: ^_^ssl^_^
+ # http auth
+ authorization:
+ # http auth type: Basic Auth, Digest Auth, Bearer Token
+ type: ^_^authType^_^
+ basicAuthUsername: ^_^username^_^
+ basicAuthPassword: ^_^password^_^
+ digestAuthUsername: ^_^username^_^
+ digestAuthPassword: ^_^password^_^
+ # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, we use jsonpath to parse response data here
+ parseType: jsonPath
+ parseScript: '$.data.apps.*'
+```
+
+**The addition is complete, now we restart the hertzbeat system. We can see that the system page has added a `hertzbeat` monitoring type. **
+
+
+
+
+
+### The system page adds the monitoring of `hertzbeat` monitoring type
+
+> We click Add `HertzBeat Monitoring Tool`, configure monitoring IP, port, collection cycle, account password in advanced settings, etc., click OK to add monitoring.
+
+
+
+
+
+
+
+> After a certain period of time (depending on the collection cycle), we can see the specific metric data and historical charts in the monitoring details!
+
+
+
+
+
+
+### Set threshold alarm notification
+
+> Next, we can set the threshold normally. After the alarm is triggered, we can view it in the alarm center, add a new recipient, set alarm notification, etc. Have Fun!!!
+
+
+----
+
+#### over!
+
+This is the end of the practice of custom monitoring of the HTTP protocol. The HTTP protocol also has other parameters such as headers and params. We can define it like postman, and the playability is also very high!
+
+If you think hertzbeat is a good open source project, please star us on GitHub Gitee, thank you very much. Thanks for the old iron support. Refill!
+
+**github: https://github.com/apache/hertzbeat**
diff --git a/home/versioned_docs/version-v1.5.x/community/become_committer.md b/home/versioned_docs/version-v1.5.x/community/become_committer.md
new file mode 100644
index 00000000000..f2824bdc4ed
--- /dev/null
+++ b/home/versioned_docs/version-v1.5.x/community/become_committer.md
@@ -0,0 +1,84 @@
+---
+id: 'become_committer'
+title: 'Become A Committer'
+sidebar_position: 2
+---
+
+
+
+## Become A Committer of Apache HertzBeat
+
+Anyone being supportive of the community and working in any of the
+CoPDoC areas can become an Apache HertzBeat committer. The CoPDoC is an
+acronym from ASF to describe how we recognize your contributions not
+only by code.
+
+- **Community** - You can join us via our mailing list, issue
+ trackers, discussions page to interact with community members, and
+ share vision and knowledge
+- **Project** - a clear vision and consensus are needed
+- **Documentation** - without it, the stuff remains only in the minds
+ of the authors
+- **Code** - discussion goes nowhere without code
+
+Apache HertzBeat community strives to be meritocratic. Thus, once someone
+has contributed sufficiently to any area of CoPDoC they can be a
+candidate for committer-ship and at last voted in as a HertzBeat
+committer. Being an Apache HertzBeat committer does not necessarily mean
+you must commit code with your commit privilege to the codebase; it
+means you are committed to the HertzBeat project and are productively
+contributing to our community's success.
+
+## Committer requirements:
+
+There are no strict rules for becoming a committer or PPMC member.
+Candidates for new committers are typically people that are active
+contributors and community members. Anyway, if the rules can be
+clarified a little bit, it can somehow clear the doubts in the minds
+of contributors and make the community more transparent, reasonable,
+and fair.
+
+### Continuous contributions
+
+Committer candidates should have a decent amount of continuous
+engagements and contributions (fixing bugs, adding new features,
+writing documentation, maintaining issues boards, code review, or answering
+community questions) to HertzBeat either by contributing to the codebase
+of the main website or HertzBeat's GitHub repositories.
+
+- +3 months with light activity and engagement.
+- +2 months of medium activity and engagement.
+- +1 month with solid activity and engagement.
+
+### Quality of contributions
+- A solid general understanding of the project
+- Well tested, well-designed, following Apache HertzBeat coding
+ standards, and simple patches.
+- Well-organized and detailed user-oriented documentation.
+
+### Community involvement
+
+- Be active, courteous, and respectful on the dev mailing list and
+ help mentor newer contributors
+ and users.
+- Be active, courteous, and respectful on the issue tracker for
+ project maintenance
+- Be active, courteous, and respectful for pull requests reviewing
+- Be involved in the design road map discussions with a professional
+ and diplomatic approach even if there is a disagreement
+- Promoting the project by writing articles or holding events
diff --git a/home/versioned_docs/version-v1.5.x/community/become_pmc_member.md b/home/versioned_docs/version-v1.5.x/community/become_pmc_member.md
new file mode 100644
index 00000000000..cf48cbe7c82
--- /dev/null
+++ b/home/versioned_docs/version-v1.5.x/community/become_pmc_member.md
@@ -0,0 +1,84 @@
+---
+id: 'become_pmc_member'
+title: 'Become A PMC member'
+sidebar_position: 3
+---
+
+
+
+## Become A PMC member of Apache HertzBeat
+
+Anyone being supportive of the community and working in any of the
+CoPDoC areas can become an Apache HertzBeat PMC member. The CoPDoC is an
+acronym from ASF to describe how we recognize your contributions not
+only by code.
+
+- **Community** - You can join us via our mailing list, issue
+ trackers, discussions page to interact with community members, and
+ share vision and knowledge
+- **Project** - a clear vision and consensus are needed
+- **Documentation** - without it, the stuff remains only in the minds
+ of the authors
+- **Code** - discussion goes nowhere without code
+
+Apache HertzBeat community strives to be meritocratic. Thus, once someone
+has contributed sufficiently to any area of CoPDoC they can be a
+candidate for PMC membership and at last voted in as a HertzBeat
+PMC member. Being an Apache HertzBeat PMC member does not necessarily mean
+you must commit code with your commit privilege to the codebase; it
+means you are committed to the HertzBeat project and are productively
+contributing to our community's success.
+
+## PMC member requirements:
+
+There are no strict rules for becoming a committer or PPMC member.
+Candidates for new PMC member are typically people that are active
+contributors and community members. Anyway, if the rules can be
+clarified a little bit, it can somehow clear the doubts in the minds
+of contributors and make the community more transparent, reasonable,
+and fair.
+
+### Continuous contributions
+
+PMC member candidates should have a decent amount of continuous
+engagements and contributions (fixing bugs, adding new features,
+writing documentation, maintaining issues boards, code review, or answering
+community questions) to HertzBeat either by contributing to the codebase
+of the main website or HertzBeat's GitHub repositories.
+
+- +5 months with light activity and engagement.
+- +4 months of medium activity and engagement.
+- +3 month with solid activity and engagement.
+
+### Quality of contributions
+- A solid general understanding of the project
+- Well tested, well-designed, following Apache HertzBeat coding
+ standards, and simple patches.
+- Well-organized and detailed user-oriented documentation.
+
+### Community involvement
+
+- Be active, courteous, and respectful on the dev mailing list and
+ help mentor newer contributors
+ and users.
+- Be active, courteous, and respectful on the issue tracker for
+ project maintenance
+- Be active, courteous, and respectful for pull requests reviewing
+- Be involved in the design road map discussions with a professional
+ and diplomatic approach even if there is a disagreement
+- Promoting the project by writing articles or holding events
diff --git a/home/versioned_docs/version-v1.5.x/community/code-style-and-quality-guide.md b/home/versioned_docs/version-v1.5.x/community/code-style-and-quality-guide.md
new file mode 100644
index 00000000000..755a98f3fd7
--- /dev/null
+++ b/home/versioned_docs/version-v1.5.x/community/code-style-and-quality-guide.md
@@ -0,0 +1,575 @@
+---
+id: 'code_style_and_quality_guide'
+title: 'Code style and quality guide'
+sidebar_position: 3
+---
+
+
+
+
+## 1 Pull Requests & Changes Rule
+
+1. `ISSUE`/`PR`(pull request) driving and naming
+
+ - After creating a new `PR`, you need to associate the existing corresponding `ISSUE` at the Github Development button on the `PR` page (if there is no corresponding ISSUE, it is recommended to create a new corresponding ISSUE).
+
+ - Title naming format
+ `[feature/bugfix/doc/improve/refactor/bug/cleanup] title`
+
+2. Description
+
+ - Please fill in the `PR` template to describe the contribution. So that the reviewer can understand the problem and solution from the description, rather than just from the code.
+ - Check the CheckList
+
+3. It's recommended that `PR` should be arranged changes such as `cleanup`, `Refactor`, `improve`, and `feature` into separated `PRs`/`Commits`.
+
+4. Commit message(English, lowercase, no special characters)
+ The commit of messages should follow a pattern similar to the `[feature/bugfix/doc/improve/refactor/bug/cleanup] title`
+
+## 2 Code Checkstyle
+
+### 2.1 Configure Checkstyle
+
+1. Install the Checkstyle-IDEA plugin.
+2. Open Checkstyle Settings. Click **Settings** → **Tools** → **Checkstyle**.
+3. Set **Checkstyle version** to **10.14.2**.
+4. Set **Scan scope** to **Only Java sources (including tests)**.
+5. Click **+** button in the **Configuration** section to open a dialog to choose the checkstyle config file.
+ 1. Enter a **Description**. For example, hertzbeat.
+ 2. Select **Use a local checkstyle file**.
+ 3. Set **File** to **script/checkstyle/checkstyle.xml**.
+ 4. Select **Store relative to project location**.
+ 5. Click **Next** → **Next** → **Finish**.
+6. Activate the configuration you just added by toggling the corresponding box.
+7. Click **OK**.
+
+- Backend code specification Maven plugin: `checkstyle`
+ Just run `mvn checkstyle:checkstyle`.
+
+- Frontend code formatting plugin `eslint`
+ Just run `npm run lint:fix` in web-app
+
+## 3 Programming Specification
+
+### 3.1 Naming Style
+
+1. Prioritize selecting nouns for variable naming, it's easier to distinguish between `variables` or `methods`.
+ ```java
+ Cachejavax.validation.requirements
+
+3. If there are too many lines of code in the method, please have a try on using multiple sub methods at appropriate points to segment the method body.
+
+ Generally speaking, it needs to adhere to the following principles:
+ - Convenient testing
+ - Good semantics
+ - Easy to read
+
+ In addition, it is also necessary to consider whether the splitting is reasonable in terms of components, logic, abstraction, and other aspects in the scenario.
+
+ > However, there is currently no clear definition of demo. During the evolution process, we will provide additional examples for developers to have a clearer reference and understanding.
+
+### 3.4 Collection Rule
+
+1. For `collection` returned values, unless there are special `concurrent` (such as thread safety), always return the `interface`, such as:
+
+ - returns List if use `ArrayList`
+ - returns Map if use `HashMap`
+ - returns Set if use `HashSet`
+
+2. If there are multiple threads, the following declaration or returned types can be used:
+
+ ```java
+ private CurrentHashMap map;
+ public CurrentHashMap funName();
+ ```
+
+3. Use `isEmpty()` instead of `length() == 0` or `size() == 0`
+
+ - Negative demo：
+
+ ```java
+ if (pathPart.length() == 0) {
+ return;
+ }
+ ```
+
+ - Positive demo：
+
+ ```java
+ if (pathPart.isEmpty()) {
+ return;
+ }
+ ```
+
+### 3.5 Concurrent Processing
+
+1. The `thread pool` needs to be managed, using a unified entry point to obtain the `thread pool`.
+
+ Note: During the evolution process, we will provide additional examples for developers to have a clearer reference and understanding.
+
+2. `Thread pool` needs to be resource constrained to prevent resource leakage caused by improper handling
+
+### 3.6 Control/Condition Statements
+
+1. Avoid unreasonable `condition/control` branches order leads to:
+
+ - Multiple code line `depths` of `n+1`
+ - Redundant lines
+
+Generally speaking, if a method's code line depth exceeds `2+ Tabs` due to continuous nested `if... else..`, it should be considered to try
+- `merging branches`,
+- `inverting branch conditions`
+- `extracting private methods`
+
+to reduce code line depth and improve readability like follows:
+- Union or merge the logic into the next level calling
+ - Negative demo:
+ ```java
+ if (isInsert) {
+ save(platform);
+ } else {
+ updateById(platform);
+ }
+ ```
+ - Positive demo:
+ ```java
+ saveOrUpdate(platform);
+ ```
+- Merge the conditions
+ - Negative demo:
+ ```java
+ if (expression1) {
+ if(expression2) {
+ ......
+ }
+ }
+ ```
+ - Positive demo:
+ ```java
+ if (expression1 && expression2) {
+ ......
+ }
+ ```
+- Reverse the condition
+ - Negative demo:
+
+ ```java
+ public void doSomething() {
+ // Ignored more deeper block lines
+ // .....
+ if (condition1) {
+ ...
+ } else {
+ ...
+ }
+ }
+ ```
+
+ - Positive demo:
+
+ ```java
+ public void doSomething() {
+ // Ignored more deeper block lines
+ // .....
+ if (!condition1) {
+ ...
+ return;
+ }
+ // ...
+ }
+ ```
+- Using a single variable or method to reduce the complex conditional expression
+ - Negative demo:
+ ```java
+ if (dbType.indexOf("sqlserver") >= 0 || dbType.indexOf("sql server") >= 0) {
+ ...
+ }
+ ```
+
+ - Positive demo:
+ ```java
+ if (containsSqlServer(dbType)) {
+ ....
+ }
+ //.....
+ // definition of the containsSqlServer
+ ```
+
+> Using `sonarlint` and `better highlights` to check code depth looks like good in the future.
+
+### 3.7 Code Comments Rule
+
+1. Method lacks comments:
+
+ - `When`: When can the method be called
+ - `How`: How to use this method and how to pass parameters, etc.
+ - `What`: What functions does this method achieve
+ - `Note`: What should developers pay attention to when calling this method
+
+2. Missing necessary class header description comments.
+
+ Add `What`, `Note`, etc. like mentioned in the `1`.
+
+3. The method declaration in the interface must be annotated.
+
+ - If the semantics of the implementation and the annotation content at the interface declaration are inconsistent, the specific implementation method also needs to be rewritten with annotations.
+
+ - If the semantics of the method implementation are consistent with the annotation content at the interface declaration, it is not recommended to write annotations to avoid duplicate annotations.
+
+4. The first word in the comment lines need to be capitalized, like `param` lines, `return` lines.
+ If a special reference as a subject does not need to be capitalized, special symbols such as quotation marks need to be noted.
+
+### 3.8 Java Lambdas
+
+1. Prefer `non-capturing` lambdas (lambdas that do not contain references to the outer scope).
+ Capturing lambdas need to create a new object instance for every call. `Non-capturing` lambdas can use the same instance for each invocation.
+
+ - Negative demo:
+
+ ```java
+ map.computeIfAbsent(key, x -> key.toLowerCase())
+ ```
+
+ - Positive demo:
+
+ ```java
+ map.computeIfAbsent(key, k -> k.toLowerCase());
+ ```
+
+2. Consider method references instead of inline lambdas
+
+ - Negative demo:
+
+ ```java
+ map.computeIfAbsent(key, k-> Loader.load(k));
+ ```
+
+ - Positive demo:
+
+ ```java
+ map.computeIfAbsent(key, Loader::load);
+ ```
+
+### 3.9 Java Streams
+
+- Avoid Java Streams in any performance critical code.
+
+- The main motivation to use Java Streams would be to improve code readability. As such, they can be a good match in parts of the code that are not data-intensive, but deal with coordination.
+
+- Even in the latter case, try to limit the scope to a method, or a few private methods within an internal class.
+
+### 3.10 Pre-Conditions Checking
+
+1. Use a unified `Utils.requireXXX` to complete the validation of the prerequisite, and if possible, replace the `AlertXXException.throwIfXXX` by new pre-conditions checking.
+
+### 3.11 StringUtils
+
+1. Use `StringUtils.isBlank` instead of `StringUtils.isEmpty`
+
+ - Negative demo:
+
+ ```java
+ if (StringUtils.isEmpty(name)) {
+ return;
+ }
+ ```
+
+ - Positive demo:
+
+ ```java
+ if (StringUtils.isBlank(name)) {
+ return;
+ }
+ ```
+
+2. Use `StringUtils.isNotBlank` instead of `StringUtils.isNotEmpty`
+
+ - Negative demo:
+
+ ```java
+ if (StringUtils.isNotEmpty(name)) {
+ return;
+ }
+ ```
+
+ - Positive demo:
+
+ ```java
+ if (StringUtils.isNotBlank(name)) {
+ return;
+ }
+ ```
+
+3. Use `StringUtils.isAllBlank` instead of `StringUtils.isAllEmpty`
+
+ - Negative demo:
+
+ ```java
+ if (StringUtils.isAllEmpty(name, age)) {
+ return;
+ }
+ ```
+
+ - Positive demo:
+
+ ```java
+ if (StringUtils.isAllBlank(name, age)) {
+ return;
+ }
+ ```
+
+### 3.12 `Enum` Class
+
+1. Enumeration value comparison
+
+ - Negative demo:
+
+ ```java
+ if (status.equals(JobStatus.RUNNING)) {
+ return;
+ }
+ ```
+
+ - Positive demo:
+
+ ```java
+ if (status == JobStatus.RUNNING) {
+ return;
+ }
+ ```
+
+2. Enumeration classes do not need to implement Serializable
+
+ - Negative demo:
+
+ ```java
+ public enum JobStatus implements Serializable {
+ ...
+ }
+ ```
+
+ - Positive demo:
+
+ ```java
+ public enum JobStatus {
+ ...
+ }
+ ```
+
+3. Use `Enum.name()` instead of `Enum.toString()`
+
+ - Negative demo:
+
+ ```java
+ System.out.println(JobStatus.RUNNING.toString());
+ ```
+
+ - Positive demo:
+
+ ```java
+ System.out.println(JobStatus.RUNNING.name());
+ ```
+
+4. Enumeration class names uniformly use the Enum suffix
+
+ - Negative demo:
+
+ ```java
+ public enum JobStatus {
+ ...
+ }
+ ```
+
+ - Positive demo:
+
+ ```java
+ public enum JobStatusEnum {
+ ...
+ }
+ ```
+
+### 3.13 `Deprecated` Annotation
+
+ - Negative demo:
+
+ ```java
+ @deprecated
+ public void process(String input) {
+ ...
+ }
+ ```
+
+ - Positive demo:
+
+ ```java
+ @Deprecated
+ public void process(String input) {
+ ...
+ }
+ ```
+
+## 4 Log
+
+1. Use `placeholders` for log output:
+
+ - Negative demo
+ ```java
+ log.info("Deploy cluster request " + deployRequest);
+ ```
+ - Positive demo
+ ```java
+ log.info("load plugin:{} to {}", file.getName(), appPlugins);
+ ```
+
+2. Pay attention to the selection of `log level` when printing logs
+
+ When printing the log content, if the actual parameters of the log placeholder are passed, it is necessary to avoid premature evaluation to avoid unnecessary evaluation caused by the log level.
+
+ - Negative demo:
+
+ Assuming the current log level is `INFO`:
+
+ ```java
+ // ignored declaration lines.
+ List
+
- {{ item.value }} :
- {{
- item.value == item.label
- ? i == 0
- ? ('alert.setting.target.tip' | i18n)
- : ('alert.setting.target.other' | i18n)
- : item.label
- }}
-
-
- {{ 'alert.setting.operator' | i18n }} : equals(str1,str2), contains(str1,str2), exists(keyName), matches(str,regex), ==,
- <, <=, >, >=, !=, ( ), +, -, &&, ||
-
-
+ {{ item.value }} :
+ {{
+ item.value == item.label
+ ? i == 0
+ ? ('alert.setting.target.tip' | i18n)
+ : ('alert.setting.target.other' | i18n)
+ : item.label
+ }}
+
+
+ {{ 'alert.setting.operator' | i18n }} : equals(str1,str2), contains(str1,str2), exists(keyName), matches(str,regex),
+ ==, <, <=, >, >=, !=, ( ), +, -, &&, ||
+
+
-
ID
{{ monitorId }}
{{ 'monitors.detail.name' | i18n }}
{{ monitor.name }}
HOST
{{ monitor.host }}
{{ 'monitors.detail.port' | i18n }}
{{ port }}
{{ 'monitors.detail.description' | i18n }}
{{ monitor.description }}
{{ 'monitors.detail.status' | i18n }}
{{ 'monitor.intervals' | i18n }}
{{ monitor.intervals }}s
{{ 'common.new-time' | i18n }}
{{ monitor.gmtCreate | date : 'YYYY-MM-dd HH:mm:ss' }}
{{ 'common.edit-time' | i18n }}
{{ monitor.gmtUpdate | date : 'YYYY-MM-dd HH:mm:ss' }}
- {{ 'monitor.app.' + app + '.metrics.' + metrics | i18nElse : metrics }}
+
+ {{ !monitor ? ('monitor.app.' + app + '.metrics.' + metrics | i18nElse : metrics) : ('monitors.detail.basic' | i18n) }}
ID {{ monitorId }} {{ 'monitors.detail.name' | i18n }} {{ monitor.name }} HOST {{ monitor.host }} {{ 'monitors.detail.port' | i18n }} {{ port }} {{ 'monitors.detail.description' | i18n }} {{ monitor.description }} {{ 'monitors.detail.status' | i18n }} {{ 'monitor.intervals' | i18n }} {{ monitor.intervals }}s {{ 'common.new-time' | i18n }} {{ monitor.gmtCreate | date : 'YYYY-MM-dd HH:mm:ss' }} {{ 'common.edit-time' | i18n }} {{ monitor.gmtUpdate | date : 'YYYY-MM-dd HH:mm:ss' }} {{ 'monitors.detail.basic' | i18n }}
-
-
+
+
+
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
diff --git a/web-app/src/app/routes/monitor/monitor-detail/monitor-detail.component.less b/web-app/src/app/routes/monitor/monitor-detail/monitor-detail.component.less
index 603fcabe688..0c5c082b575 100644
--- a/web-app/src/app/routes/monitor/monitor-detail/monitor-detail.component.less
+++ b/web-app/src/app/routes/monitor/monitor-detail/monitor-detail.component.less
@@ -31,3 +31,16 @@ p {
}
}
}
+
+.cards {
+ gap: 8px;
+ margin: 8px;
+ display: flex;
+ flex-wrap: wrap;
+ justify-content: flex-start;
+
+ .card {
+ width: calc(50% - 4px);
+ height: 400px;
+ }
+}
diff --git a/web-app/src/app/routes/monitor/monitor-detail/monitor-detail.component.ts b/web-app/src/app/routes/monitor/monitor-detail/monitor-detail.component.ts
index 31f8c08f199..228557ecbb0 100644
--- a/web-app/src/app/routes/monitor/monitor-detail/monitor-detail.component.ts
+++ b/web-app/src/app/routes/monitor/monitor-detail/monitor-detail.component.ts
@@ -61,9 +61,8 @@ export class MonitorDetailComponent implements OnInit, OnDestroy {
showBasic = true;
ngOnInit(): void {
- this.loadRealTimeMetric();
this.countDownTime = this.deadline;
- this.interval$ = setInterval(this.countDown.bind(this), 1000);
+ this.loadRealTimeMetric();
}
loadMetricChart() {
@@ -157,6 +156,9 @@ export class MonitorDetailComponent implements OnInit, OnDestroy {
} else {
console.warn(message.msg);
}
+ if (this.interval$ === undefined) {
+ this.interval$ = setInterval(this.countDown.bind(this), 1000);
+ }
this.isSpinning = false;
},
error => {
@@ -166,10 +168,6 @@ export class MonitorDetailComponent implements OnInit, OnDestroy {
);
}
- showBasicStatus(show: boolean) {
- this.showBasic = show;
- }
-
countDown() {
if (this.deadline > 0) {
this.countDownTime = Math.max(0, this.countDownTime - 1);
diff --git a/web-app/src/app/routes/monitor/monitor-edit/monitor-edit.component.html b/web-app/src/app/routes/monitor/monitor-edit/monitor-edit.component.html
index 46b72127867..8660943796f 100644
--- a/web-app/src/app/routes/monitor/monitor-edit/monitor-edit.component.html
+++ b/web-app/src/app/routes/monitor/monitor-edit/monitor-edit.component.html
@@ -17,475 +17,27 @@
~ under the License.
-->
-
+
-
-
-
-
-
-
-
-
-
-
-
- {{ 'tag' | i18n }}
-
-
-
-
-
-
-
+
+
+
-
-
+
+
+
-
-
@@ -204,64 +200,66 @@
@@ -303,48 +301,23 @@
(nzOnCancel)="onAppSwitchModalCancel()"
nzClosable="false"
nzWidth="30%"
+ nzWrapClassName="monitor-select-menu-modal"
[nzOkText]="null"
[nzCancelText]="null"
[nzOkLoading]="appSearchLoading"
>
{{ (data.gmtUpdate ? data.gmtUpdate : data.gmtCreate) | date : 'YYYY-MM-dd HH:mm:ss' }}
-
-
-
-
-
+
+
+
+
+
-
diff --git a/web-app/src/app/routes/monitor/monitor-list/monitor-list.component.less b/web-app/src/app/routes/monitor/monitor-list/monitor-list.component.less
index f0173dd150f..667151641e4 100644
--- a/web-app/src/app/routes/monitor/monitor-list/monitor-list.component.less
+++ b/web-app/src/app/routes/monitor/monitor-list/monitor-list.component.less
@@ -1,8 +1,8 @@
-@import "~src/styles/theme";
-
-.switch-app {
- border-radius: 6px;
-}
-.switch-app:hover {
- background-color: @primary-color;
+::ng-deep {
+ .monitor-select-menu-modal {
+ .ant-spin-container {
+ max-height: 80vh;
+ overflow: hidden;
+ }
+ }
}
diff --git a/web-app/src/app/routes/monitor/monitor-list/monitor-list.component.ts b/web-app/src/app/routes/monitor/monitor-list/monitor-list.component.ts
index ddbf05b4aaa..266d498aa37 100644
--- a/web-app/src/app/routes/monitor/monitor-list/monitor-list.component.ts
+++ b/web-app/src/app/routes/monitor/monitor-list/monitor-list.component.ts
@@ -17,7 +17,7 @@
* under the License.
*/
-import { Component, Inject, OnInit } from '@angular/core';
+import { Component, Inject, OnDestroy, OnInit } from '@angular/core';
import { ActivatedRoute, Router } from '@angular/router';
import { I18NService } from '@core';
import { ALAIN_I18N_TOKEN } from '@delon/theme';
@@ -40,7 +40,7 @@ import { formatTagName } from '../../../shared/utils/common-util';
templateUrl: './monitor-list.component.html',
styleUrls: ['./monitor-list.component.less']
})
-export class MonitorListComponent implements OnInit {
+export class MonitorListComponent implements OnInit, OnDestroy {
constructor(
private route: ActivatedRoute,
private router: Router,
@@ -70,10 +70,9 @@ export class MonitorListComponent implements OnInit {
filterStatus: number = 9;
// app type search filter
appSwitchModalVisible = false;
- appSearchContent = '';
appSearchOrigin: any[] = [];
- appSearchResult: any[] = [];
appSearchLoading = false;
+ intervalId: any;
switchExportTypeModalFooter: ModalButtonOptions[] = [
{ label: this.i18nSvc.fanyi('common.button.cancel'), type: 'default', onClick: () => (this.isSwitchExportTypeModalVisible = false) }
@@ -99,6 +98,24 @@ export class MonitorListComponent implements OnInit {
this.tableLoading = true;
this.loadMonitorTable();
});
+ // Set up an interval to refresh the table every 2 minutes
+ this.intervalId = setInterval(() => {
+ this.sync();
+ }, 12000); // 120000 ms = 2 minutes
+ }
+
+ ngOnDestroy(): void {
+ if (this.intervalId) {
+ clearInterval(this.intervalId);
+ }
+ }
+
+ onTagChanged(): void {
+ this.router.navigate([], {
+ relativeTo: this.route,
+ queryParams: { ...this.route.snapshot.queryParams, tag: this.tag },
+ queryParamsHandling: 'merge'
+ });
}
onFilterSearchMonitors() {
@@ -132,10 +149,6 @@ export class MonitorListComponent implements OnInit {
this.loadMonitorTable();
}
- clearCurrentTag() {
- this.router.navigateByUrl(`/monitors`);
- }
-
getAppIconName(app: string | undefined): string {
let hierarchy: any[] = this.storageSvc.getData('hierarchy');
let find = hierarchy.find((item: { category: string; value: string }) => {
@@ -499,17 +512,24 @@ export class MonitorListComponent implements OnInit {
.subscribe(
message => {
if (message.code === 0) {
- this.appSearchOrigin = [];
- this.appSearchResult = [];
+ let appMenus: Record
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
- {{ 'tag' | i18n }}
-
-
-
-
-
-
-
+