Перейти к основному содержанию
Перейти к основному содержанию

Только HyperDX

Этот вариант предназначен для пользователей, у которых уже есть запущенный экземпляр ClickHouse с данными наблюдаемости и/или событий.

HyperDX может использоваться независимо от остальной части стека и совместим с любой схемой данных, а не только с OpenTelemetry (OTel). Это делает его подходящим для кастомных конвейеров наблюдаемости, уже построенных на ClickHouse.

Чтобы обеспечить полную функциональность, необходимо предоставить экземпляр MongoDB для хранения состояния приложения, включая дашборды, сохранённые поисковые запросы, пользовательские настройки и оповещения.

В этом режиме ингестия данных полностью остаётся на стороне пользователя. Вы можете осуществлять приём данных в ClickHouse, используя собственный развёрнутый OpenTelemetry collector, прямую ингестию из клиентских библиотек, родные для ClickHouse движки таблиц (такие как Kafka или S3), ETL‑конвейеры или управляемые сервисы ингестии, такие как ClickPipes. Такой подход обеспечивает максимальную гибкость и подходит командам, которые уже эксплуатируют ClickHouse и хотят добавить HyperDX поверх него для визуализации, поиска и оповещений.

Подходит для​

  • Существующие пользователи ClickHouse
  • Настраиваемые конвейеры событий

Шаги развертывания​


Развертывание с помощью Docker​

Выполните следующую команду, изменив YOUR_MONGODB_URI при необходимости.

docker run -e MONGO_URI=mongodb://YOUR_MONGODB_URI -p 8080:8080 docker.hyperdx.io/hyperdx/hyperdx

Перейдите по адресу http://localhost:8080, чтобы открыть интерфейс HyperDX.

Создайте пользователя, указав имя пользователя и пароль, соответствующий требованиям.

После нажатия Create вам будет предложено ввести параметры подключения.

Интерфейс HyperDX

Заполните параметры подключения​

Подключитесь к своему внешнему кластеру ClickHouse, например к ClickHouse Cloud.

Вход в HyperDX

Если будет предложено создать источник, оставьте все значения по умолчанию и заполните поле Table значением otel_logs. Все остальные параметры должны быть определены автоматически, после чего вы сможете нажать Save New Source.

Создание источника

Для создания источника в ClickHouse должны уже существовать таблицы. Если у вас нет данных, мы рекомендуем развернуть коллектор ClickStack OpenTelemetry для создания таблиц.

Использование Docker Compose​

Вы можете изменить конфигурацию Docker Compose, чтобы добиться того же результата, что и в этом руководстве, удалив OTel collector и экземпляр ClickHouse из манифеста.

Коллектор OpenTelemetry ClickStack​

Даже если вы управляете собственным коллектором OpenTelemetry, независимо от других компонентов стека, мы всё равно рекомендуем использовать дистрибутив коллектора ClickStack. Это гарантирует использование схемы по умолчанию и применение лучших практик для ингестии.

Подробные сведения о развёртывании и настройке отдельного коллектора см. в разделе "Ингестия с помощью OpenTelemetry".

JSON type support​

Beta feature. Learn more.
Beta Feature - not production ready

JSON type support in ClickStack is a beta feature. While the JSON type itself is production-ready in ClickHouse 25.3+, its integration within ClickStack is still under active development and may have limitations, change in the future, or contain bugs.

ClickStack has beta support for the JSON type from version 2.0.4.

For the benefits of this type see Benefits of the JSON type.

In order to enable support for the JSON type users must set the following environment variables:

  • OTEL_AGENT_FEATURE_GATE_ARG='--feature-gates=clickhouse.json' - enables support in the OTel collector, ensuring schemas are created using the JSON type.
  • BETA_CH_OTEL_JSON_SCHEMA_ENABLED=true - enables support in the HyperDX application, allowing JSON data to be queried.

Для образа, содержащего только HyperDX, пользователям нужно лишь установить параметр BETA_CH_OTEL_JSON_SCHEMA_ENABLED=true, например:

docker run -e BETA_CH_OTEL_JSON_SCHEMA_ENABLED=true -e MONGO_URI=mongodb://YOUR_MONGODB_URI -p 8080:8080 docker.hyperdx.io/hyperdx/hyperdx