community.general.elastic callback – Создание распределённых трассировок для каждой задачи Ansible в Elastic APM

Примечание

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

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

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

Для использования в плейбуке укажите: community.general.elastic.

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

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

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

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

Описание

Этот плагин создаёт распределённые трассировки для каждой задачи Ansible в Elastic APM.
Вы можете настроить плагин с помощью переменных среды.
См. https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html.

Требования

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

elastic-apm (библиотека Python)

Параметры

Параметр	Комментарии
apm_api_key строка	Используйте ключ API APM Настройка: Переменная среды: `ELASTIC_APM_API_KEY`
apm_secret_token строка	Используйте токен сервера APM Настройка: Переменная среды: `ELASTIC_APM_SECRET_TOKEN`
apm_server_url строка	Используйте сервер APM и его переменные среды. Настройка: Переменная среды: `ELASTIC_APM_SERVER_URL`
apm_service_name строка	Атрибут ресурса имени службы. Значение по умолчанию: `"ansible"` Настройка: Переменная среды: `ELASTIC_APM_SERVICE_NAME`
apm_verify_server_cert логический тип	Проверяет сертификат SSL при подключении по HTTPS. Варианты: `false` `true` ← (по умолчанию) Настройка: Переменная среды: `ELASTIC_APM_VERIFY_SERVER_CERT`
hide_task_arguments логический тип	Скрыть аргументы задачи. Варианты: `false` ← (по умолчанию) `true` Настройка: Переменная среды: `ANSIBLE_OPENTELEMETRY_HIDE_TASK_ARGUMENTS`
traceparent строка	Заголовок W3C Trace Context traceparent. Настройка: Переменная среды: `TRACEPARENT`

Примеры

examples: |
  Enable the plugin in ansible.cfg:
    [defaults]
    callbacks_enabled = community.general.elastic

  Set the environment variable:
    export ELASTIC_APM_SERVER_URL=<your APM server URL)>
    export ELASTIC_APM_SERVICE_NAME=your_service_name
    export ELASTIC_APM_API_KEY=your_APM_API_KEY

Авторы

Victor Martinez (@v1v)

Подсказка

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

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

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