Merge pull request #2 from DigitalChinaOpenSource/dev

Dev

Author: hey-hoho

API Design Doc.md

@@ -1,17 +1,21 @@
 API Design
 
-| REST verb | URI                   | Note                     |
-| --------- | --------------------- | ------------------------ |
-| GET       | /login                | 进入登陆页面             |
-| POST      | /session              | 登陆验证                 |
-| DELETE    | /session              | 注销登陆                 |
-| GET       | /report/catalog       | 获取所有巡检结果的文件名 |
-| GET       | /report/id/{id}       | 获取指定的某次结果       |
-| GET       | /report/latest        | 获取最后一次巡检结果     |
-| GET       | /report/meta          | 获取巡检结果元信息       |
-| POST      | /report               | 执行一次巡检             |
-| GET       | /report/download/all  | 下载所有巡检报告         |
-| GET       | /report/download/{id} | 下载指定的巡检报告       |
+| REST verb | URI                          | Note                     |
+| --------- | ---------------------------- | ------------------------ |
+| GET       | /login                       | 进入登陆页面               |
+| POST      | /session                     | 登陆验证                  |
+| DELETE    | /session                     | 注销登陆                  |
+| GET       | /report/catalog              | 获取所有巡检结果的文件名     |
+| GET       | /report/id/{id}              | 获取指定的某次结果          |
+| GET       | /report/latest               | 获取最后一次巡检结果        |
+| GET       | /report/meta                 | 获取巡检结果元信息          |
+| POST      | /report                      | 执行一次巡检              |
+| GET       | /report/download/all         | 下载所有巡检报告           |
+| GET       | /report/download/{id}        | 下载指定的巡检报告          |
+| GET       | /script/local                | 查看所有远程仓库脚本        |
+| GET       | /script/remote               | 查看所有远程仓库脚本        |
+| GET       | /script/remote/readme/:name  | 查看指定脚本名的介绍        |
+| POST      | /script/remote/download/:name| 下载远程仓库的脚本到本地     |
 
 ### 登陆验证
 
@@ -229,3 +233,81 @@ Response Body:
   "check_time": 20211221063030
 }
 ```
+
+### 查看本地脚本列表
+
+`GET /script/local`
+
+- Request Query Param
+```
+  // The start default value is 0
+  // The length default value is 10
+  ?start=0&length=2
+```
+
+- Response Body
+
+```json
+{
+  "total": 2, 
+  "script_list": [
+    {
+      "name": "alive_pd_number"
+    },{
+      "name": "alive_tidb_number"
+    }
+  ]
+}
+```
+
+### 查看所有远程仓库脚本
+
+`GET /script/remote`
+
+- Request Query Param
+```
+  // The start default value is 0
+  // The length default value is 10
+  ?start=0&length=2
+```
+- 
+- Response Body :
+
+```json
+{
+  "total": 2,
+  "script_list": [
+    {
+      "name": "alive_pd_number",
+      "download": true
+    },{
+      "name": "alive_tidb_number",
+      "download": false
+    }
+  ]
+}
+```
+
+### 查看指定脚本名的介绍
+
+`GET /script/remote/readme/:name`
+
+- Response Body :
+
+```json
+{
+    "readme": ""
+}
+```
+
+### 下载远程仓库的脚本到本地
+
+`POST /script/remote/download/:name`
+
+- Response Body :
+
+```json
+{
+  "status": "ok"
+}
+```

config/execution_config.csv

@@ -1,17 +1,13 @@
 是否开启:检测类别:检测项目:检测脚本:检测方式:检测阈值:检测脚本参数
-ENABLE:集群:存活的TiDB数量:alive_tidb_number.py:等于:5:
-ENABLE:集群:存活的TiKV数量:alive_tikv_number.py:等于:5:
-ENABLE:集群:存活的TiFlash数量:alive_tiflash_number.py:等于:18:
-ENABLE:集群:存活的PD数量:alive_pd_number.py:等于:5:
+ENABLE:集群:存活的TiDB数量:alive_tidb_number.py:等于:2:
+ENABLE:集群:存活的TiKV数量:alive_tikv_number.py:等于:3:
+ENABLE:集群:存活的PD数量:alive_pd_number.py:等于:3:
 ENABLE:网络:今天网卡流入流量(MB):network_in.py:小于等于:4096:
 ENABLE:网络:今天网卡流出流量(MB):network_out.py:小于等于:4096:
-ENABLE:运行状态:表没有创建TiFlash副本:no_tiflash_replica.sh:无数据:NA:
 ENABLE:运行状态:表没有主键:no_primary_key.sh:无数据:NA:
 ENABLE:运行状态:正在执行且超过5分钟的SQL:running_sql_5min.sh:无数据:NA:
-ENABLE:运行状态:走TiKV且超过5秒的SQL:sql_5s_no_tiflash.sh:无数据:NA:
 ENABLE:运行状态:执行超过1h的DDL:long_ddl_job.sh:无数据:NA:
 ENABLE:运行状态:TiKV Region数量:tikv_region_number.py:小于等于:30000:
-ENABLE:运行状态:TiFlash Region数量:tiflash_region_number.py:小于等于:30000:
 ENABLE:运行状态:goroutine数量:goroutine_number.py:小于等于:50000:
 ENABLE:运行状态:每个tidb的连接数:tidb_connections.py:小于等于:800:
 DISABLE:运行状态:今天成功的Query数:succeeded_query_number.py:大于等于:0: