第 3 章 AlertmanagerConfig [monitoring.coreos.com/v1beta1]

inhibitRules

array

禁止规则列表。规则将仅适用于与资源的命名空间匹配的警报。

inhibitRules[]

对象

InhibitRule 定义了一个禁止规则，允许在其他警报触发时静默警报。请参阅 https://prometheus.io/docs/alerting/latest/configuration/#inhibit_rule

receivers

array

接收器列表。

receivers[]

对象

接收器定义一个或多个通知集成。

route

对象

与资源命名空间匹配的警报的 Alertmanager 路由定义。如果存在，它将作为第一级路由添加到生成的 Alertmanager 配置中。

timeIntervals

数组

TimeInterval 列表，指定路由应可变或处于活动状态的时间。

timeIntervals[]

object

TimeInterval 指定通知将静默或激活的时间周期。

等于

数组（字符串）

源和目标警报中必须有相等值的标签才能使禁止生效。

sourceMatch

array

存在一个或多个警报的匹配者才能使禁止生效。Operator 强制执行警报与资源的命名空间匹配。

sourceMatch[]

对象

Matcher 定义如何在警报的标签上匹配。

targetMatch

array

在要静默的警报中必须实现的匹配者。Operator 强制执行警报与资源的命名空间匹配。

targetMatch[]

对象

Matcher 定义如何在警报的标签上匹配。

matchType

string

匹配 operator, one of = (qual to), != (not equal), =~ (regex match)或 !~ (not regex match).负运算符(!= 和 !~)需要 Alertmanager >= v0.22.0。

名称

字符串

要匹配的标签。

value

字符串

要匹配的标签值。

matchType

string

匹配 operator, one of = (qual to), != (not equal), =~ (regex match)或 !~ (not regex match).负运算符(!= 和 !~)需要 Alertmanager >= v0.22.0。

名称

字符串

要匹配的标签。

value

字符串

要匹配的标签值。

emailConfigs

array

电子邮件配置列表。

emailConfigs[]

对象

EmailConfig 通过电子邮件配置通知。

name

字符串

接收器的名称。列表中所有项目之间必须是唯一的。

opsgenieConfigs

array

OpsGenie 配置列表。

opsgenieConfigs[]

对象

OpsGenieConfig 通过 OpsGenie 配置通知。See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config

pagerdutyConfigs

array

PagerDuty 配置列表。

pagerdutyConfigs[]

对象

PagerDutyConfig 通过 PagerDuty 配置通知。See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config

pushoverConfigs

array

推送配置列表。

pushoverConfigs[]

对象

PushoverConfig 通过 Pushover 配置通知。See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config

slackConfigs

array

Slack 配置列表。

slackConfigs[]

对象

SlackConfig 通过 Slack 配置通知。See https://prometheus.io/docs/alerting/latest/configuration/#slack_config

snsConfigs

数组

SNS 配置列表

snsConfigs[]

object

SNSConfig 通过 AWS SNS 配置通知。请参阅 https://prometheus.io/docs/alerting/latest/configuration/#sns_configs

telegramConfigs

数组

Telegram 配置列表。

telegramConfigs[]

object

TelegramConfig 通过 Telegram 配置通知。See https://prometheus.io/docs/alerting/latest/configuration/#telegram_config

victoropsConfigs

array

VictorOps 配置列表。

victoropsConfigs[]

对象

VictorOpsConfig 通过 VictorOps 配置通知。See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config

webhookConfigs

array

Webhook 配置列表。

webhookConfigs[]

对象

WebhookConfig 通过支持 webhook 有效负载的通用接收器配置通知。请参阅 https://prometheus.io/docs/alerting/latest/configuration/#webhook_config

wechatConfigs

array

WeChat 配置列表。

wechatConfigs[]

对象

WeChatConfig 通过 WeChat 配置通知。请参阅 https://prometheus.io/docs/alerting/latest/configuration/#wechat_config

authIdentity

字符串

用于身份验证的身份。

authPassword

对象

包含用于身份验证的密码的 secret 密钥。secret 需要与 AlertmanagerConfig 对象位于同一个命名空间中，并可以被 Prometheus Operator 访问。

authSecret

对象

