Настройка трассировки OpenTelemetry с помощью Envoy

Заявление о поддержке Эта интеграция основана на открытом исходном коде, контролируемом соответствующими сообществами, и не подпадает под действие политики поддержки Ключ-АСТРОМ. Несмотря на наше стремление оказать помощь, о проблемах и предложениях по функциям следует сообщать непосредственно в соответствующий проект. Ключ-АСТРОМ не может гарантировать исправление/внедрение функций в связи с независимостью проектов с открытым исходным кодом. Всегда используйте самую последнюю версию релиза.

На этой странице описывается, как настроить Envoy версии 1.29+ для экспорта трассировок в Ключ-АСТРОМ.

Если вы используете Envoy версии 1.28 и более ранние, вы по-прежнему можете экспортировать трассировки в Ключ-АСТРОМ через модуль кода ЕдиногоАгента Envoy.

Предустановка

• OTLP отслеживает URL для экспорта.
• Модуль кода ЕдиногоАгента Envoy отключен. Для этого:
  1. Перейдите на страницу соответствующей конфигурации:
     • Для всей среды перейдите в Настройки > Мониторинг > Контролируемые технологии.
     • Для конкретного хоста перейдите в раздел Хосты > Настройки хоста > Общие.
  2. Найдите Envoy в списке отслеживаемых технологий и выберите Радактировать.
  3. При необходимости выберите переключатель Monitor Envoy, чтобы отключить модуль кода ЕдиногоАгента Envoy.

Получение записей конфигурации

1. В разделе Расширения найдите Envoy.
2. Выберите запись для Envoy.
3. Выберите Настроить.
4. Настройте токен API.
5. Продолжайте выполнять следующие шаги и используйте (и корректируйте) два предоставленных фрагмента конфигурации, где это применимо.

Добавление записи кластера Ключ-АСТРОМ для экспорта OpenTelemetry

Чтобы Envoy отправлял данные трассировки в Ключ-АСТРОМ, необходимо сначала настроить запись кластера для Ключ-АСТРОМ в конфигурационном файле Envoy. Для этого добавьте запись конфигурации кластера, полученную на шаге 2, в раздел верхнего уровня clusters.

Конфигурация Ключ-АСТРОМ, специфичная для трасссировок OpenTelemetry

Далее необходимо добавить поставщика трассировки в фильтр менеджера HTTP-соединений в файле конфигурации Envoy.

Envoy 1.30+

Используйте запись конфигурации трассировщика, полученную на шаге 2, настройте токен API в разделе tracing - provider - typed_config - http_service - request_headers_to_add - header - value (правильный синтаксис value: "Api-Token YOUR_API_TOKEN_HERE") и добавьте конфигурацию трассировщика в указанную выше запись filters.

Envoy 1.29

Настройте следующий фрагмент в разделе filters.

tracing:   provider:     name: envoy.tracers.opentelemetry     typed_config:       "@type": type.googleapis.com/envoy.config.trace.v3.OpenTelemetryConfig       service_name: your-service-name       http_service:         http_uri:           uri: "{your-environment-id}.live.astromkey.com/api/v2/otlp/v1/traces"           cluster: astromkey           timeout: 10s         request_headers_to_add:         - header:             key: "Authorization"             value: "Api-Token {API_TOKEN_HERE}"       resource_detectors:         - name: envoy.tracers.opentelemetry.resource_detectors.astromkey           typed_config:             "@type": type.googleapis.com/envoy.extensions.tracers.opentelemetry.resource_detectors.v3.astromkeyResourceDetectorConfig

Эти значения необходимо скорректировать в соответствии с вашей средой Ключ-АСТРОМ и конфигурацией экспорта:

• uri – Указывает желаемый URL-адрес экспорта с путём трассировки. Значение не должно включать схему протокола, а должно начинаться с имени хоста.
• cluster – Указывает имя кластера и должно совпадать со значением cluster_name предыдущего определения кластера.
• request_headers_to_add – Содержит HTTP-заголовки, включаемые в запрос. Необходимы при экспорте в АктивныйШлюз (настраиваются для API-токена).

Проверка настройки

После завершения настройки и получения первых данных вы можете проверить, отображаются ли трассировки в Ключ-АСТРОМ.