Только HyperDX
Этот вариант предназначен для пользователей, у которых уже есть запущенный экземпляр ClickHouse с данными наблюдаемости и/или событий.
HyperDX может использоваться независимо от остальной части стека и совместим с любой схемой данных, а не только с OpenTelemetry (OTel). Это делает его подходящим для кастомных конвейеров наблюдаемости, уже построенных на ClickHouse.
Чтобы обеспечить полную функциональность, необходимо предоставить экземпляр MongoDB для хранения состояния приложения, включая дашборды, сохранённые поисковые запросы, пользовательские настройки и оповещения.
В этом режиме ингестия данных полностью остаётся на стороне пользователя. Вы можете осуществлять приём данных в ClickHouse, используя собственный развёрнутый OpenTelemetry collector, прямую ингестию из клиентских библиотек, родные для ClickHouse движки таблиц (такие как Kafka или S3), ETL‑конвейеры или управляемые сервисы ингестии, такие как ClickPipes. Такой подход обеспечивает максимальную гибкость и подходит командам, которые уже эксплуатируют ClickHouse и хотят добавить HyperDX поверх него для визуализации, поиска и оповещений.
Подходит для
- Существующие пользователи ClickHouse
- Настраиваемые конвейеры событий
Шаги развертывания
Развертывание с помощью Docker
Выполните следующую команду, изменив YOUR_MONGODB_URI при необходимости.
Перейдите в интерфейс HyperDX
Перейдите по адресу http://localhost:8080, чтобы открыть интерфейс HyperDX.
Создайте пользователя, указав имя пользователя и пароль, соответствующий требованиям.
После нажатия Create вам будет предложено ввести параметры подключения.
Заполните параметры подключения
Подключитесь к своему внешнему кластеру ClickHouse, например к ClickHouse Cloud.
Если будет предложено создать источник, оставьте все значения по умолчанию и заполните поле Table значением otel_logs. Все остальные параметры должны быть определены автоматически, после чего вы сможете нажать Save New Source.
Для создания источника в ClickHouse должны уже существовать таблицы. Если у вас нет данных, мы рекомендуем развернуть коллектор ClickStack OpenTelemetry для создания таблиц.
Использование Docker Compose
Вы можете изменить конфигурацию Docker Compose, чтобы добиться того же результата, что и в этом руководстве, удалив OTel collector и экземпляр ClickHouse из манифеста.
Коллектор OpenTelemetry ClickStack
Даже если вы управляете собственным коллектором OpenTelemetry, независимо от других компонентов стека, мы всё равно рекомендуем использовать дистрибутив коллектора ClickStack. Это гарантирует использование схемы по умолчанию и применение лучших практик для ингестии.
Подробные сведения о развёртывании и настройке отдельного коллектора см. в разделе "Ингестия с помощью OpenTelemetry".
Поддержка типа JSON
Поддержка типа JSON в ClickStack находится в статусе бета-версии. Хотя сам тип JSON готов к промышленной эксплуатации в ClickHouse 25.3+, его интеграция в ClickStack всё ещё активно разрабатывается и может иметь ограничения, изменяться в будущем или содержать ошибки.
Поддержка типа JSON в ClickStack доступна в статусе бета-версии, начиная с версии 2.0.4.
О преимуществах этого типа см. раздел Преимущества типа JSON.
Чтобы включить поддержку типа JSON, пользователи должны задать следующие переменные окружения:
OTEL_AGENT_FEATURE_GATE_ARG='--feature-gates=clickhouse.json'— включает поддержку в OTel collector, гарантируя, что схемы создаются с использованием типа JSON.BETA_CH_OTEL_JSON_SCHEMA_ENABLED=true— включает поддержку в приложении HyperDX, позволяя выполнять запросы к данным JSON.
Для образа, содержащего только HyperDX, пользователям нужно лишь установить параметр BETA_CH_OTEL_JSON_SCHEMA_ENABLED=true, например:
