本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
标签和注释
本文档主题专为支持 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 中有许多建议的注释summary
,description
例如、、runbook_url
和。dashboardUId
panelId
与自定义标签一样,注释必须有名称,其值可以包含文本和模板代码的组合,这些代码将在触发警报时进行评估。如果注解包含模板代码,则在触发警报时会对该模板进行一次评估。即使警报已解决,也不会对其进行重新评估。有关如何模板化注释的文档可以在这里找到。