OpenSource/hertzbeat
Public Access
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

[home]feature: support home docs i18n en (#94)

Browse Source 
* [home]feature: support home docs i18n en

* [home]feature: i18n update introduce

* [web-app]i18n for zh-TW

* [home]feature: i18n update docs
This commit is contained in:
tomsun28
2022-04-17 21:36:13 +08:00
committed by GitHub
parent 630c571f28
commit 81896f9ba1
57 changed files with 4553 additions and 499 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
home/i18n/en/docusaurus-plugin-content-docs/current/help/alert_console.md Normal file
View File

@@ -0,0 +1,18 @@
---
id: alert_console
title: 告警模板中自定义的控制台地址
sidebar_label: 告警模板登录台地址
---
> 阈值触发后发送告警信息，通过钉钉/企业微信/飞书机器人通知或者使用邮箱通知的时候，告警内容中有登录控制台的详情链接
### 自定义设置
在我们的启动配置文件application.yml中，找到下面的配置
```yml
alerter:
console-url: #这里就是我们的自定义控制台地址
```
默认值是赫兹跳动的官方控制台地址

40
home/i18n/en/docusaurus-plugin-content-docs/current/help/alert_dingtalk.md Normal file
View File

@@ -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反馈哦！

37
home/i18n/en/docusaurus-plugin-content-docs/current/help/alert_email.md Normal file
View File

@@ -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反馈哦！

33
home/i18n/en/docusaurus-plugin-content-docs/current/help/alert_feishu.md Normal file
View File

@@ -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反馈哦！

36
home/i18n/en/docusaurus-plugin-content-docs/current/help/alert_threshold.md Normal file
View File

@@ -0,0 +1,36 @@
---
id: alert_threshold
title: 阈值告警配置
sidebar_label: 阈值告警配置
---
> 对监控指标配置告警阈值(警告告警，严重告警，紧急告警)，系统根据阈值配置和采集指标数据计算触发告警。
### 操作步骤
1. **【告警配置】->【新增阈值】-> 【配置后确定】**
![threshold](/img/docs/help/alert-threshold-1.png)
如上图：
**指标对象**：选择我们需要配置阈值的监控指标对象 例如：网站监控类型下的 -> summary指标集合下的 -> responseTime响应时间指标
**阈值触发表达式**：根据此表达式来计算判断是否触发阈值，表达式环境变量和操作符见页面提示，例如：设置响应时间大于50触发告警，表达式为 `responseTime > 50`。阈值表达式详细帮助见 [阈值表达式帮助](alert_threshold_expr)
**告警级别**：触发阈值的告警级别,从低到高依次为:警告-warning，严重-critical，紧急-emergency
**触发次数**：设置触发阈值多少次之后才会真正的触发告警
**通知模版**：告警触发后发送的通知信息模版,模版环境变量见页面提示，例如：`${app}.${metrics}.${metric}指标的值为${responseTime}，大于50触发告警`
**全局默认**： 设置此阈值是否对全局的此类指标都应用有效，默认否。新增阈值后还需将阈值与监控对象关联，这样阈值才会对此监控生效。
**启用告警**：此告警阈值配置开启生效或关闭
2. ** 阈值关联监控⚠️ 【告警配置】-> 【将刚设置的阈值】-> 【配置关联监控】-> 【配置后确定】**
> ** 注意⚠️ 新增阈值后还需将阈值与监控对象关联(即设置此阈值对哪些监控有效)，这样阈值才会对此监控生效 **。
![threshold](/img/docs/help/alert-threshold-2.png)
![threshold](/img/docs/help/alert-threshold-3.png)
**阈值告警配置完毕，已经被成功触发的告警信息可以在【告警中心】看到。**
**若需要将告警信息邮件，微信，钉钉飞书通知给相关人员，可以在【告警通知】配置。**
其它问题可以通过交流群ISSUE反馈哦！

49
home/i18n/en/docusaurus-plugin-content-docs/current/help/alert_threshold_expr.md Normal file
View File

@@ -0,0 +1,49 @@
---
id: alert_threshold_expr
title: 阈值触发表达式
sidebar_label: 阈值触发表达式
---
> 在我们配置阈值告警时，需要配置阈值触发表达式，系统根据表达式和监控指标值计算触发是否告警，这里详细介绍下表达式使用。
#### 表达式支持的操作符
```
equals(str1,str2)
==
<
<=
>
>=
!=
( )
+
-
&&
||
```
丰富的操作符让我们可以很自由的定义表达式。
注意⚠️ 字符串的相等请用 `equals(str1,str2)` 数字类型的相等判断请用== 或 !=
#### 支持的环境变量
> 环境变量即指标值等支持的变量，用于在表达式中，阈值计算判断时会将变量替换成实际值进行计算
非固定环境变量：这些变量会根据我们选择的监控指标对象而动态变化，例如我们选择了**网站监控的响应时间指标**，则环境变量就有 `responseTime - 此为响应时间变量`
如果我们想设置**网站监控的响应时间大于400时**触发告警，则表达式为 `responseTime>400`
固定环境变量(不常用)：`instance : 所属行实例值`
此变量主要用于计算多实例时，比如采集到c盘d盘的`usage`(`usage为非固定环境变量`),我们只想设置**c盘的usage大于80**时告警，则表达式为 `equals(instance,"c")&&usage>80`
#### 表达式设置案例
1. 网站监控->响应时间大于等于400ms时触发告警
`responseTime>=400`
2. API监控->响应时间大于3000ms时触发告警
`responseTime>3000`
3. 全站监控->URL(instance)路径为 `https://baidu.com/book/3` 的响应时间大于200ms时触发告警
`equals(instance,"https://baidu.com/book/3")&&responseTime>200`
4. MYSQL监控->status指标组->threads_running(运行线程数)指标大于7时触发告警
`threads_running>7`
若遇到问题可以通过交流群ISSUE交流反馈哦！

47
home/i18n/en/docusaurus-plugin-content-docs/current/help/alert_webhook.md Normal file
View File

@@ -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反馈哦！

37
home/i18n/en/docusaurus-plugin-content-docs/current/help/alert_wework.md Normal file
View File

@@ -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反馈哦！

35
home/i18n/en/docusaurus-plugin-content-docs/current/help/api.md Normal file
View File

@@ -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毫秒 | 网站响应时间 |

34
home/i18n/en/docusaurus-plugin-content-docs/current/help/fullsite.md Normal file
View File

@@ -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 | 无 | 请求此网站反馈的错误信息 |

50
home/i18n/en/docusaurus-plugin-content-docs/current/help/guide.md Normal file
View File

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

47
home/i18n/en/docusaurus-plugin-content-docs/current/help/issue.md Normal file
View File

@@ -0,0 +1,47 @@
---
id: issue
title: 常见问题
sidebar_label: 常见问题
---
### 监控常见问题
1. ** 页面反馈：monitor.host:监控Host必须是ipv4,ipv6或域名 **
> 如信息所示，输入的监控Host须是ipv4,ipv6或域名，不能携带协议头，例如协议头http
2. ** 网站API等监控反馈statusCode:403或401，但对端服务本身无需认证，浏览器直接访问是OK **
> 请排查是否是被防火墙拦截，如宝塔等默认设置了对请求header中`User-Agent=Apache-HttpClient`的拦截，若被拦截请删除此拦截规则。(v1.0.beat5版本已将user-agent模拟成浏览器此问题不存在)
3. 安装包部署的hertzbeat下ping连通性监控异常
安装包安装部署的hertzbeat,对ping连通性监控不可用，但本地直接ping是可用的。
> 安装包部署需要配置java虚拟机root权限启动hertzbeat从而使用ICMP，若未启用root权限则是判断telnet对端7号端口是否开通
> docker安装默认启用无此问题
### Docker部署常见问题
1. **MYSQL,TDENGINE和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败**
此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。
> 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP
> 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....`
2. **按照流程部署，访问 http://ip:1157/console 无界面**
请参考下面几点排查问题：
> 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行
> 二：HertzBeat的配置文件 `application.yml` 里面的依赖服务IP账户密码等配置是否正确
> 三：若都无问题可以 `docker logs hertzbeat` 查看容器日志是否有明显错误，提issue或交流群或社区反馈
3. **日志报错TDengine连接或插入SQL失败**
> 一：排查配置的数据库账户密码是否正确，数据库是否创建
> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter
### 安装包部署常见问题
1. **按照流程部署，访问 http://ip:1157/console 无界面**
请参考下面几点排查问题：
> 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行
> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确
> 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈
2. **日志报错TDengine连接或插入SQL失败**
> 一：排查配置的数据库账户密码是否正确，数据库是否创建
> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter

81
home/i18n/en/docusaurus-plugin-content-docs/current/help/linux.md Normal file
View File

@@ -0,0 +1,81 @@
---
id: linux
title: 监控：Linux操作系统监控
sidebar_label: Linux操作系统
---
> 对Linux操作系统的通用性能指标进行采集监控。
### 配置参数
| 参数名称 | 参数帮助描述 |
| ----------- | ----------- |
| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
| 监控名称 | 标识此监控的名称，名称需要保证唯一性。 |
| 端口 | Linux SSH对外提供的端口，默认为22。 |
| 用户名 | SSH连接用户名，可选 |
| 密码 | SSH连接密码，可选 |
| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为10秒 |
| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 |
| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 |
### 采集指标
#### 指标集合：basic
| 指标名称 | 指标单位 | 指标帮助描述 |
| ----------- | ----------- | ----------- |
| hostname | 无 | 主机名称 |
| version | 无 | 操作系统版本 |
| uptime | 无 | 系统运行时间 |
#### 指标集合：cpu
| 指标名称 | 指标单位 | 指标帮助描述 |
| ----------- | ----------- | ----------- |
| info | 无 | CPU型号 |
| cores | 核数 | CPU内核数量 |
| interrupt | 个数 | CPU中断数量 |
| load | 无 | CPU最近1/5/15分钟的平均负载 |
| context_switch | 个数 | 当前上下文切换数量 |
| usage | % | CPU使用率 |
#### 指标集合：memory
| 指标名称 | 指标单位 | 指标帮助描述 |
| ----------- | ----------- | ----------- |
| total | Mb | 总内存容量 |
| used | Mb | 用户程序内存量 |
| free | Mb | 空闲内存容量 |
| buff_cache | Mb | 缓存占用内存 |
| available | Mb | 剩余可用内存容 |
| usage | % | 内存使用率 |
#### 指标集合：disk
| 指标名称 | 指标单位 | 指标帮助描述 |
| ----------- | ----------- | ----------- |
| disk_num | 块数 | 磁盘总数 |
| partition_num | 分区数 | 分区总数 |
| block_write | 块数 | 写入磁盘的总块数 |
| block_read | 块数 | 从磁盘读出的块数 |
| write_rate | iops | 每秒写磁盘块的速率 |
#### 指标集合：interface
| 指标名称 | 指标单位 | 指标帮助描述 |
| ----------- | ----------- | ----------- |
| interface_name | 无 | 网卡名称 |
| receive_bytes | byte | 入站数据流量(bytes) |
| transmit_bytes | byte | 出站数据流量(bytes) |
#### 指标集合：disk_free
| 指标名称 | 指标单位 | 指标帮助描述 |
| ----------- | ----------- | ----------- |
| filesystem | 无 | 文件系统的名称 |
| used | Mb | 已使用磁盘大小 |
| available | Mb | 可用磁盘大小 |
| usage | % | 使用率 |
| mounted | 无 | 挂载点目录 |

56
home/i18n/en/docusaurus-plugin-content-docs/current/help/mariadb.md Normal file
View File

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

56
home/i18n/en/docusaurus-plugin-content-docs/current/help/mysql.md Normal file
View File

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

62
home/i18n/en/docusaurus-plugin-content-docs/current/help/oracle.md Normal file
View File

@@ -0,0 +1,62 @@
---
id: oracle
title: 监控：ORACLE数据库监控
sidebar_label: ORACLE数据库
---
> 对ORACLE数据库的通用性能指标进行采集监控。
### 配置参数
| 参数名称 | 参数帮助描述 |
| ----------- | ----------- |
| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
| 监控名称 | 标识此监控的名称，名称需要保证唯一性。 |
| 端口 | 数据库对外提供的端口，默认为1521。 |
| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 |
| 数据库名称 | 数据库实例名称，可选。 |
| 用户名 | 数据库连接用户名，可选 |
| 密码 | 数据库连接密码，可选 |
| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 |
| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为10秒 |
| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 |
| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 |
### 采集指标
#### 指标集合：basic
| 指标名称 | 指标单位 | 指标帮助描述 |
| ----------- | ----------- | ----------- |
| database_version | 无 | 数据库版本 |
| database_type | 无 | 数据库类型 |
| hostname | 无 | 主机名称 |
| instance_name | 无 | 数据库实例名称 |
| startup_time | 无 | 数据库启动时间 |
| status | 无 | 数据库状态 |
#### 指标集合：tablespace
| 指标名称 | 指标单位 | 指标帮助描述 |
| ----------- | ----------- | ----------- |
| file_id | 无 | 文件ID |
| file_name | 无 | 文件名称 |
| tablespace_name | 无 | 所属表空间名称 |
| status | 无 | 状态 |
| bytes | MB | 大小 |
| blocks | 无 | 区块数量 |
#### 指标集合：user_connect
| 指标名称 | 指标单位 | 指标帮助描述 |
| ----------- | ----------- | ----------- |
| username | 无 | 用户名 |
| counts | 个数 | 当前连接数量 |
#### 指标集合：performance
| 指标名称 | 指标单位 | 指标帮助描述 |
| ----------- | ----------- | ----------- |
| qps | QPS | I/O Requests per Second 每秒IO请求数量 |
| tps | TPS | User Transaction Per Sec 每秒用户事物处理数量 |
| mbps | MBPS | I/O Megabytes per Second 每秒 I/O 兆字节数量 |

27
home/i18n/en/docusaurus-plugin-content-docs/current/help/ping.md Normal file
View File

@@ -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毫秒 | 网站响应时间 |

29
home/i18n/en/docusaurus-plugin-content-docs/current/help/port.md Normal file
View File

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

57
home/i18n/en/docusaurus-plugin-content-docs/current/help/postgresql.md Normal file
View File

@@ -0,0 +1,57 @@
---
id: postgresql
title: 监控：PostgreSQL数据库监控
sidebar_label: PostgreSQL数据库
---
> 对PostgreSQL数据库的通用性能指标进行采集监控。支持PostgreSQL 10+。
### 配置参数
| 参数名称 | 参数帮助描述 |
| ----------- | ----------- |
| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
| 监控名称 | 标识此监控的名称，名称需要保证唯一性。 |
| 端口 | 数据库对外提供的端口，默认为5432。 |
| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 |
| 数据库名称 | 数据库实例名称，可选。 |
| 用户名 | 数据库连接用户名，可选 |
| 密码 | 数据库连接密码，可选 |
| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 |
| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为10秒 |
| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 |
| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 |
### 采集指标
#### 指标集合：basic
| 指标名称 | 指标单位 | 指标帮助描述 |
| ----------- | ----------- | ----------- |
| server_version | 无 | 数据库服务器的版本号 |
| port | 无 | 数据库服务器端暴露服务端口 |
| server_encoding | 无 | 数据库服务器端的字符集编码 |
| data_directory | 无 | 数据库存储数据盘地址 |
| max_connections | 连接数 | 数据库最大连接数 |
#### 指标集合：state
| 指标名称 | 指标单位 | 指标帮助描述 |
| ----------- | ----------- | ----------- |
| name | 无 | 数据库名称，或share-object为共享对象。 |
| conflicts | 次数 | 由于与恢复冲突而在这个数据库中被取消的查询的数目 |
| deadlocks | 个数 | 在这个数据库中被检测到的死锁数 |
| blks_read | 次数 | 在这个数据库中被读取的磁盘块的数量 |
| blks_hit | 次数 | 磁盘块被发现已经在缓冲区中的次数，这样不需要一次读取（这只包括 PostgreSQL 缓冲区中的命中，而不包括在操作系统文件系统缓冲区中的命中） |
| blk_read_time | ms | 在这个数据库中后端花费在读取数据文件块的时间 |
| blk_write_time | ms | 在这个数据库中后端花费在写数据文件块的时间 |
| stats_reset | 无 | 这些统计信息上次被重置的时间 |
#### 指标集合：activity
| 指标名称 | 指标单位 | 指标帮助描述 |
| ----------- | ----------- | ----------- |
| running | 连接数 | 当前客户端连接数 |

57
home/i18n/en/docusaurus-plugin-content-docs/current/help/sqlserver.md Normal file
View File

@@ -0,0 +1,57 @@
---
id: sqlserver
title: 监控：SqlServer数据库监控
sidebar_label: SqlServer数据库
---
> 对SqlServer数据库的通用性能指标进行采集监控。支持SqlServer 2017+。
### 配置参数
| 参数名称 | 参数帮助描述 |
| ----------- | ----------- |
| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
| 监控名称 | 标识此监控的名称，名称需要保证唯一性。 |
| 端口 | 数据库对外提供的端口，默认为1433。 |
| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 |
| 数据库名称 | 数据库实例名称，可选。 |
| 用户名 | 数据库连接用户名，可选 |
| 密码 | 数据库连接密码，可选 |
| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 |
| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为10秒 |
| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 |
| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 |
### 采集指标
#### 指标集合：basic
| 指标名称 | 指标单位 | 指标帮助描述 |
| ----------- | ----------- | ----------- |
| machine_name | 无 | 运行服务器实例的 Windows 计算机名称 |
| server_name | 无 | 与Windows实例关联的服务器和实例信息SQL Server |
| version | 无 | 实例的版本，SQL Server，格式为"major.minor.build.revision" |
| edition | 无 | 已安装的 实例的产品SQL Server版本 |
| start_time | 无 | 数据库启动时间 |
#### 指标集合：performance_counters
| 指标名称 | 指标单位 | 指标帮助描述 |
| ----------- | ----------- | ----------- |
| database_pages | 无 | Database pages, 已获得的页面数(缓冲池) |
| target_pages | 无 | Target pages, 缓冲池必须的理想页面数 |
| page_life_expectancy | s,秒 | Page life expectancy, 数据页在缓冲池中驻留的时间，这个时间一般会大于 300 |
| buffer_cache_hit_ratio | % | Buffer cache hit ratio, 数据库缓冲池高速缓冲命中率，被请求的数据在缓冲池中被找到的概率，一般会大于 80% 才算正常，否则可能是缓冲池容量太小 |
| checkpoint_pages_sec | 无 | Checkpoint pages/sec, 检查点每秒写入磁盘的脏页个数，如果数据过高，证明缺少内存容量 |
| page_reads_sec | 无 | Page reads/sec, 缓存池中每秒读的页数 |
| page_writes_sec | 无 | Page writes/sec, 缓存池中每秒写的页数 |
#### 指标集合：connection
| 指标名称 | 指标单位 | 指标帮助描述 |
| ----------- | ----------- | ----------- |
| user_connection | 无 | 已连接的会话数 |

29
home/i18n/en/docusaurus-plugin-content-docs/current/help/website.md Normal file
View File

@@ -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毫秒 | 网站响应时间 |