Настройка Envoy для Ключ-АСТРОМ: различия между версиями

Материал из Документация Ключ-АСТРОМ
(Новая страница: «{| class="wikitable" |'''Заявление о поддержке''' Эта интеграция основана на открытом исходном коде...»)
 
 
(не показана 1 промежуточная версия этого же участника)
Строка 38: Строка 38:
== Получение записей конфигурации ==
== Получение записей конфигурации ==


# В Ключ-АСТРОМ Hub найдите <code>Envoy</code>.
# Перейдите в разделы Ключ-АСТРОМ и выберите '''Установить мониторинг.'''
# Выберите запись Hub для '''Envoy'''.
# В виде компонента выберите '''Мониторинг > ЕдиныйАгент'''.
# Выберите '''Настроить'''.
# В качестве платформы укажите '''Envoy.'''
# Настройте '''токен''' '''API'''.
# Настройте токен '''API'''.
# Выполните следующие шаги и используйте (и скорректируйте) два предоставленных фрагмента конфигурации, где это применимо.
# Выполните следующие шаги и используйте (и скорректируйте) два предоставленных фрагмента конфигурации, где это применимо.
[[Файл:Image1220.png|граница|831x831пкс]]


== Добавление записей кластера Ключ-АСТРОМ для экспорта OpenTelemetry ==
== Добавление записей кластера Ключ-АСТРОМ для экспорта OpenTelemetry ==
Чтобы '''Envoy''' отправлял трассировки в Ключ-АСТРОМ, сначала нужно [https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/intro/terminology настроить запись кластера] для Клюя-АСТРОМ в файле конфигурации '''Envoy'''. Для этого добавьте запись конфигурации кластера, полученную выше, под ключом верхнего уровня <code>clusters</code>.
Чтобы '''Envoy''' отправлял трассировки в Ключ-АСТРОМ, сначала нужно [https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/intro/terminology настроить запись кластера] для Ключ-АСТРОМ в файле конфигурации '''Envoy'''. Для этого добавьте запись конфигурации кластера, полученную выше, под ключом верхнего уровня <code>clusters</code>.


== Настройка трассировщика OpenTelemetry ==
== Настройка трассировщика OpenTelemetry ==

Текущая версия на 03:32, 20 июня 2025

Заявление о поддержке

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

Всегда используйте самую последнюю версию релиза, чтобы быть уверенным в установке последних исправлений и патчей.

Важной частью трассировки является наличие стабильной, единой точки в вашей архитектуре, где гарантируется инициализация трассировки, например, запуск новых или продолжение существующих трассировок с использованием распространения контекста. Поскольку сетевые запросы сначала поступают на границу сети, это идеальное место для обеспечения этого, и этого можно добиться с помощью централизованно развернутого обратного прокси-сервера, который получает запросы, запускает трассировку и направляет запрос на нужный бэкэнд вместе с распространением контекста.

Одним из вариантов настройки такой установки является платформа Envoy версии 1.29 или выше.

Envoy 1.28 и более ранние версии

Для оснащения Envoy 1.28 и более ранних версий используйте ЕдиныйАгент с соответствующим модулем кода Envoy и активируйте мониторинг Envoy, включив Envoy в разделе Настройки > Мониторинг > Отслеживаемые технологии.

Предустановка конфигурации

Для настройки Envoy для экспорта трассировок в Ключ-АСТРОМ необходимы следующие условия:

  • Envoy 1.29 (или выше)
  • OTLP traces URL для экспорта
Отключение мониторинга ЕдиногоАгента Envoy

При использовании экспортера OpenTelemetry в Envoy необходимо отключить мониторинг ЕдиногоАгента Envoy, чтобы избежать сбоев в конфигурации. Выполните следующие шаги, чтобы отключить его в соответствии с вашими потребностями.

  1. Перейти на страницу соответствующей конфигурации
    • Для всей среды: Настройки > Мониторинг > Отслеживаемые технологии.
    • Для конкретного хоста: Ваш хост > Настройки хоста > Общие.
  2. Найдите Envoy в списке отслеживаемых технологий и выберите Изменить (значок карандаша).
  3. Нажмите на переключатель Мониторить Envoy, чтобы отключить мониторинг Envoy.

Файл конфигурации Envoy

Конфигурация Envoy хранится в файле YAML, путь к которому передается с параметром командной строки Envoy --config-path. Если вы не уверены, где находится файл, проверьте команду запуска Envoy на наличие этого значения.

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

  1. Перейдите в разделы Ключ-АСТРОМ и выберите Установить мониторинг.
  2. В виде компонента выберите Мониторинг > ЕдиныйАгент.
  3. В качестве платформы укажите Envoy.
  4. Настройте токен API.
  5. Выполните следующие шаги и используйте (и скорректируйте) два предоставленных фрагмента конфигурации, где это применимо.

Image1220.png

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

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

Настройка трассировщика OpenTelemetry

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

Поскольку Envoy 1.29 и последующие версии поддерживают несколько разные наборы функций, существует два разных способа их настройки.

  1. Envoy 1.30+
    • Используйте запись конфигурации трассировщика, полученную выше, настройте токен API в разделе tracing- provider- typed_config- http_service- request_headers_to_add- header- value (синтаксис - value: "Api-Token YOUR_API_TOKEN_HERE") и добавьте конфигурацию трассировщика в вышеупомянутую запись filters.
  2. 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.dynatrace.com/api/v2/otlp/v1/traces"

          cluster: dynatrace

          timeout: 10s

        request_headers_to_add:

        - header:

            key: "Authorization"

            value: "Api-Token {API_TOKEN_HERE}"

      resource_detectors:

        - name: envoy.tracers.opentelemetry.resource_detectors.dynatrace

          typed_config:

            "@type": type.googleapis.com/envoy.extensions.tracers.opentelemetry.resource_detectors.v3.DynatraceResourceDetectorConfig

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

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

Проверка настроек (необязательно)

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

1230.png