本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # 管理警报 **** 本文档主题专为支持 **Grafana 10.x 版本**的 Grafana 工作区而设计。 对于支持 Grafana 9.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 9](using-grafana-v9.md)。 对于支持 Grafana 8.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 8](using-grafana-v8.md)。 设置警报规则、联系点和通知策略后，您就可以在实践中使用 Grafana Alerting 来管理警报。 **Topics** + [自定义通知](v10-alerting-manage-notifications.md) + [管理联系点](v10-alerting-manage-contactpoints.md) + [静默警报通知](v10-alerting-silences.md) + [查看和筛选警报规则](v10-alerting-manage-rules-viewfilter.md) + [静音定时](v10-alerting-manage-muting.md) + [查看警报规则的状态和运行状况](v10-alerting-manage-rulestate.md) + [按警报组查看和筛选](v10-alerting-manage-viewfiltergroups.md) + [查看通知错误](v10-alerting-manage-viewnotificationerrors.md) # 自定义通知 **** 本文档主题专为支持 **Grafana 10.x 版本**的 Grafana 工作区而设计。 对于支持 Grafana 9.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 9](using-grafana-v9.md)。 对于支持 Grafana 8.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 8](using-grafana-v8.md)。 使用通知模板自定义通知。 您可以使用通知模板来更改通知中消息的标题、内容和格式。 通知模板不与 Amazon SNS 或 Slack 等特定联系点集成绑定。但您可以选择为不同的联系点集成创建单独的通知模板。 您可以使用通知模板： + 在通知中添加、移除或重新排序信息，包括摘要、描述、标签和注释、值和链接 + 为文本设置粗体和斜体格式，添加或移除换行符 您不能使用通知模板： + 更改 Slack 和 Microsoft Teams 等即时消息服务中的通知设计 **Topics** + [使用 Go 的模板语言](v10-alerting-notifications-go-templating.md) + [创建通知模板](v10-alerting-create-templates.md) + [使用通知模板](#v10-alerting-use-notification-templates) + [模板参考](v10-alerting-template-reference.md) # 使用 Go 的模板语言 **** 本文档主题专为支持 **Grafana 10.x 版本**的 Grafana 工作区而设计。 对于支持 Grafana 9.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 9](using-grafana-v9.md)。 对于支持 Grafana 8.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 8](using-grafana-v8.md)。 您可以使用 Go 的模板语言 [text/template](https://pkg.go.dev/text/template) 编写通知模板。 本节概述了 Go 的模板语言以及如何用 text/template 编写模板。 ## dot 里面 text/template 有一个叫做 dot 的特殊光标，写成`.`了。您可以将此光标看作一个变量，其值会根据在模板中使用的位置而变化。例如，在通知模板 `.` 的开头引用 `ExtendedData` 对象，该对象包含多个字段，例如包括 `Alerts`、`Status`、`GroupLabels`、`CommonLabels`、`CommonAnnotations` 和 `ExternalURL`。但是，当在列表上的 `range` 中使用、在 `with` 中使用或编写要在其他模板中使用的功能模板时，dot 可能引用其他内容。您可以在 [创建通知模板](v10-alerting-create-templates.md) 中看到相关示例，在 [模板参考](v10-alerting-template-reference.md) 中看到所有数据和函数。 ## 开始和结束标签 在 text/template 中，模板以 `{{` 开头，以 `}}` 结尾，无论模板是打印变量还是运行 if 语句等控制结构。这与 Jinja 等其他模板语言不同，在 Jinja 中，打印变量使用 `{{` 和 `}}`，控制结构使用 `{%` 和 `%}`。 ## Print（打印） 要打印某项的值，请使用 `{{` 和 `}}`。您可以打印 dot 的值、dot 的字段、函数的结果和[变量](#v10-go-variables)的值。例如，要打印 `Alerts` 字段，其中 dot 引用 `ExtendedData`，您可以编写以下内容： ``` {{ .Alerts }} ``` ## 迭代警报 要仅打印每个警报的标签，而不是有关警报的所有信息，可使用 `range` 在 `ExtendedData` 中迭代警报： ``` {{ range .Alerts }} {{ .Labels }} {{ end }} ``` 范围内的 dot 不再引用 `ExtendedData`，而是引用 `Alert`。您可以使用 `{{ .Labels }}` 打印每个警报的标签。之所以有效，是因为 `{{ range .Alerts }}` 会更改 dot，以引用警报列表中的当前警报。范围完成后，dot 将重置为范围开始之前的值，在本例中为 `ExtendedData`： ``` {{ range .Alerts }} {{ .Labels }} {{ end }} {{/* does not work, .Labels does not exist here */}} {{ .Labels }} {{/* works, cursor was reset */}} {{ .Status }} ``` ## 迭代注释和标签 我们编写一个模板，以 `The name of the label is $name, and the value is $value` 格式打印每个警报的标签，其中 `$name` 和 `$value` 包含每个标签的名称和值。 与前面的示例一样，使用一个范围迭代 `.Alerts` 中的警报，使 dot 引用警报列表中的当前警报，然后在排序标签上使用第二个范围，使 dot 第二次更新以引用当前标签。在第二个范围内，使用 `.Name` 和 `.Value` 打印每个标签的名称和值： ``` {{ range .Alerts }} {{ range .Labels.SortedPairs }} The name of the label is {{ .Name }}, and the value is {{ .Value }} {{ end }} {{ range .Annotations.SortedPairs }} The name of the annotation is {{ .Name }}, and the value is {{ .Value }} {{ end }} {{ end }} ``` ## 索引函数 要打印特定的注释或标签，请使用 `index` 函数。 ``` {{ range .Alerts }} The name of the alert is {{ index .Labels "alertname" }} {{ end }} ``` ## If 语句 可在模板中使用 if 语句。例如，要在 `.Alerts` 中没有警报的情况下打印 `There are no alerts`，您可以编写以下内容： ``` {{ if .Alerts }} There are alerts {{ else }} There are no alerts {{ end }} ``` ## With With 与 if 语句类似，但又有所不同，`with` 会更新 dot 以引用 with 的值： ``` {{ with .Alerts }} There are {{ len . }} alert(s) {{ else }} There are no alerts {{ end }} ``` ## 变量 中的变量 text/template 必须在模板中创建。例如，要使用 dot 的当前值创建一个名为 `$variable` 的变量，您可以编写以下内容： ``` {{ $variable := . }} ``` 您可以在范围或 `with` 内使用 `$variable`，以引用定义变量时的 dot 值，而不是当前 dot 的值。 例如，您不能编写在第二个范围中使用 `{{ .Labels }}` 的模板，因为这里的 dot 引用的是当前标签，而不是当前警报： ``` {{ range .Alerts }} {{ range .Labels.SortedPairs }} {{ .Name }} = {{ .Value }} {{/* does not work because in the second range . is a label not an alert */}} There are {{ len .Labels }} {{ end }} {{ end }} ``` 您可以在第一个范围内和第二个范围之前定义一个名为 `$alert` 的变量来解决此问题： ``` {{ range .Alerts }} {{ $alert := . }} {{ range .Labels.SortedPairs }} {{ .Name }} = {{ .Value }} {{/* works because $alert refers to the value of dot inside the first range */}} There are {{ len $alert.Labels }} {{ end }} {{ end }} ``` ## 带索引的范围 您可以在范围的开头定义 index 和 value 变量来获取范围内每个警报的索引： ``` {{ $num_alerts := len .Alerts }} {{ range $index, $alert := .Alerts }} This is alert {{ $index }} out of {{ $num_alerts }} {{ end }} ``` ## 定义模板 您可以使用 `define` 和双引号中的模板名称来定义可在其他模板中使用的模板。定义的模板不能与其他模板同名，包括 `__subject`、`__text_values_list`、`__text_alert_list`、`default.title` 和 `default.message` 等默认模板。如果创建的模板与默认模板或其他通知模板中的模板同名，Grafana 可能会使用其中任何一个模板。当存在两个或多个同名模板时，Grafana 不会阻止或显示错误消息。 ``` {{ define "print_labels" }} {{ end }} ``` ## 执行模板 您可以使用 `template`、双引号中的模板名称以及应传递给模板的光标在模板中执行定义的模板： ``` {{ template "print_labels" . }} ``` ## 将数据传递给模板 在模板中，dot 将引用传递给模板的值。 例如，如果向模板传递了触发警报列表，则 dot 引用该触发警报列表： ``` {{ template "print_alerts" .Alerts }} ``` 如果模板传递了警报的排序标签，则 dot 引用已排序标签的列表： ``` {{ template "print_labels" .SortedLabels }} ``` 这在编写可重用模板时很有用。例如，要打印所有警报，您可以编写以下内容： ``` {{ template "print_alerts" .Alerts }} ``` 然后，如果仅打印触发警报，您可以这样编写： ``` {{ template "print_alerts" .Alerts.Firing }} ``` 这是可以的，因为 `.Alerts` 和 `.Alerts.Firing` 都是警报列表。 ``` {{ define "print_alerts" }} {{ range . }} {{ template "print_labels" .SortedLabels }} {{ end }} {{ end }} ``` ## 评论 您可以使用 `{{/*` 和 `*/}}` 添加注释： ``` {{/* This is a comment */}} ``` 要防止注释添加换行符，请使用： ``` {{- /* This is a comment with no leading or trailing line breaks */ -}} ``` ## 缩进 您可以使用缩进、制表符和空格以及换行符，来提高模板的可读性： ``` {{ range .Alerts }} {{ range .Labels.SortedPairs }} {{ .Name }} = {{ .Value }} {{ end }} {{ end }} ``` 但模板中的缩进也将出现在文本中。接下来，我们看如何将其移除。 ## 移除空格和换行符 正在 text/template 使用`{{-``-}}`并删除前导和尾随空格以及换行符。 例如，使用缩进和换行符来提高模板的可读性： ``` {{ range .Alerts }} {{ range .Labels.SortedPairs }} {{ .Name }} = {{ .Value }} {{ end }} {{ end }} ``` 缩进和换行符也将出现在文本中： ``` alertname = "Test" grafana_folder = "Test alerts" ``` 您可以移除文本中的缩进和换行符，将每个范围开始处的 `}}` 更改为 `-}}`： ``` {{ range .Alerts -}} {{ range .Labels.SortedPairs -}} {{ .Name }} = {{ .Value }} {{ end }} {{ end }} ``` 模板中的缩进和换行符现已从文本中消失： ``` alertname = "Test" grafana_folder = "Test alerts" ``` # 创建通知模板 **** 本文档主题专为支持 **Grafana 10.x 版本**的 Grafana 工作区而设计。 对于支持 Grafana 9.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 9](using-grafana-v9.md)。 对于支持 Grafana 8.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 8](using-grafana-v8.md)。 创建可重用的通知模板发送给联系点。 您可以向通知模板添加一个或多个模板。 通知模板名称必须唯一。同一通知模板或不同通知模板中不能有两个同名的模板。避免定义与默认模板同名的模板，例如：`__subject`、`__text_values_list`、`__text_alert_list`、`default.title` 和 `default.message`。 在“联系点”选项卡中，您可以看到通知模板的列表。 ## 创建通知模板 **创建通知模板** 1. 选择**警报**、**联系点**。 1. 选择**通知模板**选项卡，然后选择 **\$1 添加通知模板**。 1. 选择通知模板的名称，例如 `email.subject`。 1. 在内容字段中写入模板的内容。 例如： ``` {{ if .Alerts.Firing -}} {{ len .Alerts.Firing }} firing alerts {{ end }} {{ if .Alerts.Resolved -}} {{ len .Alerts.Resolved }} resolved alerts {{ end }} ``` 1. 保存更改。 `{{ define "email.subject" }}`（其中 `email.subject` 是模板名称），`{{ end }}` 自动添加到内容的开头和结尾。 **创建包含多个模板的通知模板** 1. 选择**警报**、**联系点**。 1. 选择**通知模板**选项卡，然后选择 **\$1 添加通知模板**。 1. 输入整个通知模板的名称。例如 `email`。 1. 在内容字段中写入每个模板，包括每个模板开头和结尾的 `{{ define "name-of-template" }}` 和 `{{ end }}`。您可以为通知模板中的每个模板使用描述性名称，例如，`email.subject` 或 `email.message`。在这种情况下，不要重复使用您在上面输入的通知模板的名称。 后面的部分展示了您可能创建的模板的详细示例。 1. 点击保存。 ## 预览通知模板 在联系点中使用通知模板之前，先预览通知模板的外观，这有助于您了解创建的模板效果，并允许在保存模板之前修复任何错误。 **注意** 通知预览仅适用于 Grafana Alertmanager。 **预览通知模板** 1. 选择**警报**、**联系点**。 1. 选择**通知模板**选项卡，然后选择 **\$1 添加通知模板**，或添加现有模板。 1. 添加或更新模板内容。 提供了默认数据，您可以向其中添加或编辑警报数据以及警报实例。您可以直接在有效载荷数据窗口中添加警报数据，或者单击**选择警报实例**或**添加自定义警报**。 1. [可选] 要从现有警报实例中添加警报数据，请执行以下操作： 1. 选择**选择警报实例**。 1. 将鼠标悬停在警报实例上，可查看有关每个警报实例的更多信息。 1. 选择**确认**将警报实例添加到有效载荷。 1. [可选] 要使用警报数据编辑器添加警报数据，请选择**添加自定义数据**： 1. 添加注释、自定义标签或设置控制面板或面板。 1. 切换“触发”或“已解决”，具体取决于您要在通知中添加触发警报还是已解决警报。 1. 选择**添加警报数据**。 1. 选择**刷新预览**，查看模板内容的外观以及相应的有效载荷数据。 如果模板中存在任何错误，这些错误会显示在预览中，您可以在保存之前进行更正。 1. 保存更改。 ## 为消息主题创建模板 为电子邮件主题创建模板，其中包含触发和已解决的警报数量，如以下示例所示： ``` 1 firing alerts, 0 resolved alerts ``` **为电子邮件主题创建模板** 1. 使用以下内容创建一个名为 `email.subject` 的模板： ``` {{ define "email.subject" }} {{ len .Alerts.Firing }} firing alerts, {{ len .Alerts.Resolved }} resolved alerts {{ end }} ``` 1. 创建联系点集成时，请使用模板将其放入带有 `template` 关键字的**主题**字段中。 ``` {{ template "email.subject" . }} ``` ## 为电子邮件消息创建模板 为电子邮件消息创建模板，其中包含所有触发和已解决的警报数量，如以下示例所示： ``` There are 2 firing alerts, and 1 resolved alerts Firing alerts: - alertname=Test 1 grafana_folder=GrafanaCloud has value(s) B=1 - alertname=Test 2 grafana_folder=GrafanaCloud has value(s) B=2 Resolved alerts: - alertname=Test 3 grafana_folder=GrafanaCloud has value(s) B=0 ``` **为电子邮件消息创建模板** 1. 创建一个名为 `email` 的通知模板，内容中包含两个模板：`email.message_alert` 和 `email.message`。 `email.message_alert` 模板用于打印每个触发和已解决警报的标签和值，而 `email.message` 模板包含电子邮件的结构。 ``` {{- define "email.message_alert" -}} {{- range .Labels.SortedPairs }}{{ .Name }}={{ .Value }} {{ end }} has value(s) {{- range $k, $v := .Values }} {{ $k }}={{ $v }}{{ end }} {{- end -}} {{ define "email.message" }} There are {{ len .Alerts.Firing }} firing alerts, and {{ len .Alerts.Resolved }} resolved alerts {{ if .Alerts.Firing -}} Firing alerts: {{- range .Alerts.Firing }} - {{ template "email.message_alert" . }} {{- end }} {{- end }} {{ if .Alerts.Resolved -}} Resolved alerts: {{- range .Alerts.Resolved }} - {{ template "email.message_alert" . }} {{- end }} {{- end }} {{ end }} ``` 1. 创建联系点集成时，请使用模板将其放入带有 `template` 关键字的**正文**字段中。 ``` {{ template "email.message" . }} ``` ## 为 Slack 消息标题创建模板 为 Slack 消息标题创建模板，其中包含触发和已解决的警报数量，如以下示例所示： ``` 1 firing alerts, 0 resolved alerts ``` **为 Slack 消息标题创建模板** 1. 使用以下内容创建一个名为 `slack.title` 的模板： ``` {{ define "slack.title" }} {{ len .Alerts.Firing }} firing alerts, {{ len .Alerts.Resolved }} resolved alerts {{ end }} ``` 1. 从联系点集成中的标题字段执行模板。 ``` {{ template "slack.title" . }} ``` ## 为 Slack 消息内容创建模板 为 Slack 消息内容创建模板，其中包含所有触发和已解决警报的描述，包括其标签、注释和控制面板 URL。 **注意** 此模板仅适用于 Grafana 管理的警报。要将模板用于数据来源管理的警报，请删除对 DashboardURL 和 SilenceURL 的引用。有关配置 Prometheus 通知的更多信息，请参阅 [Prometheus 通知文档](https://prometheus.io/docs/alerting/latest/notifications/)。 ``` 1 firing alerts: [firing] Test1 Labels: - alertname: Test1 - grafana_folder: GrafanaCloud Annotations: - description: This is a test alert Go to dashboard: https://example.com/d/dlhdLqF4z?orgId=1 1 resolved alerts: [firing] Test2 Labels: - alertname: Test2 - grafana_folder: GrafanaCloud Annotations: - description: This is another test alert Go to dashboard: https://example.com/d/dlhdLqF4z?orgId=1 ``` **为 Slack 消息内容创建模板** 1. 创建一个名为 `slack` 的模板，内容中包含两个模板：`slack.print_alert` 和 `slack.message`。 `slack.print_alert` 模板用于打印标签、注释和 DashboardURL，而 `slack.message` 模板包含通知的结构。 ``` {{ define "slack.print_alert" -}} [{{.Status}}] {{ .Labels.alertname }} Labels: {{ range .Labels.SortedPairs -}} - {{ .Name }}: {{ .Value }} {{ end -}} {{ if .Annotations -}} Annotations: {{ range .Annotations.SortedPairs -}} - {{ .Name }}: {{ .Value }} {{ end -}} {{ end -}} {{ if .DashboardURL -}} Go to dashboard: {{ .DashboardURL }} {{- end }} {{- end }} {{ define "slack.message" -}} {{ if .Alerts.Firing -}} {{ len .Alerts.Firing }} firing alerts: {{ range .Alerts.Firing }} {{ template "slack.print_alert" . }} {{ end -}} {{ end }} {{ if .Alerts.Resolved -}} {{ len .Alerts.Resolved }} resolved alerts: {{ range .Alerts.Resolved }} {{ template "slack.print_alert" .}} {{ end -}} {{ end }} {{- end }} ``` 1. 从联系点集成中的文本正文字段执行模板： ``` {{ template "slack.message" . }} ``` ## 使用共享模板对电子邮件和 Slack 进行模板化 您可以共享同一个模板，而不是为每个联系点创建单独的通知模板，例如电子邮件和 Slack。 例如，如果要发送包含此主题的电子邮件和包含标题 `1 firing alerts, 0 resolved alerts` 的 Slack 消息，则可以创建共享模板。 **创建共享模板** 1. 使用以下内容创建一个名为 `common.subject_title` 的模板： ``` {{ define "common.subject_title" }} {{ len .Alerts.Firing }} firing alerts, {{ len .Alerts.Resolved }} resolved alerts {{ end }} ``` 1. 对于电子邮件，请从电子邮件联系点集成中的主题字段运行模板： ``` {{ template "common.subject_title" . }} ``` 1. 对于 Slack，请从 Slack 联系点集成中的标题字段运行模板： ``` {{ template "common.subject_title" . }} ``` ## 使用通知模板 使用联系点中的模板来自定义通知。 **在创建联系点时使用模板** 1. 从**警报**菜单中，选择**联系点**选项卡，以查看现有联系点列表。 1. 选择 **New (新建)**。或者，您可以选择**编辑**图标来编辑现有联系点。 1. 在**消息**或**主题**等字段中输入要使用的模板。要输入模板，请使用表单`{{ template "template_name" . }}`，*template\$1name*替换为要使用的模板的名称。 1. 选择**保存联系点**。 # 模板参考 **** 本文档主题专为支持 **Grafana 10.x 版本**的 Grafana 工作区而设计。 对于支持 Grafana 9.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 9](using-grafana-v9.md)。 对于支持 Grafana 8.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 8](using-grafana-v8.md)。 本节提供了创建模板的参考信息。 **警报（类型）** 警报类型包含以下数据。 | Name | 类型 | 说明 | 示例 | | --- | --- | --- | --- | | Status | 字符串 | `firing` 或 `resolved`。 | \$1\$1 .Status \$1\$1 | | 标签 | KeyValue | 附加到警报的一组标签。 | \$1\$1 .Labels \$1\$1 | | Annotations | KeyValue | 附加到警报的一组注释。 | \$1\$1 .Annotations \$1\$1 | | 值 | KeyValue | 所有表达式的值，包括经典条件 | \$1\$1 .Values \$1\$1 | | StartsAt | time.Time | 警报开始触发的时间。 | \$1\$1 .StartsAt \$1\$1 | | EndsAt | time.Time | 仅在知道警报结束时间时设置。否则，设置为从收到最后一次警报的时间起算的可配置的超时周期。 | \$1\$1 .EndsAt \$1\$1 | | GeneratorURL | 字符串 | 指向 Grafana 或外部 Alertmanager 的返回链接。 | \$1\$1 .GeneratorURL \$1\$1 | | SilenceURL | 字符串 | 指向静默警报的链接（其中预填了此警报的标签）。仅适用于 Grafana 管理的警报。 | \$1\$1 .SilenceURL\$1\$1 | | DashboardURL | 字符串 | 指向 Grafana 控制面板的链接（适用于警报规则属于 Grafana 控制面板的情况）。仅适用于 Grafana 管理的警报。 | \$1\$1 .DashboardURL \$1\$1 | | PanelURL | 字符串 | 指向 Grafana 控制面板中面板的链接（适用于警报规则属于 Grafana 控制面板中面板的情况）。仅适用于 Grafana 管理的警报。 | \$1\$1 .PanelURL \$1\$1 | | 指纹 | 字符串 | 可用于识别警报的指纹。 | \$1\$1 .Fingerprint \$1\$1 | | ValueString | 字符串 | 该字符串包含警报中每个简化表达式的标签和值。 | \$1\$1 .ValueString \$1\$1 | **ExtendedData** 该 ExtendedData 对象包含以下属性。 | Name | 类型 | 说明 | 示例 | | --- | --- | --- | --- | | 接收方 | `string` | 发送通知的联系点名称。 | `{{ .Receiver }}` | | Status | `string` | 如果至少触发一个警报，则状态为 `firing`，否则为 `resolved`。 | `{{ .Status }}` | | 警报 | `[]Alert` | 此通知中所有触发警报和已解决警报的列表。 | `There are {{ len .Alerts }} alerts` | | 触发警报 | `[]Alert` | 此通知中所有触发警报的列表。 | `There are {{ len .Alerts.Firing }} firing alerts` | | 已解决警报 | `[]Alert` | 此通知中所有已解决警报的列表。 | `There are {{ len .Alerts.Resolved }} resolved alerts` | | GroupLabels | `KeyValue` | 此通知中对这些警报进行分组的标签。 | `{{ .GroupLabels }}` | | CommonLabels | `KeyValue` | 此通知中所有警报的通用标签。 | `{{ .CommonLabels }}` | | CommonAnnotations | `KeyValue` | 此通知中所有警报的通用注释。 | `{{ .CommonAnnotations }}` | | ExternalURL | `string` | 指向发送此通知的 Grafana 工作区或 Alertmanager 的链接。 | `{{ .ExternalURL }}` | **KeyValue type** `KeyValue`类型是一组表示标签和注释的 key/value 字符串对。 除了直接访问存储为 `KeyValue` 的数据外，还有方法可以对这些数据进行排序、删除和转换。 | Name | 参数 | 返回值 | 注意 | 示例 | | --- | --- | --- | --- | --- | | SortedPairs | | 键值字符串对的排序列表 | | `{{ .Annotations.SortedPairs }}` | | 删除 | []string | KeyValue | 返回不带给定键 Key/Value 的地图副本。 | `{{ .Annotations.Remove "summary" }}` | | 名称 | | []string | 名称列表 | `{{ .Names }}` | | 值 | | []string | 值的列表。 | `{{ .Values }}` | **时间** 时间来自 Go [https://pkg.go.dev/time#Time](https://pkg.go.dev/time#Time) 包。您可以用多种不同的格式打印时间。例如，要以 `Monday, 1st January 2022 at 10:00AM` 格式打印警报触发的时间，请编写以下模板： ``` {{ .StartsAt.Format "Monday, 2 January 2006 at 3:04PM" }} ``` 您可以在[此处](https://pkg.go.dev/time#pkg-constants)找到 Go 的时间格式参考。 # 管理联系点 **** 本文档主题专为支持 **Grafana 10.x 版本**的 Grafana 工作区而设计。 对于支持 Grafana 9.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 9](using-grafana-v9.md)。 对于支持 Grafana 8.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 8](using-grafana-v8.md)。 **联系点**列表视图列出了所有现有联系点和通知模板。 在**联系点**选项卡上，您可以： + 搜索联系点和集成的名称和类型。 + 查看所有现有联系点和集成。 + 查看每个联系点用于多少个通知策略，并直接导航到链接的通知策略。 + 查看通知的发送状态。 + 以 JSON、YAML 或 Terraform 格式导出单个联系点或所有联系点。 + 删除通知策略不使用的联系点。 在**通知模板**选项卡上，您可以： + 查看、编辑、复制或删除现有通知模板。 # 静默警报通知 **** 本文档主题专为支持 **Grafana 10.x 版本**的 Grafana 工作区而设计。 对于支持 Grafana 9.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 9](using-grafana-v9.md)。 对于支持 Grafana 8.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 8](using-grafana-v8.md)。 您可以通过*静默*来抑制警报通知。静默只会阻止创建通知：静默不会阻止评估警报规则，也不会阻止警报实例显示在用户界面中。当警报静默时，您可以指定抑制警报的时间范围。 **注意** 要按固定的时间间隔（例如，在定期维护期间）抑制警报通知，请使用 [静音定时](v10-alerting-manage-muting.md) 而不是静默。 **添加静默** 1. 在 Grafana 控制台的 Grafana 菜单中，选择**警报**。 1. 选择**静默**。 1. 从 **Alertmanager** 下拉列表中选择 Alertmanager。 1. 选择**创建静默**。 1. 在**静默开始和结束**中选择开始和结束日期，以指示静默应何时生效和结束。 1. 除了设置结束时间之外，还可以在**持续时间**中指定强制静默的时长。这会自动更新**静默开始和结束**字段中的结束时间。 1. 在**标签**和**值**字段中，输入一个或多个*匹配标签*。匹配程序决定静默适用于哪些规则。任何匹配的警报（处于触发状态）都将显示在**受影响的警报实例**字段中。 1. （可选）添加**注释**以描述静默。 1. 选择**提交**。 **编辑静默** 1. 在 Grafana 控制台的 Grafana 菜单中，选择**警报**。 1. 选择**静默**以查看现有静默列表。 1. 找到要编辑的静默，然后选择**编辑**（钢笔图标）。 1. 进行所需的更改，然后选择**提交**以保存更改。 您可以选择**编辑**图标（钢笔）来编辑现有静默。 **创建指向静默表单的 URL 链接** 链接到静默表单时，通过 `matcher` 和 `comment` 查询参数提供默认匹配标签和注释。`matcher` 参数应采用以下格式 `[label][operator][value]`，其中 `operator` 参数可以是以下格式之一：`=` （等于，非正则表达式）、`!=`（不等于，非正则表达式）、`=~`（等于，正则表达式）、`!~`（不等于，正则表达式）。URL 可以包含许多带有 `matcher` 键的查询参数。例如，要链接到带有匹配标签 `severity=critical` & `cluster!~europe-.*` 和注释 `Silence critical EU alerts` 的静默表单，请创建一个 URL `https://mygrafana/alerting/silence/new?matcher=severity%3Dcritical&matcher=cluster!~europe-*&comment=Silence%20critical%20EU%20alert`。 要链接到外部 Alertmanager 的新静默页面，请添加 `alertmanager` 查询参数 **移除静默** 1. 在 Grafana 控制台的 Grafana 菜单中，选择**警报**。 1. 选择**静默**以查看现有静默列表。 1. 选择要结束的静默，然后选择**取消静默**。这将结束警报抑制。 **注意** 取消静默会结束警报抑制，就像为当前时间设置的结束时间一样。已结束（自动或手动）的静默会保留并列出五天。您无法从列表中手动删除静默。 # 查看和筛选警报规则 **** 本文档主题专为支持 **Grafana 10.x 版本**的 Grafana 工作区而设计。 对于支持 Grafana 9.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 9](using-grafana-v9.md)。 对于支持 Grafana 8.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 8](using-grafana-v8.md)。 **警报**页面列出了警报规则。默认情况下，规则按数据来源类型分组。**Grafana** 部分列出了 Grafana 管理的规则。此处还列出了 Prometheus 兼容的数据来源的警报规则。您可以查看兼容 Prometheus 的数据来源的警报规则，但无法编辑。 Mimir/Cortex/Loki规则部分列出了 Mimir、Cortex 或 Loki 数据源的所有规则。本节还列出了云警报规则。 管理大量警报时，可使用扩展的警报规则搜索功能筛选文件夹、评估组和规则。此外，您还可以按标签、状态、类型和运行状况等属性筛选警报规则。 ## 查看警报规则 使用 Grafana 警报，您可以在一个页面中查看所有警报。 **查看警报详细信息** 1. 在 Grafana 控制台的 Grafana 菜单中，选择**警报**和**警报规则**。默认情况下，显示列表视图。 1. 在**查看方式**中，您可以选择自己喜欢的选项，在分组、列表和状态视图之间切换。 1. 展开规则行可查看规则标签、注释、数据来源、规则查询以及规则生成的警报实例列表。 在此页面中，您还可以创建警报规则副本，以便重用现有规则。 ## 导出警报规则 您可以在 Grafana 工作区中将规则导出为 YAML 或 JSON。 + 选择每个警报规则组旁边的**导出规则组**图标，以导出为 YAML、JSON 或 Terraform。 + 选择**导出规则**将所有 Grafana 管理的警报规则导出为 YAML、JSON 或 Terraform。 + 选择组中每个警报规则旁边的**更多**和**修改导出**，编辑预置的警报规则并导出修改后的版本。 ## 查看预置警报的查询定义 查看预置警报的只读查询定义。快速检查您的警报规则查询是否正确，无需深入 "as-code" 存储库中查找规则定义。 **分组视图** 分组视图显示按文件夹分组的 Grafana 警报规则以及按 `namespace` \$1 `group` 分组的 Loki 或 Prometheus 警报规则。这是默认的规则列表视图，用于管理规则。您可以展开每个组，查看该组中的规则列表。进一步展开规则，查看详细信息。您还可以展开操作按钮和规则产生的警报，查看其详细信息。 **状态视图** 状态视图显示按状态分组的警报规则。使用此视图可以大致了解哪些规则处于何种状态。可以展开每条规则查看其详细信息。其中包括操作按钮和由此规则生成的任何警报，而每个警报都可以进一步展开以查看其详细信息。 ## 筛选警报规则 您可以通过多种方式筛选**警报**页面上显示的警报规则。 **筛选警报规则** 1. 从**选择数据来源**中，选择一个数据来源。您可以看到查询选定数据来源的警报规则。 1. 在**按标签搜索**中，使用标签选择器输入搜索条件。例如 `environment=production;region=~US|EU,severity!=warning`。 1. 从**按状态筛选警报**中，选择要查看的警报状态。您可以看到与该状态匹配的警报规则。与其他状态匹配的规则将会隐藏。 # 静音定时 **** 本文档主题专为支持 **Grafana 10.x 版本**的 Grafana 工作区而设计。 对于支持 Grafana 9.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 9](using-grafana-v9.md)。 对于支持 Grafana 8.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 8](using-grafana-v8.md)。 静音定时是一个重复的时间间隔，在此期间，不会针对某个策略生成或发送新的通知。使用静音定时可防止警报在特定的重复时间段（如定期维护时间段）内触发。 与静默类似，静音定时不会阻止对警报规则进行评估，也不会阻止警报实例显示在用户界面中。只会阻止创建通知。 您可以配置 Grafana 管理的静音定时，以及外部 Alertmanager 数据来源的静音定时。 ## 静音定时与静默 下表重点说明了静音定时与静默之间的区别。 | 静音定时 | 静默 | | --- | --- | | 使用可重复发生的时间间隔定义。 | 有固定的开始时间和结束时间。 | | 创建后添加到通知策略中。 | 使用标签与警报进行匹配，以确定是否静默。 | ## 添加静音定时 您可以在 Grafana 工作区中创建静音定时。 **添加静音定时** 1. 在 Grafana 控制台的 Grafana 菜单中，选择**警报**。 1. 选择**通知策略**，然后选择**静音定时**选项卡。 1. 从 **Alertmanager** 下拉列表中，选择要编辑的 Alertmanager。 1. 选择 **\$1 添加静音定时**按钮。 1. 填写表单以创建一个[时间间隔](#v10-alerting-manage-muting-interval)，以匹配您的静音定时。 1. 保存静音定时。 ## 向通知策略添加静音定时 设置静音定时后，就可以将其添加到要以定期间隔静音的通知策略中使用。 **向通知策略添加静音定时** 1. 在 Grafana 控制台的 Grafana 菜单中，选择**警报**。 1. 选择**通知策略**，然后选择**通知策略**选项卡。 1. 选择要向其添加静音定时的通知策略，然后选择 **...**、**编辑**。 1. 从**静音定时**下拉列表中，选择要添加到策略中的静音定时。 1. 保存更改。 ## 时间间隔 时间间隔是抑制警报的特定持续时间。持续时间通常包括特定的时间范围以及一周、一月或一年中的几天。 支持的时间间隔选项包括： + **时间范围**：包含开始时间但不包含结束时间的时间（如果未选择位置，则以 UTC 为单位，否则为本地时间）。 + **位置**：设置定时的位置，时间范围以该位置的当地时间显示。 + **星期几**：一周中的哪几天。例如 `monday:thursday`。 + **月中日期**：一个月中的哪几天。值范围为 `1` 到 `31`。负值可按相反顺序指定月中日期，因此 `-1` 代表月中最后一天。 + **月份**：一年中的月份，可以是数字名称，也可以是完整日历月名称。例如 `1, may:august`。 + **年份**：间隔的年份。例如 `2023:2024`。 这些元素中的每一个都可以是一个列表，并且必须满足元素中的至少一项才能匹配。字段还支持范围，使用 `:`。例如 `monday:thursday`。 如果字段留空，则任何时刻都将与该字段匹配。要匹配完整的时间间隔，所有字段必须匹配。静音定时可以包含多个时间间隔。 如果要指定确切的持续时间，请指定该持续时间所需的所有选项。例如，如果您想为当月第一个星期一（3 月、6 月、9 月和 12 月）创建一个介于 12:00 和 24:00 UTC 之间的时间间隔，则您的时间间隔规范可以是： + 时间范围： + 开始时间：`12:00` + 结束时间：`24:00` + 星期几：`monday` + 月份：`3, 6, 9, 12` + 月中日期：`1:7` # 查看警报规则的状态和运行状况 **** 本文档主题专为支持 **Grafana 10.x 版本**的 Grafana 工作区而设计。 对于支持 Grafana 9.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 9](using-grafana-v9.md)。 对于支持 Grafana 8.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 8](using-grafana-v8.md)。 警报规则的状态和运行状况提供了警报的几个关键状态指标。 共有三个组件： + [警报规则状态](#v10-alerting-manage-rulestate-state) + [警报实例状态](#v10-alerting-manage-rulestate-instance) + [警报规则运行状况](#v10-alerting-manage-rulestate-health) 尽管相关，但每个组件传达的信息略有不同。 **查看警报规则的状态和运行状况** 1. 在 Grafana 控制台的 Grafana 菜单中，选择**警报**。 1. 选择**警报规则**以查看现有警报的列表。 1. 选择一条警报规则以查看其状态和运行状况。 ## 警报规则状态 警报规则可能处于以下任何状态： | 州 | 说明 | | --- | --- | | 正常 | 评估引擎返回的时间序列均未处于 pending 或 firing 状态。 | | 待处理 | 评估引擎返回的时间序列中至少有一个处于 pending 状态。 | | 触发 | 评估引擎返回的时间序列中至少有一个处于 firing 状态。 | **注意** 警报先过渡到 `pending`，然后过渡到 `firing`，因此至少需要两个评估周期才会触发警报。 ## 警报实例状态 警报实例可能处于以下任何状态： | 州 | 说明 | | --- | --- | | 正常 | 既不是 pending 也不是 firing 的警报状态。一切正常。 | | 待处理 | 警报处于活动状态的时间少于配置的阈值持续时间。 | | 提示 | 警报处于活动状态的时间超过配置的阈值持续时间。 | | 无数据 | 在配置的时间窗口内未收到任何数据。 | | 提示 | 尝试评估警报规则时出错。 | ## 保留上一状态 可以将警报规则配置为在遇到 `NoData` 或 `Error` 状态时保留上一个状态。这既可以防止警报触发，也可以阻止解决和重新触发。与正常评估一样，待处理期过后，警报规则将从 `pending` 变为 `firing`。 ## 警报规则运行状况 警报规则可能具有以下运行状况之一。 | 州 | 说明 | | --- | --- | | Ok | 评估警报规则时无错误。 | | 错误 | 评估警报规则时出错。 | | NoData | 规则评估期间返回的至少一个时间序列中没有数据。 | | \$1状态\$1， KeepLast | 该规则本应收到另一种状态，但配置为保留警报规则的最后状态。 | ## 特殊警报 NoData 和错误 当警报规则的评估产生 `NoData` 或 `Error` 状态时，Grafana Alerting 将生成具有以下附加标签的特殊警报。 | 标签 | 说明 | | --- | --- | | alertname | DatasourceNoData 或 DatasourceError，视状态而定。 | | datasource\$1uid | 导致该状态的数据来源 UID。 | **注意** 如 [配置 Grafana 管理的警报规则](v10-alerting-configure-grafanamanaged.md) 主题所述，您需要在警报规则中将无数据或错误处理设置为 `NoData` 或 `Error`，以生成其他标签。 您可以像处理常规警报一样处理这些警报，包括添加静默、路由到联系点等。 # 按警报组查看和筛选 **** 本文档主题专为支持 **Grafana 10.x 版本**的 Grafana 工作区而设计。 对于支持 Grafana 9.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 9](using-grafana-v9.md)。 对于支持 Grafana 8.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 8](using-grafana-v8.md)。 警报组显示来自 Alertmanager 实例的分组警报。默认情况下，警报规则按通知策略中默认策略的标签键进行分组。将常见警报规则分组到一个警报组中可以防止触发重复的警报规则。 您可以查看警报组，也可以筛选符合特定条件的警报规则。 **查看警报分组** 1. 在 Grafana 控制台的 Grafana 菜单中，选择**警报**。 1. 选择**组**以查看现有组。 1. 从 **Alertmanager** 下拉菜单中，选择外部 Alertmanager 作为数据来源。 1. 从**自定义分组依据**下拉列表中，选择标签组合，以查看默认分组以外的分组。这对于调试和验证通知策略分组非常有用。 如果警报不包含根策略分组或自定义分组中指定的标签，则会将警报添加到标题为 `No grouping` 的全包分组中。 您可以按标签或警报状态筛选警报。 **按标签筛选** + 在**搜索**中，输入现有标签，以查看与该标签匹配的警报。 例如 `environment=production,region=~US|EU,severity!=warning`。 **按状态筛选** + 在**状态**中，从“活动”、“已抑制”或“未处理”状态中选择，以查看与所选状态匹配的警报。所有其他警报均已隐藏。 # 查看通知错误 **** 本文档主题专为支持 **Grafana 10.x 版本**的 Grafana 工作区而设计。 对于支持 Grafana 9.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 9](using-grafana-v9.md)。 对于支持 Grafana 8.x 版本的 Grafana 工作区，请参阅[使用 Grafana 版本 8](using-grafana-v8.md)。 查看通知错误，了解发送失败或未收到通知的原因。 **注意** 只有 Grafana Alertmanager 支持此功能。 **查看通知错误** 1. 在左侧菜单中，选择**警报**，然后选择**联系点**。 如果任何联系点出现故障，工作区的右上角会显示一条消息，提醒您存在错误以及错误的数量。 1. 选择某个联系点，查看该联系点的错误详情。 如果将鼠标悬停在错误图标上，则会显示错误详情。 如果联系点有多个集成，您会看到列出的每个集成的所有错误。 1. 在“运行状况”列中，检查通知的状态。 可能是“正常”、“未尝试”或“错误”。