[home]帮助文档完善整理

home/docs/help/alert_dingtalk.md

@@ -0,0 +1,40 @@
+---
+id: alert_dingtalk  
+title: 告警钉钉机器人通知      
+sidebar_label: 告警钉钉机器人通知      
+---
+
+> 阈值触发后发送告警信息，通过钉钉机器人通知到接收人。      
+
+### 操作步骤   
+
+1. **【钉钉桌面客户端】-> 【群设置】-> 【智能群助手】-> 【添加新建机器人-选自定义】-> 【设置机器人名称头像】-> 【注意⚠️设置自定义关键字: TanCloud】 ->【添加成功后复制其WebHook地址】**
+
+> 注意⚠️ 新增机器人时需在安全设置块需设置其自定义关键字: TanCloud ，其它安全设置加签或IP段不填写    
+
+![email](/img/docs/help/alert-notice-8.png)     
+
+2. **【保存机器人的WebHook地址access_token值】**
+
+> 例如： webHook地址：`https://oapi.dingtalk.com/robot/send?access_token=43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f`          
+> 其机器人access_token值为 `43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f`
+
+3. **【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】**
+
+![email](/img/docs/help/alert-notice-9.png)
+
+4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】**  
+
+> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。   
+
+![email](/img/docs/help/alert-notice-4.png)    
+
+
+### 钉钉机器人通知常见问题   
+
+1. 钉钉群未收到机器人告警通知  
+> 请排查在告警中心是否已有触发的告警信息  
+> 请排查钉钉机器人是否配置了安全自定义关键字：TanCloud  
+> 请排查是否配置正确机器人ACCESS_TOKEN，是否已配置告警策略关联
+
+其它问题可以通过交流群ISSUE反馈哦！  

home/docs/help/alert_email.md

@@ -0,0 +1,37 @@
+---
+id: alert_email  
+title: 告警邮件通知      
+sidebar_label: 告警邮件通知   
+---
+
+> 阈值触发后发送告警信息，通过邮件通知到接收人。      
+
+### 操作步骤   
+
+1. **【告警通知】->【新增接收人】 ->【选择邮件通知方式】** 
+
+![email](/img/docs/help/alert-notice-1.png)   
+
+2. **【获取验证码】-> 【输入邮箱验证码】-> 【确定】**   
+![email](/img/docs/help/alert-notice-2.png)    
+
+![email](/img/docs/help/alert-notice-3.png)   
+
+3. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】**  
+
+> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。   
+
+![email](/img/docs/help/alert-notice-4.png)    
+
+
+### 邮件通知常见问题   
+
+1. 自己内网部署的HertzBeat无法接收到邮件通知   
+> HertzBeat需要自己配置邮件服务器，TanCloud无需，请确认是否在application.yml配置了自己的邮件服务器     
+
+2. 云环境TanCloud无法接收到邮件通知  
+> 请排查在告警中心是否已有触发的告警信息   
+> 请排查是否配置正确邮箱，是否已配置告警策略关联  
+> 请查询邮箱的垃圾箱里是否把告警邮件拦截     
+
+其它问题可以通过交流群ISSUE反馈哦！  

home/docs/help/alert_feishu.md

@@ -0,0 +1,33 @@
+---
+id: alert_feishu
+title: 告警飞书机器人通知      
+sidebar_label: 告警飞书机器人通知     
+---
+
+> 阈值触发后发送告警信息，通过飞书机器人通知到接收人。         
+
+### 操作步骤   
+
+1. **【飞书客户端】-> 【群设置】-> 【群机器人】-> 【添加新建机器人】-> 【设置机器人名称头像】-> 【添加成功后复制其WebHook地址】**
+
+2. **【保存机器人的WebHook地址的KEY值】**     
+
+> 例如： webHook地址：`https://open.feishu.cn/open-apis/bot/v2/hook/3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4`     
+> 其机器人KEY值为 `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4`      
+
+3. **【告警通知】->【新增接收人】 ->【选择飞书机器人通知方式】->【设置飞书机器人KEY】-> 【确定】**
+
+4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】**  
+
+> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。   
+
+![email](/img/docs/help/alert-notice-4.png)    
+
+
+### 飞书机器人通知常见问题   
+
+1. 飞书群未收到机器人告警通知       
+> 请排查在告警中心是否已有触发的告警信息   
+> 请排查是否配置正确机器人KEY，是否已配置告警策略关联   
+
+其它问题可以通过交流群ISSUE反馈哦！  

home/docs/help/alert_webhook.md

