community.general.opentelemetry обратный вызов – Создание распределённых трассировок с OpenTelemetry

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.general.opentelemetry.

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

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

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

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

Синопсис

Этот плагин обратного вызова создаёт распределённые трассировки для каждой задачи Ansible с помощью OpenTelemetry.
Вы можете настроить экспортер и SDK OpenTelemetry с помощью переменных среды.
См. https://opentelemetry-python.readthedocs.io/en/latest/exporter/otlp/otlp.html.
См. https://opentelemetry-python.readthedocs.io/en/latest/sdk/environment_variables.html#opentelemetry-sdk-environment-variables.

Требования

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

opentelemetry-api (библиотека Python)
opentelemetry-exporter-otlp (библиотека Python)
opentelemetry-sdk (библиотека Python)

Параметры

Параметр	Комментарии
disable_attributes_in_logs boolean добавлено в community.general 7.1.0	Отключить заполнение атрибутов span в журналы. Варианты: `false` ← (по умолчанию) `true` Настройка: Запись INI: [callback_opentelemetry] disable_attributes_in_logs = false Переменная среды: `ANSIBLE_OPENTELEMETRY_DISABLE_ATTRIBUTES_IN_LOGS`
disable_logs boolean добавлено в community.general 5.8.0	Отключить отправку логов. Варианты: `false` ← (по умолчанию) `true` Настройка: Запись INI: [callback_opentelemetry] disable_logs = false Переменная среды: `ANSIBLE_OPENTELEMETRY_DISABLE_LOGS`
enable_from_environment string добавлено в community.general 3.8.0	Включить этот коллбек только если заданная переменная среды существует и её значение равно `true`. Это удобно при использовании Configuration as Code и необходимости отправки распределённых трассировок при выполнении в CI, но не при локальном запуске Ansible. Для этого оценивается заданное `enable_from_environment` значение как переменная среды, и если оно равно true, этот плагин будет включён. Настройка: Запись INI: [callback_opentelemetry] enable_from_environment = VALUE добавлено в community.general 5.3.0 Переменная среды: `ANSIBLE_OPENTELEMETRY_ENABLE_FROM_ENVIRONMENT`
hide_task_arguments boolean	Скрыть аргументы задачи. Варианты: `false` ← (по умолчанию) `true` Настройка: Запись INI: [callback_opentelemetry] hide_task_arguments = false добавлено в community.general 5.3.0 Переменная среды: `ANSIBLE_OPENTELEMETRY_HIDE_TASK_ARGUMENTS`
otel_exporter_otlp_traces_protocol string добавлено в community.general 9.0.0	`OTEL_EXPORTER_OTLP_TRACES_PROTOCOL` представляет протокол транспорта для span. См. https://opentelemetry-python.readthedocs.io/en/latest/sdk/environment_variables.html#envvar-OTEL_EXPORTER_OTLP_TRACES_PROTOCOL. Варианты: `"grpc"` ← (по умолчанию) `"http/protobuf"` Настройка: Запись INI: [callback_opentelemetry] otel_exporter_otlp_traces_protocol = grpc Переменная среды: `OTEL_EXPORTER_OTLP_TRACES_PROTOCOL`
otel_service_name string	Атрибут ресурса имени службы. По умолчанию: `"ansible"` Настройка: Запись INI: [callback_opentelemetry] otel_service_name = ansible добавлено в community.general 5.3.0 Переменная среды: `OTEL_SERVICE_NAME`
store_spans_in_file string добавлено в community.general 9.0.0	Сохраняет экспортированные span в заданный файл. Настройка: Запись INI: [callback_opentelemetry] store_spans_in_file = VALUE Переменная среды: `ANSIBLE_OPENTELEMETRY_STORE_SPANS_IN_FILE`
traceparent string	Заголовок W3C Trace Context header traceparent. По умолчанию: `"None"` Настройка: Переменная среды: `TRACEPARENT`

Примеры

examples: |
  Enable the plugin in ansible.cfg:
    [defaults]
    callbacks_enabled = community.general.opentelemetry
    [callback_opentelemetry]
    enable_from_environment = ANSIBLE_OPENTELEMETRY_ENABLED

  Set the environment variable:
    export OTEL_EXPORTER_OTLP_ENDPOINT=<your endpoint (OTLP/HTTP)>
    export OTEL_EXPORTER_OTLP_HEADERS="authorization=Bearer your_otel_token"
    export OTEL_SERVICE_NAME=your_service_name
    export ANSIBLE_OPENTELEMETRY_ENABLED=true

Авторы

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/opentelemetry_callback.html