Prometheus规则

...

rule_files:
  - "prometheus.rules.yml"  # 指定具体文件
  - "rules/*.yml"  # 指定 rules 目录下的所有以 .yml 结尾的文件

groups:
  #  则组的名称，在当前文件中需唯一
  - name: example
    # 获取规则数据的频率，也就是每次查询规则的间隔时间，比如设置为 5s, 1m 等
    # 一般按默认，默认是安装 prometheus 配置文件中全局配置的 evaluation_interval 值
    [ interval: <duration> | default = global.evaluation_interval ]

    # 限制警报规则和记录规则可以产生的系列警报的数量。0 没有限制。一般按默认
    [ limit: <int> | default = 0 ]

    # 定义这个规则组中一个一个的规则
    rules:
      [- <rule> ...]

groups:
  - name: example
    rules:
      # record 字段： 输出到的时间序列的名称。必须是有效的度量值名称
    - record: code:prometheus_http_requests_total:sum

      # 要计算的PromQL表达式。每个评估周期都在当前时间进行评估，结果记录为一组新的时间序列
      # 度量名称由 "record" 给出
      expr: sum by (code) (prometheus_http_requests_total)

      # labels 下配置的是存储结果之前要添加或覆盖的标签
      labels:
        [ <labelname>: <labelvalue> ]

groups:
  - name: example
    rules:
      # alertname 警报的名称。必须符合有效标签名称的规则
    - alert: <string>

      # 要计算的 PromQL 表达式
      # 每个评估周期都会在当前时间进行评估，满足表达式条件后，所有生成的时间序列都会变为 pending 挂起/ firing alerts 触发警报
      expr: <string>

      # 当 expr 内书写的表达式条件满足后，警报会立刻变成 pending 状态
      # 持续超过 for 指定的时间后，警报会被视为触发，并转为 firing 状态
      # pending 和 firing 也会在 Prometheus Web 页面中看到
      [ for: <duration> | default = 0s ]

      # 触发警报的条件清除后，警报仍然保持触发状态多长时间
      [ keep_firing_for: <duration> | default = 0s ]

      # 要为每个警报添加或覆盖的标签。标签值可以使用 go 的模板变量
      labels:
        [ <labelname>: <tmpl_string> ]

      # 要添加到每个警报的注释。这个信息通常用于发送告警给某个介质（邮件，钉钉等）的内容中
      # lavelname 的值可以使用 go 的模板变量
      annotations:
        [ <labelname>: <tmpl_string> ]

groups:
- name: example
  rules:

  # 对任何超过5分钟无法访问的实例发出警报。
  - alert: InstanceDown
    expr: up == 0
    for: 5m
    labels:
      severity: page
    annotations:
      summary: "实例: {{ $labels.instance }} 已停机"
      description: "xx 项目作业 Job:｛｛$labels.job｝｝的｛{$labels.instance}｝已停机超过5分钟。"

  # 针对请求延迟中值>1s的任何实例发出警报
  - alert: APIHighRequestLatency
    expr: api_http_request_latencies_second{quantile="0.5"} > 1
    for: 10m
    annotations:
      summary: "实例 {{ $labels.instance }} 请求延迟高"
      description: "{{ $labels.instance }} 的请求延迟超过 1 秒(当前值: {{ $value }}s)"