@@ -0,0 +1,47 @@
+---
+id: alert_webhook
+title: 告警WebHook回调通知      
+sidebar_label: 告警WebHook通知   
+---
+
+> 阈值触发后发送告警信息，通过post请求方式调用WebHook接口通知到接收人。          
+
+### 操作步骤   
+
+1. **【告警通知】->【新增接收人】 ->【选择WebHook通知方式】-> 【设置WebHook回调地址】 -> 【确定】** 
+
+![email](/img/docs/help/alert-notice-5.png)
+
+2. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】**  
+
+> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。   
+
+![email](/img/docs/help/alert-notice-4.png)    
+
+### WebHook回调POST请求体BODY内容   
+
+内容格式：JSON   
+```json
+{
+    "id":76456,
+    "target":"available",
+    "monitorId":5739609486000128,
+    "monitorName":"API_poetry.apiopen.top",
+    "priority":0,
+    "content":"监控紧急可用性告警: UN_CONNECTABLE",
+    "status":0,
+    "times":1,
+    "tenantId":10000,
+    "gmtCreate":"2022-02-25T13:32:13",
+    "gmtUpdate":"2022-02-25T13:32:13"
+}
+```
+
+
+### webhook通知常见问题   
+
+1. WebHook回调未生效   
+> 请查看告警中心是否已经产生此条告警信息   
+> 请排查配置的WebHook回调地址是否正确
+
+其它问题可以通过交流群ISSUE反馈哦！  

home/docs/help/alert_wework.md

@@ -0,0 +1,37 @@
+---
+id: alert_wework  
+title: 告警企业微信通知      
+sidebar_label: 告警企业微信通知     
+---
+
+> 阈值触发后发送告警信息，通过企业微信机器人通知到接收人。         
+
+### 操作步骤   
+
+1. **【企业微信端】-> 【群设置】-> 【群机器人】-> 【添加新建机器人】-> 【设置机器人名称头像】-> 【添加成功后复制其WebHook地址】**  
+
+![email](/img/docs/help/alert-notice-6.jpg)  
+
+2. **【保存机器人的WebHook地址的KEY值】**     
+
+> 例如： webHook地址：`https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4`     
+> 其机器人KEY值为 `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4`      
+
+3. **【告警通知】->【新增接收人】 ->【选择企业微信机器人通知方式】->【设置企业微信机器人KEY】-> 【确定】**    
+
+![email](/img/docs/help/alert-notice-7.png)
+
+4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】**  
+
+> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。   
+
+![email](/img/docs/help/alert-notice-4.png)    
+
+
+### 企业微信机器人通知常见问题   
+
+1. 企业微信群未收到机器人告警通知       
+> 请排查在告警中心是否已有触发的告警信息   
+> 请排查是否配置正确机器人KEY，是否已配置告警策略关联   
+
+其它问题可以通过交流群ISSUE反馈哦！  

home/docs/help/api.md

@@ -0,0 +1,35 @@
+---
+id: api  
+title: 监控：HTTP API      
+sidebar_label: HTTP API   
+---
+
+> 调用HTTP API接口，查看接口是否可用，对其响应时间等指标进行监测   
+
+### 配置参数
+
+| 参数名称      | 参数帮助描述 |
+| ----------- | ----------- |
+| 监控Host     | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
+| 监控名称     | 标识此监控的名称，名称需要保证唯一性。  |
+| 端口        | 网站对外提供的端口，http一般默认为80，https一般默认为443。  |
+| 相对路径     | 网站地址除IP端口外的后缀路径，例如 `www.tancloud.cn/console` 网站的相对路径为 `/console`。  |
+| 请求方式     | 设置接口调用的请求方式：GET,POST,PUT,DELETE。  |
+| 启用HTTPS   | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443  |
+| 用户名      | 接口Basic认证或Digest认证时使用的用户名 |
+| 密码        | 接口Basic认证或Digest认证时使用的密码 |
+| Content-Type  | 设置携带BODY请求体数据请求时的资源类型  |
+| 请求BODY    | 设置携带BODY请求体数据，PUT POST请求方式时有效  |
+| 采集间隔    | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为10秒  |
+| 是否探测    | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作  |
+| 描述备注    | 更多标识和描述此监控的备注信息，用户可以在这里备注信息  |
+
+### 采集指标
+
+#### 指标集合：summary
+
+| 指标名称      | 指标单位 | 指标帮助描述 |
+| ----------- | ----------- | ----------- |
+| responseTime   | ms毫秒 | 网站响应时间 |
+
+

home/docs/help/fullsite.md

