定义记录规则

配置规则

Prometheus 支持两种类型的规则，可以配置并定期评估：记录规则和 告警规则。要将规则包含在 Prometheus 中，请创建一个包含必要规则语句的文件，并通过 Prometheus 配置 中的 rule_files 字段让 Prometheus 加载该文件。规则文件使用 YAML 格式。

规则文件可以在运行时通过向 Prometheus 进程发送 SIGHUP 信号来重新加载。只有当所有规则文件格式正确时，更改才会生效。

语法检查规则

要快速检查规则文件语法是否正确而无需启动 Prometheus 服务器，您可以使用 Prometheus 的 promtool 命令行工具。

promtool check rules /path/to/example.rules.yml

promtool 二进制文件是项目下载页面上提供的 prometheus 归档文件的一部分。

当文件语法有效时，检查器会将已解析规则的文本表示打印到标准输出，然后以 0 返回状态退出。

如果存在任何语法错误或无效的输入参数，它会向标准错误打印一条错误消息，并以 1 返回状态退出。

记录规则

记录规则允许您预先计算常用或计算成本高的表达式，并将其结果保存为一组新的时间序列。然后，查询预计算的结果通常比每次需要时执行原始表达式要快得多。这对于仪表盘尤其有用，因为仪表盘每次刷新时都需要重复查询相同的表达式。

记录规则和告警规则存在于规则组中。组内的规则会以相同的评估时间，按固定间隔顺序执行。记录规则的名称必须是有效的指标名称。告警规则的名称必须是有效的标签值。

规则文件的语法是：

groups:
  [ - <rule_group> ]

一个简单的规则文件示例如下：

groups:
  - name: example
    rules:
    - record: code:prometheus_http_requests_total:sum
      expr: sum by (code) (prometheus_http_requests_total)

<rule_group>

# The name of the group. Must be unique within a file.
name: <string>

# How often rules in the group are evaluated.
[ interval: <duration> | default = global.evaluation_interval ]

# Limit the number of alerts an alerting rule and series a recording
# rule can produce. 0 is no limit.
[ limit: <int> | default = 0 ]

# Offset the rule evaluation timestamp of this particular group by the specified duration into the past.
[ query_offset: <duration> | default = global.rule_query_offset ]

# Labels to add or overwrite before storing the result for its rules.
# Labels defined in <rule> will override the key if it has a collision.
labels:
  [ <labelname>: <labelvalue> ]

rules:
  [ - <rule> ... ]

<rule>

记录规则的语法是：

# The name of the time series to output to. Must be a valid metric name.
record: <string>

# The PromQL expression to evaluate. Every evaluation cycle this is
# evaluated at the current time, and the result recorded as a new set of
# time series with the metric name as given by 'record'.
expr: <string>

# Labels to add or overwrite before storing the result.
labels:
  [ <labelname>: <labelvalue> ]

告警规则的语法是：

# The name of the alert. Must be a valid label value.
alert: <string>

# The PromQL expression to evaluate. Every evaluation cycle this is
# evaluated at the current time, and all resultant time series become
# pending/firing alerts.
expr: <string>

# Alerts are considered firing once they have been returned for this long.
# Alerts which have not yet fired for long enough are considered pending.
[ for: <duration> | default = 0s ]

# How long an alert will continue firing after the condition that triggered it
# has cleared.
[ keep_firing_for: <duration> | default = 0s ]

# Labels to add or overwrite for each alert.
labels:
  [ <labelname>: <tmpl_string> ]

# Annotations to add to each alert.
annotations:
  [ <labelname>: <tmpl_string> ]

另请参阅为记录规则创建的指标命名的最佳实践。

限制告警和序列

可以为每个组配置由告警规则产生的告警和由记录规则产生的序列的限制。当超过限制时，该规则产生的所有序列都将被丢弃，如果这是一个告警规则，则该规则的所有告警（无论是活动的、待定的还是非活动的）也将被清除。该事件将被记录为评估中的错误，因此不会写入过时标记。

规则查询偏移

这对于确保基础指标已被接收并存储在 Prometheus 中非常有用。当 Prometheus 作为远程写入目标运行时，由于分布式系统的特性，指标可用性延迟更有可能发生，但也可能在采集和/或评估间隔较短时出现异常。

因评估缓慢导致的规则评估失败

如果一个规则组在下一次评估（由 evaluation_interval 定义）应该开始之前尚未完成评估，那么下一次评估将被跳过。该规则组的后续评估将继续被跳过，直到初始评估完成或超时。当这种情况发生时，记录规则产生的指标将出现一个缺口。对于规则组的每次错过的迭代，rule_group_iterations_missed_total 指标都会增加。