community.general.splunk 回调 – 将任务结果事件发送到 Splunk HTTP 事件收集器

注意

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

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

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

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

回调插件

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

概要

  • 此回调插件会将任务结果作为 JSON 格式的事件发送到 Splunk HTTP 收集器。

  • 配套的 Splunk 监控和诊断应用程序可在此处获取 https://splunkbase.splunk.com/app/4023/。

  • 感谢“Ryan Currah (@ryancurrah)”提供其基础的原始代码。

需求

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

  • 将此回调插件列入白名单

  • 在 Splunk 中创建一个 HTTP 事件收集器

  • 在 ansible.cfg 中定义 URL 和令牌

参数

参数

注释

authtoken

字符串

用于验证与 Splunk HTTP 收集器连接的令牌。

配置

  • INI 条目

    [callback_splunk]
authtoken = VALUE

  • 环境变量：SPLUNK_AUTHTOKEN

batch

字符串

在 community.general 3.3.0 中添加

可以在多个剧本执行之间设置的相关 ID。

配置

  • INI 条目

    [callback_splunk]
batch = VALUE

  • 环境变量：SPLUNK_BATCH

include_milliseconds

布尔值

在 community.general 2.0.0 中添加

是否将毫秒包含为发送到 Splunk HTTP 收集器的事件中生成的 timestamp 字段的一部分。

选项

  • false ← (默认)

  • true

配置

url

字符串

Splunk HTTP 收集器源的 URL。

配置

  • INI 条目

    [callback_splunk]
url = VALUE

  • 环境变量：SPLUNK_URL

validate_certs

布尔值

在 community.general 1.0.0 中添加

是否验证与 HEC 的连接证书。除非您确定没有人可以拦截此插件和 HEC 之间的连接，否则不建议将其设置为 false，因为将其设置为 false 会允许中间人攻击！

选项

  • false

  • true ← (默认)

配置

示例

examples: >
  To enable, add this to your ansible.cfg file in the defaults block
    [defaults]
    callback_whitelist = community.general.splunk
  Set the environment variable
    export SPLUNK_URL=http://mysplunkinstance.datapaas.io:8088/services/collector/event
    export SPLUNK_AUTHTOKEN=f23blad6-5965-4537-bf69-5b5a545blabla88
  Set the ansible.cfg variable in the callback_splunk block
    [callback_splunk]
    url = http://mysplunkinstance.datapaas.io:8088/services/collector/event
    authtoken = f23blad6-5965-4537-bf69-5b5a545blabla88

作者

  • Stuart Hirst

提示

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