Встроенный в ClickHouse

ClickStack встроен непосредственно в бинарный файл сервера ClickHouse. Это означает, что вы можете получить доступ к пользовательскому интерфейсу ClickStack (HyperDX) из своего экземпляра ClickHouse без развертывания каких-либо дополнительных компонентов. Такое развертывание аналогично публичной демонстрации на play-clickstack.clickhouse.com, но работает с вашим собственным экземпляром ClickHouse и вашими данными.

Подходит для

• Быстрого знакомства с ClickStack с минимальными настройками
• Исследования собственных данных ClickHouse в интерфейсе обсервабилити
• Демонстраций и оценки решений

Ограничения

Эта встраиваемая версия не предназначена для использования в продакшене. По сравнению с готовыми к продакшену OSS-развертываниями в ней недоступны следующие возможности:

• Оповещения
• Сохранение дашбордов и поиска — дашборды и сохранённые поисковые запросы не сохраняются между сессиями
• Настраиваемые параметры запросов
• Шаблоны событий

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

Docker

Запустите ClickHouse

Скачайте и запустите образ сервера ClickHouse с заданным паролем:

docker run --rm -it -p 8123:8123 -e CLICKHOUSE_PASSWORD=password clickhouse/clickhouse-server:head-alpine

Запуск без пароля

Если вы предпочитаете запускать без пароля, необходимо явно включить управление доступом по умолчанию:

docker run --rm -it -p 8123:8123 -e CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT=1 clickhouse/clickhouse-server:head-alpine

Откройте интерфейс ClickStack

Откройте http://localhost:8123 в браузере и нажмите ClickStack.

Введите имя пользователя default и пароль password, чтобы подключиться к локальному экземпляру.

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

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

При новой установке вам будет предложено создать источник. Заполните поле Table соответствующим именем таблицы (например, otel_logs) и нажмите Save New Source.

Если у вас ещё нет данных, см. раздел Ingesting data для доступных вариантов.

Binary

Запустите ClickHouse

Скачайте и запустите ClickHouse:

curl https://clickhouse.com/ | sh

Необязательно: включите системные таблицы логов

Чтобы исследовать внутренние логи и метрики самого ClickHouse, создайте конфигурационный фрагмент в рабочем каталоге перед запуском сервера:

mkdir -p config.d && cat > config.d/query_logs.xml << 'EOF'
<clickhouse>
    <query_log>
        <database>system</database>
        <table>query_log</table>
    </query_log>
    <query_thread_log>
        <database>system</database>
        <table>query_thread_log</table>
    </query_thread_log>
    <query_views_log>
        <database>system</database>
        <table>query_views_log</table>
    </query_views_log>
    <metric_log>
        <database>system</database>
        <table>metric_log</table>
    </metric_log>
    <asynchronous_metric_log>
        <database>system</database>
        <table>asynchronous_metric_log</table>
    </asynchronous_metric_log>
</clickhouse>
EOF

После этого вы можете создать Log Source, указывающий на system.query_log, после открытия ClickStack:

Setting	Value
Name	Query Logs
Database	system
Table	query_log
Timestamp Column	event_time
Default Select	event_time, query_kind, query, databases, tables, initial_user, projections, memory_usage, written_rows, read_rows, query_duration_ms

Запустите сервер:

./clickhouse server

Откройте интерфейс ClickStack

Откройте http://localhost:8123 в браузере и нажмите ClickStack. Подключение к локальному экземпляру создаётся автоматически.

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

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

Если у вас ещё нет данных, см. раздел Ingesting data для доступных вариантов.

Дальнейшие шаги

Если вы готовы перейти от оценки к эксплуатации, рассмотрите готовые к продакшену варианты развертывания:

• All-in-One — один контейнер со всеми компонентами, включая хранилище данных и аутентификацию
• Docker Compose — отдельные компоненты для более точного контроля
• Helm — рекомендуемый вариант для production-развертывания в Kubernetes
• Managed ClickStack — полностью управляемый вариант в ClickHouse Cloud