community.grafana.grafana_silence 模块 – 管理 Grafana 静默

注意

此模块是 community.grafana 集合 (版本 2.1.0) 的一部分。

如果您使用的是 ansible 软件包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.grafana。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定： community.grafana.grafana_silence。

community.grafana 1.9.0 中的新增功能

概要

  • 通过 Alertmanager 静默 API 创建/删除 Grafana 静默。

要求

执行此模块的主机需要以下要求。

  • Alertmanager API 仅从 Grafana 8 开始可用，如果服务器版本低于 8，则模块将失败。

参数

参数

注释

client_cert

路径

用于 SSL 客户端身份验证的 PEM 格式证书链文件。

此文件也可以包含密钥，如果包含密钥，则不需要 *client_key*

client_key

路径

包含用于 SSL 客户端身份验证的私钥的 PEM 格式文件。

如果 *client_cert* 包含证书和密钥，则不需要此选项。

comment

字符串 / 必需

描述静默的注释。

created_by

字符串 / 必需

创建静默的作者。

ends_at

字符串 / 必需

静默结束时的 ISO 8601 时间戳（包含毫秒），例如“2029-07-29T08:45:45.000Z”。

grafana_api_key

字符串

Grafana API 密钥。

如果设置，则将忽略 url_username 和 url_password。

matchers

列表 / 元素=字典 / 必需

选择哪些警报受静默影响的匹配器列表。

org_id

整数

将创建或删除静默的 Grafana 组织 ID。

设置 *grafana_api_key* 时不使用，因为 grafana_api_key 仅属于一个组织。

与 org_name 互斥。

默认值： 1

org_name

字符串

将创建或删除静默的 Grafana 组织名称。

设置 *grafana_api_key* 时不使用，因为 grafana_api_key 仅属于一个组织。

与 org_id 互斥。

skip_version_check

布尔值

跳过 Grafana 版本检查并尝试访问 api 端点。

如果您在 grafana.ini 中启用了 `hide_version`，则此参数很有用

选项

  • false ← (默认)

  • true

starts_at

字符串 / 必需

静默开始时的 ISO 8601 时间戳（包含毫秒），例如“2029-07-29T08:45:45.000Z”。

state

字符串

删除具有相同设置的第一个静默事件。可以是“absent”或“present”。

选项

  • "present" ← (默认)

  • "absent"

url

别名：grafana_url

字符串 / 必需

Grafana URL。

url_password

别名：grafana_password

字符串

用于 API 身份验证的 Grafana 密码。

默认值： "admin"

url_username

别名：grafana_user

字符串

用于 API 身份验证的 Grafana 用户。

默认值： "admin"

use_proxy

布尔值

如果为 false，即使在目标主机上的环境变量中定义了代理，它也不会使用代理。

选项

  • false

  • true ← (默认)

validate_certs

布尔值

如果为 false，则不会验证 SSL 证书。

只有在使用自签名证书的个人控制站点上，才应将其设置为 false。

选项

  • false

  • true ← (默认)

示例

---
- name: Create a silence
  community.grafana.grafana_silence:
    grafana_url: "https://grafana.example.com"
    grafana_api_key: "{{ some_api_token_value }}"
    comment: "a testcomment"
    created_by: "me"
    starts_at: "2029-07-29T08:45:45.000Z"
    ends_at: "2029-07-29T08:55:45.000Z"
    matchers:
      - isEqual: true
        isRegex: true
        name: environment
        value: test
    state: present

- name: Delete a silence
  community.grafana.grafana_silence:
    grafana_url: "https://grafana.example.com"
    grafana_api_key: "{{ some_api_token_value }}"
    comment: "a testcomment"
    created_by: "me"
    starts_at: "2029-07-29T08:45:45.000Z"
    ends_at: "2029-07-29T08:55:45.000Z"
    matchers:
      - isEqual: true
        isRegex: true
        name: environment
        value: test
    state: absent

返回值

常用返回值已在此处记录 此处，以下是此模块特有的字段

键

描述

silence

复杂

有关静默的信息

返回：成功时

comment

字符串

静默的注释

返回：成功

示例： "['this is a test']"

createdBy

字符串

静默的作者

返回：成功

示例： "['me']"

endsAt

字符串

静默的结束时间戳

返回：成功

示例： "['2029-07-29T08:55:45.000Z']"

id

字符串

静默的 ID

返回：成功

示例： "['ec27df6b-ac3c-412f-ae0b-6e3e1f41c9c3']"

matchers

列表 / 元素=字符串

静默的匹配器

返回：成功

示例： [[{"isEqual": true, "isRegex": true, "name": "environment", "value": "test"}]]

startsAt

字符串

静默的开始时间戳

返回：成功

示例： "['2029-07-29T08:45:45.000Z']"

状态

字典

静默状态

返回：成功

示例： [{"state": "pending"}]

更新时间

字符串

静默状态最后更新的时间戳

返回：成功

示例： "['2023-07-27T13:27:33.042Z']"

作者

  • flkhndlr (@flkhndlr)