Конечные точки API Ключ-АСТРОМ OTLP

Материал из Документация Ключ-АСТРОМ

Протокол OpenTelemetry (OTLP) — это основной сетевой протокол для обмена телеметрическими данными между сервисами и приложениями, использующими протокол OpenTelemetry.

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

  • Платформа Ключ-АСТРОМ Managed
  • Экземпляры АктивногоШлюза
В качестве альтернативы, вы можете развернуть Ключ-АСТРОМ Collector в качестве промежуточного сервисного приложения для пакетной обработки запросов и повышения производительности сети, или для преобразования запросов перед их пересылкой в ​​Ключ-АСТРОМ (например, для маскировки конфиденциальных данных).

Пути загрузки по умолчанию

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

Тип сигнала Путь
Трассировки /v1/traces
Метрики /v1/metrics
Логи /v1/logs

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

Экспорт в Ключ-АСТРОМ

Базовые URL-адреса

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

Тип API Базовый URL
Ключ-АСТРОМ Managed https://{your-domain}/e/{your-environment-id}/api/v2/otlp
Окружение АктивногоШлюза 1 https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/otlp
Контейнерная среда АктивногоШлюза 2 https://{your-activegate-domain}/e/{your-environment-id}/api/v2/otlp

1 В настройках среды АктивныхШлюзов по умолчанию используется порт 9999. Если вы изменили этот порт, скорректируйте его в URL-адресе соответствующим образом.

2 Для этой конструкции необходима PVC.

Примеры URL-адресов

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

Кластер АктивногоШлюза

Тип сигнала URL
Трассировки https://{your-domain}/e/{your-environment-id}/api/v2/otlp/v1/traces
Метрики https://{your-domain}/e/{your-environment-id}/api/v2/otlp/v1/metrics
Логи https://{your-domain}/e/{your-environment-id}/api/v2/otlp/v1/logs

Среда АктивногоШлюза

Тип сигнала URL
Трассировки https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/otlp/v1/traces
Метрики https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/otlp/v1/metrics
Логи https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/otlp/v1/logs

Ограничения API

При обращении к конечным точкам API Ключ-АСТРОМ действуют следующие ограничения.

  • Поддержка gRPC отсутствует. Для вызовов API необходимо использовать протокол HTTP.
  • JSON не поддерживается для протоколов Protocol Buffers. Необходимо использовать двоичный формат.

Аутентификация

Аутентификация осуществляется с помощью токена доступа к API и заголовка Authorization HTTP.

Это необходимо только для экспорта в АктивномШлюзе.

Authorization: Api-Token dt.....

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

Тип сигнала Область доступа
Трассировки openTelemetryTrace.ingest
Метрики metrics.ingest
Логи logs.ingest

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

Требования к сети

Убедитесь, что верны следующие утверждения:

  • TCP-порт не заблокирован

Поскольку обмен данными по протоколу OTLP с АктивнымШлюзов осуществляется через порты 443 (для SaaS и Managed решений) или 9999 (для АктивногоШлюза, работающих в среде), убедитесь, что соответствующий TCP-порт не блокируется брандмауэром или любым другим используемым вами решением для управления сетью.

  • Хранилище доверенных сертификатов вашей системы обновлено

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

Экспорт коллекционеру

Использование Collector в качестве промежуточного шлюза позволяет централизованно оптимизировать и упорядочивать телеметрические данные и запросы. См. примеры использования Collector для получения дополнительной информации и примеров конфигураций для популярных сценариев использования Collector.

Дополнительные сведения о настройке экземпляра Collector см. в документации Ключ-АСТРОМ Collector.

Преобразование gRPC

Поскольку в настоящее время Ключ-АСТРОМ требует экспорта OTLP с использованием HTTP, вы можете использовать Collector для преобразования экспорта gRPC в HTTP.

Дополнительные сведения см. в разделе Преобразование OTLP gRPC.

Аутентификация и TLS

Необходимость использования TLS и аутентификации запросов к Collector зависит от конкретной конфигурации вашего Collector. По умолчанию приемник OTLP настроен для HTTP-запросов в открытом текстовом формате и не требует аутентификации.

Для установления конечного исходящего соединения между Collector и Ключ-АСТРОМ всегда требуется аутентификация и протокол TLS.

Требования к сети

Убедитесь, что верны следующие утверждения:

  • Сетевые порты не заблокированы

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

Источник — https://doc.ruscomtech.ru/index.php?title=Конечные_точки_API_Ключ-АСТРОМ_OTLP&oldid=6085