@@ -0,0 +1,34 @@
+---
+id: fullsite  
+title: 监控：全站监控      
+sidebar_label: 全站监控   
+---
+
+> 对网站的全部页面监测是否可用    
+> 往往一个网站有多个不同服务提供的页面，我们通过采集网站暴露出来的网站地图SiteMap来监控全站。   
+> 注意⚠️，此监控需您网站支持SiteMap。我们支持XML和TXT格式的SiteMap。     
+
+### 配置参数
+
+| 参数名称      | 参数帮助描述 |
+| ----------- | ----------- |
+| 监控Host     | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
+| 监控名称     | 标识此监控的名称，名称需要保证唯一性。  |
+| 端口        | 网站对外提供的端口，http一般默认为80，https一般默认为443。  |
+| 网站地图     | 网站SiteMap地图地址的相对路径，例如：/sitemap.xml。  |
+| 启用HTTPS   | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443  |
+| 采集间隔    | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为10秒  |
+| 是否探测    | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作  |
+| 描述备注    | 更多标识和描述此监控的备注信息，用户可以在这里备注信息  |
+
+### 采集指标
+
+#### 指标集合：summary
+
+| 指标名称      | 指标单位 | 指标帮助描述 |
+| ----------- | ----------- | ----------- |
+| url         | 无 | 网页的URL路径 |
+| statusCode  | 无 | 请求此网页的响应HTTP状态码 |
+| responseTime   | ms毫秒 | 网站响应时间 |
+| errorMsg     | 无 | 请求此网站反馈的错误信息 |
+

home/docs/help/guide.md

@@ -1,5 +1,44 @@
 ---
 id: guide  
-title: 帮助入门    
+title: 帮助中心      
 sidebar_label: 帮助入门  
 ---
+
+> TanCloud - 易用友好的高性能监控云    
+> 使用过程中的帮助文档,辅助信息
+
+## 🔬 监控服务
+
+> 定时采集监控对端服务暴露的性能指标，提供可视化界面，处理数据供告警等服务调度。      
+> 规划的监控类型：应用服务，数据库，操作系统，云原生，开源中间件
+
+### 应用服务监控  
+
+[网站监测](website)        [HTTP API](api)      [PING连通性](ping)      [端口可用性](port)      [全站监控](fullsite)
+
+### 数据库监控  
+
+[MYSQL数据库监控](mysql)   
+
+## 💡 告警服务  
+
+> 更自由化的阈值告警配置，支持邮箱，短信，webhook，钉钉，企业微信，飞书机器人等告警通知。     
+> 告警服务的定位是阈值准确及时触发，告警通知及时可达。   
+
+### 告警中心  
+
+> 已触发的告警信息中心，提供告警删除，告警处理，标记未处理，告警级别状态等查询过滤。   
+
+### 告警配置  
+
+> 指标阈值配置，提供表达式形式的指标阈值配置，可设置告警级别，触发次数，告警通知模版和是否启用，关联监控等功能。
+
+### 告警通知  
+
+> 触发告警信息后，除了显示在告警中心列表外，还可以用指定方式(邮件钉钉微信飞书等)通知给指定接收人。   
+> 告警通知提供设置不同类型的通知方式，如邮件接收人，企业微信机器人通知，钉钉机器人通知，飞书机器人通知。   
+> 接收人设置后需要设置关联的告警通知策略，来配置哪些告警信息发给哪些接收人。   
+
+
+[配置邮箱通知](alert_email)        [配置WebHook通知](alert_webhook)      [配置企业微信机器人通知](alert_wework)    
+[配置钉钉机器人通知](alert_dingtalk)      [配置飞书机器人通知](alert_feishu)   

home/docs/help/mysql.md

@@ -0,0 +1,57 @@
+---
+id: mysql  
+title: 监控：MYSQL数据库监控      
+sidebar_label: MYSQL数据库   
+---
+
+> 对MYSQL数据库的通用性能指标进行采集监控。支持MYSQL5+。
+
+### 配置参数
+
+| 参数名称      | 参数帮助描述 |
+| ----------- | ----------- |
+| 监控Host     | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
+| 监控名称     | 标识此监控的名称，名称需要保证唯一性。  |
+| 端口        | 网站对外提供的端口，http一般默认为80，https一般默认为443。  |
+| 数据库名称   | 数据库实例名称，可选。  |
+| 用户名      | 数据库连接用户名，可选 |
+| 密码        | 数据库连接密码，可选 |
+| URL        | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数  |
+| 采集间隔    | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为10秒  |
+| 是否探测    | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作  |
+| 描述备注    | 更多标识和描述此监控的备注信息，用户可以在这里备注信息  |
+
+### 采集指标
+
+#### 指标集合：basic
+
+| 指标名称      | 指标单位 | 指标帮助描述 |
+| ----------- | ----------- | ----------- |
+| version         | 无 | 数据库版本 |
+| port            | 无 | 数据库暴露服务端口 |
+| datadir         | 无 | 数据库存储数据盘地址 |
+| max_connections | 无 | 数据库最大连接数 |
+
+#### 指标集合：status
+
+| 指标名称      | 指标单位 | 指标帮助描述 |
+| ----------- | ----------- | ----------- |
+| threads_created         | 无 | MySql已经创建的总连接数 |
+| threads_connected            | 无 | MySql已经连接的连接数 |
+| threads_cached         | 无 | MySql当前缓存的连接数 |
+| threads_running | 无 | MySql当前活跃的连接数 |
+| qps         | 无 | 每秒请求查询次数。`QPS = questions/uptimes` |   
+| tps | 无 | 每秒事务数据 `TPS= (commit+rollback)/seconds`|  
+
+
+#### 指标集合：innodb
+
+| 指标名称      | 指标单位 | 指标帮助描述 |
+| ----------- | ----------- | ----------- |
+| innodb_data_reads         | 无 | innodb平均每秒从文件中读取的次数 |
+| innodb_data_writes            | 无 | innodb平均每秒从文件中写入的次数 |
+| innodb_data_read         | KB | innodb平均每秒钟读取的数据量，单位为KB |
+| innodb_data_written | KB | innodb平均每秒钟写入的数据量，单位为KB |   
+
+
+

