跳转到主要内容
Monitors 支持使用标准 SQL 语法对 MySQL 进行查询,并根据查询结果触发告警。

核心概念

关联查询和恢复查询支持 ${label_name} 变量和 Go 模板 {{ $labels.<标签名> }}。主查询不支持变量,包含 ${...} 的主查询在保存时会被拒绝,提示 variables are only supported in relate and recovery queries。
变量需要告警引擎 v0.76.0 或以上版本;服务该规则数据源的集群内有实例低于此版本时,保存或启用会被拒绝,错误提示以 MySQL relate or recovery queries with variables require 开头并指明集群与所需版本。不使用变量的规则不受该版本限制。
变量替换后的 SQL 到运行期才确定,保存时无法预检。告警引擎按告警实例渲染变量,再检查渲染结果是否为只读查询,不是只读查询时该次评估失败。

查询语句限制

MySQL 规则的 SQL 必须是单条只读语句。查询、关联查询和恢复查询按同一套规则校验,不符合时保存被拒绝,错误提示以字段名开头,例如 rule config invalid: query(A) expr: …。
  • 语句必须以 SELECT、WITH、SHOW、DESC、DESCRIBE 或 EXPLAIN 开头,否则提示 MySQL statement must start with SELECT, WITH, SHOW, DESC, DESCRIBE, or EXPLAIN。
  • 语句中任何位置都不能出现 INTO、INSERT、UPDATE 和 DELETE 这四个关键字,因此 SELECT … INTO OUTFILE、WITH … DELETE、INSERT … SELECT 都会被拒绝,提示为 MySQL keyword INTO is not allowed(关键字以大写回显);作为字符串函数写法的 INSERT(...) 不受影响。
  • 只能包含一条语句,多条时提示 multiple MySQL statements are not allowed。
  • 不接受可执行注释,提示 executable SQL comments are not allowed。MySQL 的 /*! … */、MariaDB 的 /*M! … */ 和 TiDB 的 /*T! … */ 都属于可执行注释,普通 /* … */ 注释可以使用。
  • 不接受 EXPLAIN ANALYZE,提示 MySQL EXPLAIN ANALYZE is not allowed;单用 EXPLAIN 或 DESC 可以。
这是一条按词法判断的只读策略,挡的是明显的写操作;数据源账号本身的只读权限才是真正的边界。

阈值判定模式

此模式适用于需要对聚合后的数值进行阈值比对的场景。

配置方式

  1. 查询语句:编写 SQL 聚合查询,返回数值列和(可选的)标签列。
    • 示例:统计最近 5 分钟内,各服务的错误日志数量(假设有一个日志表)。
  2. 字段映射:
    • 值字段:选择 error_cnt,用于阈值判定。
    • 标签字段:选择 service_name,用于标识告警对象。明确选择标签字段后,其他非值字段会作为附加信息随告警携带。
    • 详细规则请参见查询结果字段映射。
  3. 阈值条件:
    • 使用 $A.field_name 引用数值。
    • 示例:Critical: $A.error_cnt > 50,Warning: $A.error_cnt > 10。

工作原理

Monitors 按标签字段区分告警对象,并使用值字段进行阈值判定。标签字段留空时,除值字段外的所有返回字段都会作为标签。

恢复逻辑

恢复方式见告警恢复。恢复查询是独立 SQL,支持 ${label_name} 变量,也支持 Go 模板 {{ $labels.<标签名> }}。这类规则同样受上文版本限制:集群内有实例低于 v0.76.0 时,保存或启用会被拒绝。

数据存在模式

此模式适用于将过滤逻辑直接写在 SQL 中的场景。

配置方式

  1. 查询语句:在 SQL 中使用 HAVING 子句直接过滤出异常数据。
    • 示例:直接查询错误数超过 50 的服务。
  2. 判定规则:只要 SQL 查询返回了数据(Result Set 不为空),即触发告警。
数据存在模式无法区分多级告警;需要分级时使用阈值判定模式。

恢复逻辑

恢复方式见告警恢复。

数据缺失模式

此模式用于监控”预期应该有数据,但实际没有数据”的场景。

配置方式

  1. 查询语句:编写一个预期应该持续返回数据的 SQL 查询。
    • 示例:查询所有探针的心跳上报。
  2. 判定规则:如果某个 probe_id 在之前的周期中出现过,但在当前及连续 N 个周期中查不到数据,则触发”数据缺失”告警。

恢复逻辑

恢复方式见告警恢复。

最佳实践

务必在 WHERE 子句中包含时间范围过滤,并确保时间字段上有索引,否则可能导致全表扫描。推荐写法:log_time > now() - INTERVAL 5 MINUTE
Monitors 会将 MySQL 返回的列名统一转为小写。填写标签字段和值字段时,请始终使用小写字母。