标签和注释
本文档主题专为支持 Grafana 9.x 版本的 Grafana 工作区而设计。
对于支持 Grafana 10.x 版本的 Grafana 工作区,请参阅 使用 Grafana 版本 10。
对于支持 Grafana 8.x 版本的 Grafana 工作区,请参阅 使用 Grafana 版本 8。
标签和注释包含警报的相关信息。标签和注释具有相同的结构:一组命名值;但其预期用途不同。标签或等效注释的示例为 alertname="test"
。
标签和注释之间的主要区别在于,标签用于将警报与所有其他警报区分开来,而注释则用于向现有警报添加其他信息。
例如,假设两个 CPU 过高警报:一个是针对 server1
,一个是针对 server2
。在这样的示例中,我们可能有一个名为 server
的标签,其中第一个警报带有标签 server="server1"
,第二个警报带有标签 server="server2"
。但我们可能还想为每个警报添加描述,例如 "The CPU usage for server1 is above 75%."
,其中 server1
和 75%
替换为服务器的名称和 CPU 使用率(有关如何执行此操作,请参阅 模板化标签和注释 上的文档)。这种描述更适合作为注释。
标签
标签包含用于识别警报的信息。标签的示例为 server=server1
。每个警报可以有多个标签,警报的完整标签集称为其标签集。正是这个标签集可以识别警报。
例如,一个警报具有标签集 {alertname="High CPU usage",server="server1"}
,而另一个警报具有标签集 {alertname="High CPU usage",server="server2"}
。这是两个独立的警报,因为尽管它们的 alertname
标签相同,但 server
标签却不同。
警报的标签集是数据来源中的标签、警报规则中的自定义标签和许多保留标签(比如 alertname
)的组合。
自定义标签
自定义标签是警报规则中的附加标签。与注释一样,自定义标签必须有一个名称,其值可包含文本和模板代码的组合,在警报触发时进行评估。有关如何模板化自定义标签的文档,请在此处查找。
在模板中使用自定义标签时,请务必确保标签值在警报规则的连续评估之间不会发生变化,因为这最终会创建大量不同的警报。但是,模板可以为不同的警报生成不同的标签值。例如,不要将查询的值放在自定义标签中,因为这最终会在每次值更改时创建一组新的警报。改为使用注释。
此外,请务必确保警报的标签集没有两个或多个同名标签。如果自定义标签与数据来源中的标签同名,则会替换该标签。但如果自定义标签与保留标签同名,则该自定义标签将从警报中省略。
注释
注释是为现有警报添加其他信息的命名对。Grafana 中有许多建议的注释,例如 description
、summary
、runbook_url
、dashboardUId
和 panelId
。与自定义标签一样,注释必须有一个名称,其值可包含文本和模板代码的组合,在警报触发时进行评估。如果注释包含模板代码,则在触发警报时会对模板进行一次评估。即使警报已解决,也不会重新评估。有关如何模板化注释的文档,请在此处查找。