Миграция SDK из Elastic

Elastic Stack предоставляет два типа языковых SDK для инструментирования приложений:

Официальные APM-агенты Elastic – Эти агенты созданы специально для использования с Elastic Stack. В настоящее время нет прямого пути миграции для этих SDK. Приложения, которые их используют, должны быть повторно инструментированы с использованием соответствующих ClickStack SDK.
Распределения OpenTelemetry от Elastic (EDOT SDK) – Это распределения Elastic стандартных SDK OpenTelemetry, доступных для .NET, Java, Node.js, PHP и Python. Если ваше приложение уже использует EDOT SDK, вам не нужно повторно инструментировать свой код. Вместо этого вы можете просто перезаписать конфигурацию SDK для экспорта телеметрических данных в OTLP Collector, который включен в ClickStack. См. раздел "Миграция EDOT SDK" для получения дополнительных сведений.

Используйте ClickStack SDK, где это возможно

Хотя стандартные SDK OpenTelemetry поддерживаются, мы настоятельно рекомендуем использовать дистрибутивы ClickStack SDK для каждого языка. Эти распределения включают дополнительное инструментирование, улучшенные настройки по умолчанию и пользовательские расширения, разработанные для работы в унисон с конвейером ClickStack и интерфейсом HyperDX. Используя ClickStack SDK, вы можете разблокировать расширенные функции, такие как трассировки стека исключений, которые недоступны с обычными OpenTelemetry или EDOT SDK.

Миграция EDOT SDK

Аналогично ClickStack OpenTelemetry-базированным SDK, Распределения OpenTelemetry от Elastic (EDOT SDK) являются специализированными версиями официальных SDK OpenTelemetry. Например, EDOT Python SDK является настроенным распределением OpenTelemetry Python SDK, разработанным для беспрепятственной работы с Elastic Observability.

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

Конфигурация следует стандартным механизмам OpenTelemetry. Для Python это обычно делается через переменные окружения, как описано в документации OpenTelemetry Zero-Code Instrumentation.

Типичная конфигурация EDOT SDK может выглядеть так:

export OTEL_RESOURCE_ATTRIBUTES=service.name=<app-name>
export OTEL_EXPORTER_OTLP_ENDPOINT=https://my-deployment.ingest.us-west1.gcp.cloud.es.io
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=ApiKey P....l"

Чтобы мигрировать на ClickStack, обновите конечную точку, указывающую на локальный OTLP Collector, и измените заголовок авторизации:

export OTEL_RESOURCE_ATTRIBUTES=service.name=<app-name>
export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318
export OTEL_EXPORTER_OTLP_HEADERS="authorization=<YOUR_INGESTION_API_KEY>"

Ваш ключ API для загрузки генерируется приложением HyperDX и его можно найти в разделе Настройки команды → Ключи API.

Миграция EDOT SDK​

Миграция EDOT SDK