包含 CRAM-MD5 机密的机密密钥。secret 需要与 AlertmanagerConfig 对象位于同一个命名空间中，并可以被 Prometheus Operator 访问。

authUsername

字符串

用于身份验证的用户名。

from

字符串

发送者地址。

标头

array

进一步的标头电子邮件键/值对。覆盖之前由通知实现设置的任何标头。

headers[]

对象

KeyValue 定义一个(key, value) tuple。

您好

字符串

要标识到 SMTP 服务器的主机名。

html

字符串

电子邮件通知的 HTML 正文。

requireTLS

布尔值

SMTP TLS 要求。请注意，Go 不支持到远程 SMTP 端点的未加密的连接。

sendResolved

布尔值

是否要通知已解析的警报。

smarthost

string

发送电子邮件的 SMTP 主机和端口。E.g. example.com:25

text

字符串

电子邮件通知的文本正文。

tlsConfig

对象

TLS 配置

至

字符串

发送通知的电子邮件地址。

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

string

要选择的对象命名空间中的 secret 名称。

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

string

要选择的对象命名空间中的 secret 名称。

key

字符串

元组的密钥。

value

字符串

元组的值。

ca

对象

包含用于目标的 CA 证书的结构。

cert

对象

包含目标的客户端证书文件的结构。

insecureSkipVerify

布尔值

禁用目标证书验证。

keySecret

对象

包含目标客户端密钥文件的 secret。

serverName

字符串

用于验证目标的主机名。

configMap

对象

包含用于目标的数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

key

字符串

要选择的密钥。

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

指定是否必须定义 ConfigMap 还是其键

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

指定是否需要定义 Secret 还是其密钥

configMap

对象

包含用于目标的数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

key

字符串

要选择的密钥。

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

指定是否必须定义 ConfigMap 还是其键

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

指定是否需要定义 Secret 还是其密钥

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

指定是否需要定义 Secret 还是其密钥

操作

string

为警报可用的以逗号分隔的操作列表。

apiKey

对象

包含 OpsGenie API 密钥的机密密钥。secret 需要与 AlertmanagerConfig 对象位于同一个命名空间中，并可以被 Prometheus Operator 访问。

apiURL

字符串

将 OpsGenie API 请求发送到的 URL。

description

字符串

事件的描述。

详情

array

一组任意键/值对，提供了有关该事件的更多详情。

details[]

对象

KeyValue 定义一个(key, value) tuple。

实体

string

可以用来指定与哪个域警报相关的可选字段。

httpConfig

对象

HTTP 客户端配置。

message

字符串

仅限 130 个字符的警报文本。

备注

字符串

其他警报备注。

priority

字符串

警报的优先级级别。可能的值有 P1、P2、P3、P4 和 P5。

响应者

array

负责通知的响应者列表。

responders[]

对象

OpsGenieConfigResponder defines a responder to an incident.必须定义 id、name 或 username 之一。

sendResolved

布尔值

是否要通知已解析的警报。

source

字符串

回到通知的发送者。

tags

字符串

附加到通知的以逗号分隔的标签列表。

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

string

要选择的对象命名空间中的 secret 名称。

key

字符串

元组的密钥。

value

字符串

元组的值。

授权

对象

客户端的授权标头配置。这与 BasicAuth 相互排斥，且只能从 Alertmanager v0.22+ 开始。

basicAuth

对象

客户端的 basicAuth。这是与授权相互排斥的。如果定义了这两者，则 BasicAuth 优先。

bearerTokenSecret

对象

包含客户端用于身份验证的 bearer 令牌的机密密钥。secret 需要与 AlertmanagerConfig 对象位于同一个命名空间中，并可以被 Prometheus Operator 访问。

followRedirects

布尔值

FollowRedirects 指定客户端是否应该遵循 HTTP 3xx 重定向。

oauth2

object

用于获取目标令牌的 OAuth2 客户端凭据。

proxyURL

字符串

可选的代理 URL。

tlsConfig

对象

客户端的 TLS 配置。

credentials

对象

包含请求凭证的 secret 密钥

type

字符串

设置身份验证类型。默认为 Bearer，Basic 将导致错误

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

指定是否需要定义 Secret 还是其密钥

password

对象

服务监控器命名空间中的 secret，其中包含用于身份验证的密码。

username

对象

