定义记录规则

配置规则

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> ]

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

限制告警和时间序列

可以按组配置告警规则产生的告警以及记录规则产生的时间序列的限制。当超出限制时,该规则产生的所有所有时间序列都将被丢弃;如果是告警规则,该规则的所有告警(活动、待处理或非活动状态)也将被清除。此事件将记录为评估错误,因此不会写入 stale marker。

规则查询偏移量

这有助于确保底层指标已接收并存储在 Prometheus 中。由于分布式系统的特性,当 Prometheus 作为远端写入目标运行时,指标可用性延迟更有可能发生,但也可能在抓取出现异常和/或评估间隔较短时发生。

由于评估缓慢导致的规则评估失败

如果一个规则组在下一次评估本应开始之前(由 evaluation_interval 定义)尚未完成评估,则会跳过下一次评估。该规则组的后续评估将继续被跳过,直到最初的评估完成或超时。发生这种情况时,记录规则产生的指标将会出现空隙。rule_group_iterations_missed_total 指标将针对规则组的每一次跳过的迭代进行递增。

本文档是开源的。请通过提交 issue 或 pull request 帮助改进它。