版本：1.0

Trigger 语法

注意

本功能仅在 GreptimeDB 企业版中可用。

CREATE TRIGGER

创建 Trigger 的语法：

CREATE TRIGGER [IF NOT EXISTS] <trigger_name>
        ON (<query_expression>) EVERY <interval_expression>
        [LABELS (<label_name>=<label_val>, ...)]
        [ANNOTATIONS (<annotation_name>=<annotation_val>, ...)]
        [FOR <interval_expression>]
        [KEEP FIRING FOR <interval_expression>]
        NOTIFY (
                WEBHOOK <notify_name1> URL '<url1>' [WITH (<parameter1>=<value1>, ...)],
                WEBHOOK <notify_name2> URL '<url2>' [WITH (<parameter2>=<value2>, ...)]
        );

Trigger name：Trigger 在 catalog 级别的唯一标识符。
IF NOT EXISTS：阻止 Trigger 已经存在时的报错。

On 子句

Query expression

指定的 SQL 查询会被定期执行。每次查询的结果可能形成一个或多个告警实例，具体取决于返回的行。

Trigger 会从查询结果中提取 labels 和 annotations，并将这些信息附加到每个告警实例上。同时，它们也会与 LABELS 和 ANNOTATIONS 子句中指定的静态键值对合并。

提取规则如下：

若列名（或别名）以 label_ 开头，则将该列提取到 LABELS 中，键名为去掉 label_ 前缀后的列名（或别名）。
其余所有列均提取到 ANNOTATIONS 中，键名即为列名（或别名）。

值得注意的是，每个告警实例都由其 Label 集合唯一标识。如果多行查询结果生成的 Label 集合相同，它们只会形成同一个告警实例。

例如，查询表达式如下：

SELECT collect as label_collector, host as label_host, val
    FROM host_load1
    WHERE val > 10 and ts >= now() - '1 minutes'::INTERVAL

假设查询结果非空，且如下所示：

label_collector	label_host	val
collector1	host1	12
collector2	host2	15

这将产生两条通知。

第一条通知的 labels 与 annotations 如下：

Labels:
- collector: collector1
- host: host1
- 以及 LABELS 子句中定义的 labels
Annotations:
- val: 12
- 以及 ANNOTATIONS 子句中定义的 annotations

第二条通知的 labels 与 annotations 如下：

Labels:
- collector: collector2
- host: host2
- 以及 LABELS 子句中定义的 labels
Annotations:
- val: 15
- 以及 ANNOTATIONS 子句中定义的 annotations

Interval expression

指定查询的执行间隔。它表示查询的执行频率。例如，INTERVAL '1 minute'、 INTERVAL '1 hour' 等。

INTERVAL 表达式中禁止使用 years 和 months。月和年的时长是可变的，取决于具体的月份或年份，因此不适合用来定义固定的间隔。
最小间隔为 1 秒。任何小于 1 秒的间隔都会被自动向上取整为 1 秒。

有关 INTERVAL 表达式的更多语法细节，请参见 interval-type。

FOR 子句

FOR <interval_expression> 子句用于控制某个告警在真正触发前需要保持活跃的持续时间，其作用与 Prometheus Alerting Rules 中的 for 选项类似。

当评估结果中首次出现某个告警实例时，它首先会进入 Pending 状态，此时不会触发通知。若该告警实例在 FOR 指定的持续时间内的每次评估中均保持活跃（即始终出现在查询结果中），则状态将由 Pending 转为 Firing，并立即发送通知。

若未指定 FOR 子句，则告警不会进入 Pending 状态，而是在评估结果中首次出现该告警实例时立即进入 Firing 状态，并马上触发通知。

KEEP FIRING FOR 子句

KEEP FIRING FOR <interval_expression> 子句用于控制某个告警实例在首次进入 Firing 状态后，至少需要保持多长时间处于 Firing 状态，其作用与 Prometheus Alerting Rules 中的 keep_firing_for 选项类似。

当某个告警实例满足条件并进入 Firing 状态后，即便后续评估中该告警实例不再出现在查询结果中，只要距离首次进入 Firing 状态尚未超过 KEEP FIRING FOR 指定的时长，该告警实例仍会保持 Firing 状态。

一旦超过 KEEP FIRING FOR 指定的时长，在下一次评估中如果该告警实例仍未出现在查询结果中，则会被标记为已恢复，不再处于 Firing 状态。

若未指定 KEEP FIRING FOR 子句，则告警实例在进入 Firing 状态后，只要在后续评估中不再出现在查询结果中，就会在该次评估中被标记为已恢复。

Labels 和 Annotations 子句

LABELS 和 ANNOTATIONS 子句用于在 Trigger 发送的通知消息中附加静态的键值对，以提供有关该 Trigger 的额外上下文或元数据。

LABELS：可用于 Alertmanager 的路由、分组与抑制规则等。
ANNOTATIONS：通常用于存放供人类阅读的描述信息。

Notify 子句

NOTIFY 子句允许指定一个或多个通知通道。目前，GreptimeDB 支持以下通道类型：

Webhook

当 Trigger 触发时，Webhook 通道会向指定的 URL 发送 HTTP 请求。请求的 payload 与 Prometheus Alertmanager 兼容，因此我们可以复用 Alertmanager 的分组、抑制、静默和路由功能，而无需任何额外的胶水代码。

可选的 WITH 子句允许指定额外的参数：

timeout：HTTP 请求的超时时间，例如 timeout='1m'。

SHOW TRIGGERS

列出所有的 Triggers：

SHOW TRIGGERS;

当然，它也支持 LIKE 查询：

SHOW TRIGGERS LIKE '<pattern>';

例如：

SHOW TRIGGERS LIKE 'load%';

以及 WHERE 条件：

SHOW TRIGGERS WHERE <condition>;

例如：

SHOW TRIGGERS WHERE name = 'load1_monitor';

SHOW CREATE TRIGGER

用于显示 TRIGGER 的定义：

SHOW CREATE TRIGGER <trigger-name>;

例如：

SHOW CREATE TRIGGER load1_monitor;

DROP TRIGGER

请使用以下 DROP TRIGGER 语句删除 Trigger：

DROP TRIGGER [IF EXISTS] <trigger-name>;

For example:

DROP TRIGGER IF EXISTS load1_monitor;

示例

请参考企业版用户指南中的 Trigger 文档。

Trigger 语法

CREATE TRIGGER​

On 子句​

Query expression​

Interval expression​

FOR 子句​

KEEP FIRING FOR 子句​

Labels 和 Annotations 子句​

Notify 子句​

Webhook​

SHOW TRIGGERS​

SHOW CREATE TRIGGER​

DROP TRIGGER​

示例​