community.general.splunk callback – Отправка событий результатов задач в Splunk HTTP Event Collector

Примечание

Этот плагин обратного вызова входит в состав коллекции community.general (версия 9.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.general. Для использования этого плагина обратного вызова потребуются дополнительные требования. Подробности см. в разделе Требования.

Для использования в книге задач укажите: community.general.splunk.

Плагин обратного вызова
Обзор
Требования
Параметры
Примеры

Плагин обратного вызова

Этот плагин является плагином обратного вызова уведомления. Он отправляет информацию о выполнении книги задач в другие приложения, службы или системы. Подробнее о плагинах обратного вызова см. в разделе Плагины обратного вызова.

Обзор

Этот плагин обратного вызова отправляет результаты задач в виде событий в формате JSON в коллектор Splunk HTTP.
Сопутствующее приложение Splunk Monitoring & Diagnostics доступно здесь https://splunkbase.splunk.com/app/4023/.
Благодарность автору оригинального кода "Ryan Currah (@ryancurrah)".

Требования

Ниже перечислены требования к локальному контроллеру узлу, на котором выполняется этот плагин обратного вызова.

Включение этого плагина обратного вызова в белый список
Создание HTTP Event Collector в Splunk
Определение URL-адреса и токена в ansible.cfg

Параметры

Параметр	Комментарии
authtoken строка	Токен для аутентификации подключения к Splunk HTTP-коллектору. Конфигурация: Запись INI: [callback_splunk] authtoken = VALUE Переменная среды: `SPLUNK_AUTHTOKEN`
batch строка добавлен в community.general 3.3.0	Идентификатор корреляции, который может быть задан для нескольких запусков книги задач. Конфигурация: Запись INI: [callback_splunk] batch = VALUE Переменная среды: `SPLUNK_BATCH`
include_milliseconds булево добавлен в community.general 2.0.0	Включать ли миллисекунды в поле отметки времени генерируемого события, отправленного в Splunk HTTP-коллектор. Варианты: `false` ← (по умолчанию) `true` Конфигурация: Запись INI: [callback_splunk] include_milliseconds = false Переменная среды: `SPLUNK_INCLUDE_MILLISECONDS`
url строка	URL-адрес источника Splunk HTTP-коллектора. Конфигурация: Запись INI: [callback_splunk] url = VALUE Переменная среды: `SPLUNK_URL`
validate_certs булево добавлен в community.general 1.0.0	Валидировать ли сертификаты для подключений к HEC. Не рекомендуется устанавливать в `false`, кроме случаев, когда вы уверены, что никто не может перехватить подключение между этим плагином и HEC, так как установка в значение `false` позволяет атаки типа "человек посередине"! Варианты: `false` `true` ← (по умолчанию) Конфигурация: Запись INI: [callback_splunk] validate_certs = true Переменная среды: `SPLUNK_VALIDATE_CERTS`

Примеры

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

Подсказка

Записи конфигурации для каждого типа записи имеют порядок приоритета от низкого к высокому. Например, переменная, которая находится ниже в списке, переопределяет переменную, которая находится выше.

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/splunk_callback.html