Обратный вызов community.general.logentries – Отправка событий в Logentries

Примечание

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

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

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

Для использования в playbook, укажите: community.general.logentries.

Плагин обратного вызова
Краткое описание
Требования
Параметры
Примеры

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

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

Краткое описание

Этот плагин обратного вызова будет генерировать объекты JSON и отправлять их в Logentries через TCP для целей аудита/отладки.
До версии 2.4, если вы хотели использовать конфигурацию ini, файл должен быть размещен в том же каталоге, что и этот плагин, и назван logentries.ini.
В версии 2.4 и выше вы можете просто поместить его в основной конфигурационный файл Ansible.

Требования

Указанные ниже требования необходимы на локальном узле контроллера, который выполняет этот обратный вызов.

добавление в белый список в конфигурации
certifi (библиотека Python)
flatdict (библиотека Python), если вы хотите использовать опцию flatten

Параметры

Параметр	Комментарии
api строка	URI к API Logentries. Значение по умолчанию: `"data.logentries.com"` Конфигурация: Запись INI: [callback_logentries] api = data.logentries.com Переменная окружения: `LOGENTRIES_API`
flatten логическое	Преобразовать сложные структуры данных в один словарь со сложными ключами. Варианты: `false` ← (по умолчанию) `true` Конфигурация: Запись INI: [callback_logentries] flatten = false Переменная окружения: `LOGENTRIES_FLATTEN`
port целое число	HTTP-порт, используемый при подключении к API. Значение по умолчанию: `80` Конфигурация: Запись INI: [callback_logentries] port = 80 Переменная окружения: `LOGENTRIES_PORT`
tls_port целое число	Порт, используемый при подключении к API, когда включен TLS. Значение по умолчанию: `443` Конфигурация: Запись INI: [callback_logentries] tls_port = 443 Переменная окружения: `LOGENTRIES_TLS_PORT`
token строка / обязательно	Токен Logentries `TCP token`. Конфигурация: Запись INI: [callback_logentries] token = VALUE Переменная окружения: `LOGENTRIES_ANSIBLE_TOKEN`
use_tls логическое	Переключатель для выбора использования TLS для шифрования связи с сервером API. Варианты: `false` ← (по умолчанию) `true` Конфигурация: Запись INI: [callback_logentries] use_tls = false Переменная окружения: `LOGENTRIES_USE_TLS`

Примеры

examples: >
  To enable, add this to your ansible.cfg file in the defaults block

    [defaults]
    callback_whitelist = community.general.logentries

  Either set the environment variables
    export LOGENTRIES_API=data.logentries.com
    export LOGENTRIES_PORT=10000
    export LOGENTRIES_ANSIBLE_TOKEN=dd21fc88-f00a-43ff-b977-e3a4233c53af

  Or in the main Ansible config file
    [callback_logentries]
    api = data.logentries.com
    port = 10000
    tls_port = 20000
    use_tls = true
    token = dd21fc88-f00a-43ff-b977-e3a4233c53af
    flatten = false

Авторы

Неизвестно

Подсказка

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

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

© 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/logentries_callback.html