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

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

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

1. Elastic Official APM agents – Они созданы специально для использования с Elastic Stack. В настоящее время для этих SDK нет прямого пути миграции. Приложения, использующие их, потребуется заново инструментировать с помощью соответствующих ClickStack SDKs.

2. Elastic Distributions of OpenTelemetry (EDOT SDK) – Это дистрибутивы стандартных SDK OpenTelemetry от Elastic, доступные для .NET, Java, Node.js, PHP и Python. Если ваше приложение уже использует EDOT SDK, заново инструментировать код не потребуется. Вместо этого можно просто перенастроить SDK на экспорт телеметрических данных в OTLP-коллектор, входящий в ClickStack. Дополнительные сведения см. в разделе “Миграция EDOT SDK”.

По возможности используйте ClickStack SDKs

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

​

Миграция EDOT SDK

Подобно SDK на основе ClickStack OpenTelemetry, Elastic Distributions of the OpenTelemetry SDKs (EDOT SDKs) представляют собой адаптированные версии официальных OpenTelemetry SDK. Например, EDOT Python SDK — это дистрибутив OpenTelemetry Python SDK, адаптированный поставщиком и предназначенный для бесшовной работы с Elastic Observability.

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

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

Типичная конфигурация 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-коллектор, и измените заголовок авторизации:

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; его можно найти в разделе Team Settings → API Keys.