文档

添加标签和标注

更新时间:

在创建告警监控规则时,您可以设置标签(labels)和标注(annotations)信息。标签主要应用于告警降噪、通知路由和管理分派等场景,标注主要应用于内容模板、管理分派等场景。

标签

标签主要应用于告警降噪、通知路由和管理分派等场景。

添加标签

  1. 在创建告警监控规则时添加。例如添加标签env和team。

    说明
    • 建议标签的名称为英文字符。

    • 标签为静态文本,支持自定义。触发的告警会自动添加该标签作为告警属性。

    biaoqian

  2. 在分组评估中指定的字段可自动成为标签。

    image

使用场景

  1. 告警去重

    标签属于触发告警的标识性属性,是告警指纹中的一部分,可用于告警去重。比如系统产生两条告警Alert1和Alert2,因为标签信息(labels)相同,只保留其中一条告警数据。告警指纹原理,请参见基于告警指纹去重

    // Alert1
    {
      "aliuid": "12345",
      "project": "Project1",
      "alert_id": "alert-123",
      "labels": {
        "host": "host-1"
      },
      "annotations": {
        "title": "CPU使用率过高",
        "desc": "CPU当前使用率为90%"
      }
    }
    
    // Alert2
    {
      "aliuid": "12345",
      "project": "Project1",
      "alert_id": "alert-123",
      "labels": {
        "host": "host-1"
      },
      "annotations": {
        "title": "CPU使用率过高",
        "desc": "CPU当前使用率为95%"
      }
    }
  2. 内容模板中引用标签

    标签属于map类型,当您在告警规则中添加了标签,您可在告警内容模板中通过${labels}引用标签信息。

    image

  3. 降噪控制

    在告警策略中,标签信息可作为降噪控制的合并基准。比如您在合并基准时使用按告警规则+所有标签进行合并配置,如下图。更多信息,请参见合并基准

    image

  4. 通知分派

    告警管理系统和通知管理系统根据标签属性进行告警管理和通知分派。比如您在配置行动策略时,根据标签配置不同的行动组,如下图。

    image

标注

标注主要应用于内容模板、管理分派等场景。

添加标注

在创建告警监控规则时添加。例如添加如下标注。

说明
  • 建议标注的名称为英文字符。

  • 固定有titledesc两个属性。

    • title是告警固定的非标识性属性,可以在通知内容模板中以${annotations.title}被引用。

    • desc是告警固定的非标识性属性,可以在通知内容模板中以${annotations.desc}被引用。

  • 触发告警的非标识性属性,键值对格式,值可以是动态的。例如标注信息为"annotations": {"title": "${service} CPU使用率过高","desc": "${service} CPU当前使用率为90%"}

image

您在配置标注内容时可以使用内置变量,也可引用分组评估中的字段变量。引用分组评估中的字段变量时,实际值为触发告警时对应的属性值。使用的内置变量如下表。

变量

说明

__count__

分组后每组的行数(不分组时,默认所有结果在一个组)

__pass_count__

分组后每组满足条件的行数(不分组默认所有数据在一个组)

__0_count__

第一个查询结果的行数

__1_count__

第二个查询结果的行数

__2_count__

第三个查询结果的行数

aliuid

阿里云账号ID

alert_instance_id

告警触发的实例的ID

alert_id

告警规则ID

alert_name

告警规则名称

project

告警规则所在Project

使用场景

告警管理系统和通知管理系统根据标注属性进行告警管理和通知分派。例如您可在告警策略中根据标注属性作为条件配置不同的分组合并。在行动策略中根据标注属性作为条件配置不同的行动组

image

自动标注

自动标注是对告警标注的补充。您在配置告警监控规则时,打开自动添加标注开关后,系统自动添加字段到标注中。

说明
  • 当字段中存在多个值时,默认选择第一个值添加到标注中。

  • 内置字段__count__表示集合操作结果的行数。

  • 分组

    您在配置告警监控规则时,配置分组评估标签自定义标签自动,且打开自动添加标注开关,则系统自动将集合操作结果中的非分组字段和内置字段(__count__)添加到标注中。

    例如集合操作结果中包括hostpv,并且根据host字段进行分组,则开启标签自动添加功能后,pv字段和__count__字段将被添加到标注中。

    image

  • 未分组

    您在配置告警监控规则时,配置分组评估不分组,且打开自动添加标注开关,则系统自动将集合操作结果中的所有字段和内置字段(__count__)添加到标注中。

    例如集合操作结果中包括hostpv,则开启标签自动添加功能后,host字段、pv字段和__count__字段将被添加到标注中。

    image