服务监控器命名空间中的 secret，其中包含用于身份验证的用户名。

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

指定是否需要定义 Secret 还是其密钥

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

指定是否需要定义 Secret 还是其密钥

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

string

要选择的对象命名空间中的 secret 名称。

clientId

对象

包含 OAuth2 客户端 ID 的 secret 或 configmap

clientSecret

对象

包含 OAuth2 客户端 secret 的 secret

endpointParams

对象（字符串）

附加到令牌 URL 的参数

scopes

数组（字符串）

用于令牌请求的 OAuth2 范围

tokenUrl

字符串

从中获取令牌的 URL

configMap

对象

包含用于目标的数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

key

字符串

要选择的密钥。

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

指定是否必须定义 ConfigMap 还是其键

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

指定是否需要定义 Secret 还是其密钥

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

指定是否需要定义 Secret 还是其密钥

ca

对象

包含用于目标的 CA 证书的结构。

cert

对象

包含目标的客户端证书文件的结构。

insecureSkipVerify

布尔值

禁用目标证书验证。

keySecret

对象

包含目标客户端密钥文件的 secret。

serverName

字符串

用于验证目标的主机名。

configMap

对象

包含用于目标的数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

key

字符串

要选择的密钥。

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

指定是否必须定义 ConfigMap 还是其键

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

指定是否需要定义 Secret 还是其密钥

configMap

对象

包含用于目标的数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

key

字符串

要选择的密钥。

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

指定是否必须定义 ConfigMap 还是其键

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

指定是否需要定义 Secret 还是其密钥

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

指定是否需要定义 Secret 还是其密钥

id

字符串

响应者 ID。

name

字符串

响应者的名称。

type

字符串

响应者的类型。

username

字符串

响应者的用户名。

class

字符串

事件的 class/type。

客户端

字符串

客户端识别.

clientURL

字符串

返回到通知的发送者。

component

字符串

有问题的受影响系统的部分或组件。

description

字符串

事件的描述。

详情

array

提供有关事件的更多详情的任意键/值对。

details[]

对象

KeyValue 定义一个(key, value) tuple。

group

字符串

集群或源分组。

httpConfig

对象

HTTP 客户端配置。

pagerDutyImageConfigs

数组

要附加的镜像详情列表，提供了有关事件的更多详情。

pagerDutyImageConfigs[]

object

PagerDutyImageConfig 将镜像附加到事件

pagerDutyLinkConfigs

数组

要附加的链接详情列表，提供了有关事件的更多详情。

pagerDutyLinkConfigs[]

object

PagerDutyLinkConfig 会附加一个事件的文本链接

routingKey

对象

包含 PagerDuty 集成密钥的 secret 密钥（使用 Events API v2 时）。需要定义此字段或 serviceKey。secret 需要与 AlertmanagerConfig 对象位于同一个命名空间中，并可以被 Prometheus Operator 访问。

sendResolved

布尔值

是否要通知已解析的警报。

serviceKey

对象

包含 PagerDuty 服务密钥的 secret 密钥（使用集成类型 "Prometheus" 时）。需要定义此字段或 routingKey。secret 需要与 AlertmanagerConfig 对象位于同一个命名空间中，并可以被 Prometheus Operator 访问。

严重性

字符串

事件严重性。

url

字符串

发送请求的 URL。

key

字符串

元组的密钥。

value

字符串

元组的值。

授权

对象

客户端的授权标头配置。这与 BasicAuth 相互排斥，且只能从 Alertmanager v0.22+ 开始。

basicAuth

对象

客户端的 basicAuth。这是与授权相互排斥的。如果定义了这两者，则 BasicAuth 优先。

bearerTokenSecret

对象

包含客户端用于身份验证的 bearer 令牌的机密密钥。secret 需要与 AlertmanagerConfig 对象位于同一个命名空间中，并可以被 Prometheus Operator 访问。

followRedirects

布尔值

FollowRedirects 指定客户端是否应该遵循 HTTP 3xx 重定向。

oauth2

object

用于获取目标令牌的 OAuth2 客户端凭据。

proxyURL

字符串

可选的代理 URL。

tlsConfig

对象

客户端的 TLS 配置。

credentials

对象

包含请求凭证的 secret 密钥

type

字符串

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional