community.general.loganalytics_ingestion callback – Отправляет результаты задач в рабочую область Azure Log Analytics с помощью нового API приема журналов

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: community.general.loganalytics_ingestion.

Добавлено в community.general 12.4.0

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

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

Этот плагин является плагином обратного вызова для уведомлений. Он отправляет сведения о выполнении плейбука в другие приложения, службы или системы. Дополнительные сведения о плагинах обратного вызова см. в разделе Плагины обратного вызова.

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

Этот плагин обратного вызова отправляет результаты задач в формате JSON в рабочую область Azure Log Analytics с помощью нового API приема журналов.

Требования

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

Плагин обратного вызова включен.
Создана рабочая область Azure Log Analytics.
Созданы правило сбора данных (DCR) и пользовательская таблица.

Параметры

Параметр	Комментарии
client_id string / обязательный	Идентификатор клиента регистрации приложения Azure для аутентификации OAuth2 («современная аутентификация»). Конфигурация: Запись INI: [callback_loganalytics] client_id = VALUE Переменная среды: `ANSIBLE_LOGANALYTICS_CLIENT_ID`
client_secret string / обязательный	Секрет клиента регистрации приложения Azure. Конфигурация: Запись INI: [callback_loganalytics] client_secret = VALUE Переменная среды: `ANSIBLE_LOGANALYTICS_CLIENT_SECRET`
dce_url string / обязательный	URL конечной точки сбора данных (DCE) для Azure Logs Ingestion API. Конфигурация: Запись INI: [callback_loganalytics] dce_url = VALUE Переменная среды: `ANSIBLE_LOGANALYTICS_DCE_URL`
dcr_id string / обязательный	Идентификатор правила сбора данных (DCR) для Azure Log Ingestion API. Конфигурация: Запись INI: [callback_loganalytics] dcr_id = VALUE Переменная среды: `ANSIBLE_LOGANALYTICS_DCR_ID`
disable_attempts integer	Если задано значение `disable_on_failure=true`, количество сбоев плагина, после которого плагин отключается. Это помогает предотвратить полный отказ плагина из-за единичной временной проблемы с сетью. По умолчанию: `3` Конфигурация: Запись INI: [callback_loganalytics] disable_attempts = 3 Переменная среды: `ANSIBLE_LOGANALYTICS_DISABLE_ATTEMPTS`
disable_on_failure boolean	Прекратить отправку данных в случае сбоя плагина. Варианты: `false` `true` ← (по умолчанию) Конфигурация: Запись INI: [callback_loganalytics] disable_on_failure = true Переменная среды: `ANSIBLE_LOGANALYTICS_DISABLE_ON_FAILURE`
include_content boolean	Отправлять содержимое в рабочую область Azure Log Analytics. Варианты: `false` ← (по умолчанию) `true` Конфигурация: Запись INI: [callback_loganalytics] include_content = false Переменная среды: `ANSIBLE_LOGANALYTICS_INCLUDE_CONTENT`
include_task_args boolean	Отправлять аргументы задачи в рабочую область Azure Log Analytics. Варианты: `false` ← (по умолчанию) `true` Конфигурация: Запись INI: [callback_loganalytics] include_task_args = false Переменная среды: `ANSIBLE_LOGANALYTICS_INCLUDE_TASK_ARGS`
stream_name string / обязательный	Имя потока, используемого для отправки журналов в рабочую область Azure Log Analytics. Конфигурация: Запись INI: [callback_loganalytics] stream_name = VALUE Переменная среды: `ANSIBLE_LOGANALYTICS_STREAM_NAME`
tenant_id string / обязательный	Идентификатор клиента Azure Active Directory. Конфигурация: Запись INI: [callback_loganalytics] tenant_id = VALUE Переменная среды: `ANSIBLE_LOGANALYTICS_TENANT_ID`
timeout integer	Время ожидания HTTP-запросов к API Azure Log Analytics. По умолчанию: `2` Конфигурация: Запись INI: [callback_loganalytics] timeout = 2 Переменная среды: `ANSIBLE_LOGANALYTICS_TIMEOUT`

Примечание

Перечисленные выше записи конфигурации для каждого типа записей (переменная Ansible, переменная среды и т. д.) упорядочены по приоритету от низкого к высокому. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше. Типы записей также упорядочены по приоритету от низкого к высокому. Например, запись ansible.cfg (расположенная выше в списке) переопределяется переменной Ansible (расположенной ниже в списке).

Примечания

Примечание

Для создания примера данных JSON, необходимого для формирования схемы таблицы в Azure Log Analytics, можно включить ведение журнала с тройным уровнем подробности (-vvv). Чтобы найти пример данных, выполните поиск строки Event Data: в выводе.

См. также

Logs Ingestion API: Общие сведения о Logs Ingestion API в Azure Monitor

Примеры

examples: |
  Enable the plugin in ansible.cfg:
    [defaults]
    callback_enabled = community.general.loganalytics_ingestion
  Set the environment variables:
    export ANSIBLE_LOGANALYTICS_DCE_URL=https://my-dce.ingest.monitor.azure.com
    export ANSIBLE_LOGANALYTICS_DCR_ID=dcr-xxxxxx
    export ANSIBLE_LOGANALYTICS_CLIENT_ID=xxxxxxxx
    export ANSIBLE_LOGANALYTICS_CLIENT_SECRET=xxxxxxxx
    export ANSIBLE_LOGANALYTICS_TENANT_ID=xxxxxxxx
    export ANSIBLE_LOGANALYTICS_STREAM_NAME=Custom-MyTable

Авторы

Wade Cline (@wtcline-intc)
Sriramoju Vishal Bharath (@vsh47)
Cyrus Li (@zhcli)

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

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