home/docs/help/ping.md

@@ -0,0 +1,27 @@
+---
+id: ping  
+title: 监控：PING连通性      
+sidebar_label: PING连通性       
+---
+
+> 对对端HOST地址进行PING操作，判断其连通性   
+
+### 配置参数
+
+| 参数名称      | 参数帮助描述 |
+| ----------- | ----------- |
+| 监控Host     | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
+| 监控名称     | 标识此监控的名称，名称需要保证唯一性。  |
+| Ping超时时间 | 设置PING未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。  |
+| 采集间隔    | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为10秒  |
+| 是否探测    | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作  |
+| 描述备注    | 更多标识和描述此监控的备注信息，用户可以在这里备注信息  |
+
+### 采集指标
+
+#### 指标集合：summary
+
+| 指标名称      | 指标单位 | 指标帮助描述 |
+| ----------- | ----------- | ----------- |
+| responseTime   | ms毫秒 | 网站响应时间 |
+

home/docs/help/port.md

@@ -0,0 +1,29 @@
+---
+id: port  
+title: 监控：端口可用性      
+sidebar_label: 端口可用性    
+---
+
+> 判断对端服务暴露端口是否可用，进而判断对端服务是否可用，采集响应时间等指标进行监测
+
+### 配置参数
+
+| 参数名称      | 参数帮助描述 |
+| ----------- | ----------- |
+| 监控Host     | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
+| 监控名称     | 标识此监控的名称，名称需要保证唯一性。  |
+| 端口        | 网站对外提供的端口，http一般默认为80，https一般默认为443。  |
+| 连接超时时间 | 端口连接的等待超时时间，单位毫秒，默认3000毫秒。  |
+| 采集间隔    | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为10秒  |
+| 是否探测    | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作  |
+| 描述备注    | 更多标识和描述此监控的备注信息，用户可以在这里备注信息  |
+
+### 采集指标
+
+#### 指标集合：summary
+
+| 指标名称      | 指标单位 | 指标帮助描述 |
+| ----------- | ----------- | ----------- |
+| responseTime   | ms毫秒 | 网站响应时间 |
+
+

home/docs/help/website.md

@@ -0,0 +1,29 @@
+---
+id: website  
+title: 监控：网站监测      
+sidebar_label: 网站监测    
+---
+
+> 对网站是否可用，响应时间等指标进行监测       
+
+### 配置参数   
+
+| 参数名称      | 参数帮助描述 |
+| ----------- | ----------- |
+| 监控Host     | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
+| 监控名称     | 标识此监控的名称，名称需要保证唯一性。  |
+| 端口        | 网站对外提供的端口，http一般默认为80，https一般默认为443。  |
+| 相对路径     | 网站地址除IP端口外的后缀路径，例如 `www.tancloud.cn/console` 网站的相对路径为 `/console`。  |
+| 启用HTTPS   | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443  |
+| 采集间隔    | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为10秒  |
+| 是否探测    | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作  |
+| 描述备注    | 更多标识和描述此监控的备注信息，用户可以在这里备注信息  |
+
+### 采集指标   
+
+#### 指标集合：summary  
+
+| 指标名称      | 指标单位 | 指标帮助描述 |
+| ----------- | ----------- | ----------- |
+| responseTime   | ms毫秒 | 网站响应时间 |
+

home/sidebars.json

@@ -28,14 +28,29 @@
           "type": "category",
           "label": "应用服务监控",
           "items": [
-            "help/guide"
+            "help/website",
+            "help/api",
+            "help/ping",
+            "help/port",
+            "help/fullsite"
           ]
         },
         {
           "type": "category",
           "label": "数据库监控",
           "items": [
-            "help/guide"
+            "help/mysql"
+          ]
+        },
+        {
+          "type": "category",
+          "label": "告警通知配置",
+          "items": [
+            "help/alert_email",
+            "help/alert_webhook",
+            "help/alert_wework",
+            "help/alert_dingtalk",
+            "help/alert_feishu"
           ]
         }
       ]