community.grafana.grafana_annotations 回调 – 通过 HTTP API 将 Ansible 事件作为图表上的注释发送到 Grafana。

注意

此回调插件是 community.grafana 集合 (版本 2.1.0) 的一部分。

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

要安装它，请使用： ansible-galaxy collection install community.grafana。您需要其他要求才能使用此回调插件，请参阅 要求 获取详细信息。

要在剧本中使用它，请指定： community.grafana.grafana_annotations。

回调插件

此插件是一个**通知回调**。它将剧本运行的信息发送到其他应用程序、服务或系统。有关回调插件的更多信息，请参阅 回调插件。

概要

要求

以下要求是在执行此回调的本地控制器节点上所需的。

  • 配置中的白名单

参数

参数

注释

grafana_api_key

字符串

Grafana API 密钥，允许在 HTTP API 上发布时进行身份验证。如果未提供，则需要 grafana_login 和 grafana_password。

配置

  • INI 条目

    [callback_grafana_annotations]
grafana_api_key = VALUE

  • 环境变量：GRAFANA_API_KEY

grafana_dashboard_id

整数

将创建注释的 Grafana 仪表板 ID。

配置

  • INI 条目

    [callback_grafana_annotations]
grafana_dashboard_id = VALUE

  • 环境变量：GRAFANA_DASHBOARD_ID

grafana_panel_ids

列表 / 元素=整数

将创建注释的 Grafana 面板 ID。给出单个整数或以逗号分隔的整数列表。

默认值： []

配置

  • INI 条目

    [callback_grafana_annotations]
grafana_panel_ids =

  • 环境变量：GRAFANA_PANEL_IDS

grafana_password

字符串

用于身份验证的 Grafana 密码。如果提供了 grafana_api_key，则忽略。

默认值： "ansible"

配置

  • INI 条目

    [callback_grafana_annotations]
grafana_password = ansible

  • 环境变量：GRAFANA_PASSWORD

grafana_url

字符串 / 必需

Grafana 注释 API URL

配置

  • INI 条目

    [callback_grafana_annotations]
grafana_url = VALUE

  • 环境变量：GRAFANA_URL

grafana_user

字符串

用于身份验证的 Grafana 用户。如果提供了 grafana_api_key，则忽略。

默认值： "ansible"

配置

  • INI 条目

    [callback_grafana_annotations]
grafana_user = ansible

  • 环境变量：GRAFANA_USER

http_agent

字符串

要在 HTTP 请求中设置的 HTTP “User-agent” 值。

默认值： "Ansible (grafana_annotations callback)"

配置

  • INI 条目

    [callback_grafana_annotations]
http_agent = Ansible (grafana_annotations callback)

  • 环境变量：HTTP_AGENT

validate_certs

别名：validate_grafana_certs

布尔值

验证 Grafana 服务器的 SSL 证书。（对于 HTTPS url）

选项

  • false

  • true ← (默认)

配置

  • INI 条目

    [callback_grafana_annotations]
validate_grafana_certs = true

    [callback_grafana_annotations]
validate_certs = true

  • 环境变量：GRAFANA_VALIDATE_CERT

作者

  • Rémi REY (@rrey)

提示

每种条目类型的配置条目具有从低到高的优先级顺序。例如，列表中较低的变量将覆盖较高的变量。