定义记录规则

配置规则

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 指标将为规则组的每次错过迭代递增。