diff --git a/alert/README.md b/alert/README.md index b8b8c92a2797bf58ca9f80b1781fc1f5d7555f6b..8567c3b1671197d8878385b30a79ab077ea1c354 100644 --- a/alert/README.md +++ b/alert/README.md @@ -1,6 +1,6 @@ # Alert -The Alert application reads data from [TDEngine](https://www.taosdata.com/), calculating according to predefined rules to generate alerts, and pushes alerts to downstream applications like [AlertManager](https://github.com/prometheus/alertmanager). +The Alert application reads data from [TDengine](https://www.taosdata.com/), calculating according to predefined rules to generate alerts, and pushes alerts to downstream applications like [AlertManager](https://github.com/prometheus/alertmanager). ## Install @@ -22,7 +22,7 @@ $ ./install_driver.sh Two prerequisites are required to install from source. -1. TDEngine server or client must be installed. +1. TDengine server or client must be installed. 2. Latest [Go](https://golang.org) language must be installed. When these two prerequisites are ready, please follow steps below to build the application: @@ -61,13 +61,13 @@ The use of each configuration item is: * **port**: This is the `http` service port which enables other application to manage rules by `restful API`. * **database**: rules are stored in a `sqlite` database, this is the path of the database file (if the file does not exist, the alert application creates it automatically). -* **tdengine**: connection string of `TDEngine` server (please refer the documentation of GO connector for the detailed format of this string), note the database name should be put in the `sql` field of a rule in most cases, thus it should NOT be included in the string. +* **tdengine**: connection string of `TDengine` server (please refer the documentation of GO connector for the detailed format of this string), note the database name should be put in the `sql` field of a rule in most cases, thus it should NOT be included in the string. * **log > level**: log level, could be `production` or `debug`. * **log > path**: log output file path. * **receivers > alertManager**: the alert application pushes alerts to `AlertManager` at this URL. * **receivers > console**: print out alerts to console (stdout) or not. -When the configruation file is ready, the alert application can be started with below command (`alert.cfg` is the path of the configuration file): +When the configuration file is ready, the alert application can be started with below command (`alert.cfg` is the path of the configuration file): ``` $ ./alert -cfg alert.cfg @@ -75,7 +75,7 @@ $ ./alert -cfg alert.cfg ## Prepare an alert rule -From technical aspect, an alert could be defined as: query and filter recent data from `TDEngine`, and calculating out a boolean value from these data according to a formula, and trigger an alert if the boolean value last for a certain duration. +From technical aspect, an alert could be defined as: query and filter recent data from `TDengine`, and calculating out a boolean value from these data according to a formula, and trigger an alert if the boolean value last for a certain duration. This is a rule example in `json` format: @@ -98,8 +98,8 @@ This is a rule example in `json` format: The fields of the rule is explained below: * **name**: the name of the rule, must be unique. -* **sql**: this is the `sql` statement used to query data from `TDEngine`, columns of the query result are used in later processing, so please give the column an alias if aggregation functions are used. -* **expr**: an expression whose result is a boolean value, arithmatic and logical calculations can be included in the expression, and builtin functions (see below) are also supported. Alerts are only triggered when the expression evaluates to `true`. +* **sql**: this is the `sql` statement used to query data from `TDengine`, columns of the query result are used in later processing, so please give the column an alias if aggregation functions are used. +* **expr**: an expression whose result is a boolean value, arithmetic and logical calculations can be included in the expression, and builtin functions (see below) are also supported. Alerts are only triggered when the expression evaluates to `true`. * **for**: this item is a duration which default value is zero second. when `expr` evaluates to `true` and last at least this duration, an alert is triggered. * **period**: the interval for the alert application to check the rule, default is 1 minute. * **labels**: a label list, labels are used to generate alert information. note if the `sql` statement includes a `group by` clause, the `group by` columns are inserted into this list automatically. diff --git a/alert/README_cn.md b/alert/README_cn.md index f659e997e3ea8ec8acef8cc3eb6e41a4c692a476..cc9907f32c3c765472d3fe59f32067beab543e88 100644 --- a/alert/README_cn.md +++ b/alert/README_cn.md @@ -1,6 +1,6 @@ # Alert -报警监测程序，从 [TDEngine](https://www.taosdata.com/) 读取数据后，根据预定义的规则计算和生成报警，并将它们推送到 [AlertManager](https://github.com/prometheus/alertmanager) 或其它下游应用。 +报警监测程序，从 [TDengine](https://www.taosdata.com/) 读取数据后，根据预定义的规则计算和生成报警，并将它们推送到 [AlertManager](https://github.com/prometheus/alertmanager) 或其它下游应用。 ## 安装 @@ -20,7 +20,7 @@ $ ./install_driver.sh ### 从源码安装 -从源码安装需要在您用于编译的计算机上提前安装好 TDEngine 的服务端或客户端，如果您还没有安装，可以参考 TDEngine 的文档。 +从源码安装需要在您用于编译的计算机上提前安装好 TDengine 的服务端或客户端，如果您还没有安装，可以参考 TDengine 的文档。 报警监测程序使用 [Go语言](https://golang.org) 开发，请安装最新版的 Go 语言编译环境。 @@ -58,7 +58,7 @@ $ go build * **port**：报警监测程序支持使用 `restful API` 对规则进行管理，这个参数用于配置 `http` 服务的侦听端口。 * **database**：报警监测程序将规则保存到了一个 `sqlite` 数据库中，这个参数用于指定数据库文件的路径（不需要提前创建这个文件，如果它不存在，程序会自动创建它）。 -* **tdengine**：`TDEngine` 的连接字符串（这个字符串的详细格式说明请见 GO 连接器的文档），一般来说，数据库名应该在报警规则的 `sql` 语句中指定，所以这个字符串中 **不** 应包含数据库名。 +* **tdengine**：`TDengine` 的连接字符串（这个字符串的详细格式说明请见 GO 连接器的文档），一般来说，数据库名应该在报警规则的 `sql` 语句中指定，所以这个字符串中 **不** 应包含数据库名。 * **log > level**：日志的记录级别，可选 `production` 或 `debug`。 * **log > path**：日志文件的路径。 * **receivers > alertManager**：报警监测程序会将报警推送到 `AlertManager`，在这里指定 `AlertManager` 的接收地址。 @@ -72,7 +72,7 @@ $ ./alert -cfg alert.cfg ## 编写报警规则 -从技术角度，可以将报警描述为：从 `TDEngine` 中查询最近一段时间、符合一定过滤条件的数据，并基于这些数据根据定义好的计算方法得出一个结果，当结果符合某个条件且持续一定时间后，触发报警。 +从技术角度，可以将报警描述为：从 `TDengine` 中查询最近一段时间、符合一定过滤条件的数据，并基于这些数据根据定义好的计算方法得出一个结果，当结果符合某个条件且持续一定时间后，触发报警。 根据上面的描述，可以很容易的知道报警规则中需要包含的大部分信息。 以下是一个完整的报警规则，采用标准 `json` 格式： @@ -95,7 +95,7 @@ $ ./alert -cfg alert.cfg 其中： * **name**：用于为规则指定一个唯一的名字。 -* **sql**：从 `TDEngine` 中查询数据时使用的 `sql` 语句，查询结果中的列将被后续计算使用，所以，如果使用了聚合函数，请为这一列指定一个别名。 +* **sql**：从 `TDengine` 中查询数据时使用的 `sql` 语句，查询结果中的列将被后续计算使用，所以，如果使用了聚合函数，请为这一列指定一个别名。 * **expr**：一个计算结果为布尔型的表达式，支持算数运算、逻辑运算，并且内置了部分函数，也可以引用查询结果中的列。 当表达式计算结果为 `true` 时，进入报警状态。 * **for**：当表达式计算结果为 `true` 的连续时长超过这个选项时，触发报警，否则报警处于“待定”状态。默认为0，表示一旦计算结果为 `true`，立即触发报警。 * **period**：规则的检查周期，默认1分钟。