community.grafana.grafana_notification_channel 模块 – 管理 Grafana 通知渠道
注意
此模块是 community.grafana 集合 (版本 2.1.0) 的一部分。
如果您使用的是 ansible
包,则可能已安装此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install community.grafana
。
要在 playbook 中使用它,请指定:community.grafana.grafana_notification_channel
。
community.grafana 1.1.0 中的新增功能
已弃用
- 在以下版本中移除:
版本 3.0.0
- 原因:
Grafana 11 版中移除了旧版警报功能。
- 替代方案:
摘要
通过 API 创建/更新/删除 Grafana 通知渠道。
参数
参数 |
注释 |
---|---|
用于 SSL 客户端身份验证的 PEM 格式证书链文件。 此文件也可以包含密钥,如果包含密钥,则不需要 *client_key* |
|
包含用于 SSL 客户端身份验证的私钥的 PEM 格式文件。 如果 *client_cert* 包含证书和密钥,则不需要此选项。 |
|
钉钉消息类型。 选项
|
|
钉钉 Webhook URL。 |
|
禁用解决消息。 选项
|
|
覆盖消息内容。 |
|
Discord Webhook URL。 |
|
收件人列表。 |
|
向所有收件人发送单个电子邮件。 选项
|
|
Google Hangouts Webhook URL。 |
|
Grafana API 密钥。 如果设置了此项,则将忽略 |
|
HipChat API 密钥。 |
|
HipChat 房间 ID。 |
|
HipChat Webhook URL。 |
|
捕获可视化图像并将其附加到通知。 选项
|
|
将此渠道用于所有警报。 选项
|
|
Kafka 主题名称。 |
|
Kafka REST 代理 URL。 |
|
LINE 令牌。 |
|
通知渠道的名称。 当 *state* 为 |
|
OpsGenie API 密钥。 |
|
警报恢复正常后,自动在 OpsGenie 中关闭警报。 选项
|
|
允许使用 og_priority 标签设置警报优先级。 选项
|
|
OpsGenie Webhook URL。 |
|
将导入/导出仪表板的 Grafana 组织 ID。 设置了 *grafana_api_key* 时不使用,因为 grafana_api_key 只属于一个组织。 默认值: |
|
警报恢复正常后,在 PagerDuty 中解决事件。 选项
|
|
PagerDuty 集成密钥。 |
|
将警报消息从 PD 摘要移动到自定义详细信息。 这会更改自定义详细信息对象,并可能破坏您已配置的事件规则。 选项
|
|
PagerDuty 中的警报严重性。 选项
|
|
Prometheus 密码。 |
|
Prometheus API URL。 |
|
Prometheus 用户名。 |
|
Pushover API 令牌。 |
|
Pushover 中的设备列表。 |
|
在 仅当优先级为 |
|
Pushover 中的警报优先级。 选项
|
|
在 仅当优先级为 |
|
Pushover 用户密钥。 |
|
触发警报的附加通知间隔。 例如 |
|
Sensu 处理程序名称。 |
|
Sensu 密码。 |
|
Sensu 中的来源。 |
|
Sensu Webhook URL。 |
|
Sensu 用户。 |
|
跳过 Grafana 版本检查,并尝试连接 API 终结点。 选项
|
|
机器人消息使用的表情符号。 |
|
用作机器人消息图标的图像 URL。 |
|
提及整个频道还是仅提及活跃成员。 选项
|
|
提及的群组列表。 |
|
提及的用户列表。 |
|
覆盖默认 Slack 频道或用户。 |
|
Slack 令牌。 |
|
Slack Webhook URL。 |
|
设置机器人消息的用户名。 |
|
通知渠道的状态。 选项
|
|
Microsoft Teams Webhook URL。 |
|
Telegram 机器人令牌; |
|
Telegram 聊天 ID。 |
|
Threema Gateway API 密钥。 |
|
8 位 Threema Gateway ID(以 * 开头)。 |
|
应接收警报的 8 位 Threema ID。 |
|
渠道通知类型。 当 *state* 为 选项
|
|
渠道唯一标识符。 |
|
Grafana URL。 |
|
用于 API 身份验证的 Grafana 密码。 默认值: |
|
用于 API 身份验证的 Grafana 用户。 默认值: |
|
如果 选项
|
|
如果 仅当在使用自签名证书的个人控制站点上使用时,才应将其设置为 选项
|
|
警报恢复正常后,在 VictorOps 中解决事件。 选项
|
|
VictorOps Webhook URL。 |
|
要使用的 Webhook HTTP 方法。 选项
|
|
Webhook 密码。 |
|
Webhook URL |
|
Webhook 用户名。 |
注释
注意
从 Grafana 8.3 开始,通知渠道被联系点取代,此模块目前无法管理联系点。
由于 Grafana 保持与先前警报管理的后向兼容性,模块将报告执行成功,但
如果启用了新的警报机制,则在联系点中将不会显示任何内容。
示例
- name: Create slack notification channel
register: result
grafana_notification_channel:
uid: slack
name: slack
type: slack
slack_url: https://hooks.slack.com/services/xxx/yyy/zzz
grafana_url: "{{ grafana_url }}"
grafana_user: "{{ grafana_username }}"
grafana_password: "{{ grafana_password}}"
- name: Delete slack notification channel
register: result
grafana_notification_channel:
state: absent
uid: slack
grafana_url: "{{ grafana_url }}"
grafana_user: "{{ grafana_username }}"
grafana_password: "{{ grafana_password}}"
返回值
常用返回值已在 此处 记录,以下是此模块特有的字段
键 |
描述 |
---|---|
模块创建或更新的通知渠道。 返回:已更改 示例: |
状态
此模块将在 3.0.0 版本中移除。[已弃用]
更多信息请参见 已弃用。