Начало работы с ClickStack с открытым исходным кодом

Начало работы с ClickStack с открытым исходным кодом

Чтобы развернуть ClickStack с открытым исходным кодом, где вы сами запускаете ClickHouse и интерфейс ClickStack и управляете ими, мы предоставляем готовые Docker-образы, которые объединяют интерфейс, OpenTelemetry Collector и ClickHouse в одном контейнере, — это упрощает запуск локальной разработки, тестирования и самоупляемых развертываний.

Также доступна управляемая версия ClickStack — см. Управляемый ClickStack.

Эти образы основаны на официальном Debian-пакете ClickHouse и доступны в нескольких вариантах дистрибуции для разных сценариев использования.

Самый простой вариант — дистрибутив с одним образом, в который входят все основные компоненты стека:

• Интерфейс HyperDX
• OpenTelemetry (OTel) Collector
• ClickHouse

Этот универсальный образ позволяет запустить весь стек одной командой, что делает его идеальным для тестирования, экспериментов или быстрого локального развертывания.

1. ​

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

   Следующая команда запустит OpenTelemetry Collector (на портах 4317 и 4318), интерфейс HyperDX (на порту 8080) и ClickHouse (8123).

   docker run --name clickstack -p 8123:8123 -p 8080:8080 -p 4317:4317 -p 4318:4318 clickhouse/clickstack-all-in-one:latest clickstack
   

   Обновление имени образа

   Образы ClickStack теперь публикуются как clickhouse/clickstack-* (ранее — docker.hyperdx.io/hyperdx/*).

   Сохранение данных и настроек

   Чтобы сохранять данные и настройки между перезапусками контейнера, вы можете изменить приведённую выше команду Docker и смонтировать пути /data/db, /var/lib/clickhouse и /var/log/clickhouse-server.

   Например:

   # измените команду, чтобы смонтировать пути
   docker run \
     --name clickstack \
     -p 8123:8123 \
     -p 8080:8080 \
     -p 4317:4317 \
     -p 4318:4318 \
     -v "$(pwd)/.volumes/db:/data/db" \
     -v "$(pwd)/.volumes/ch_data:/var/lib/clickhouse" \
     -v "$(pwd)/.volumes/ch_logs:/var/log/clickhouse-server" \
     clickhouse/clickstack-all-in-one:latest
   
2. ​

   Перейдите в интерфейс ClickStack

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

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

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

3. ​

   Изучите продукт

   После развертывания стека попробуйте один из наших примеров датасетов.

   Чтобы продолжить работу с локальным кластером:

   • Пример датасета - Загрузите пример датасета из нашего публичного демо. Диагностируйте простую проблему.
   • Локальные файлы и метрики - Загружайте локальные файлы и отслеживайте систему в OSX или Linux с помощью локального OpenTelemetry Collector.

   
   

   Либо вы можете подключиться к демо-кластеру, где можно изучить более крупный датасет:

   • Удалённый демонстрационный датасет - Изучите демонстрационный датасет в нашем демо-сервисе ClickHouse.

​

Альтернативные модели развертывания

​

Локальный режим

Локальный режим позволяет развернуть HyperDX без аутентификации.

Аутентификация не поддерживается.

Этот режим предназначен для быстрого тестирования, разработки, демо и отладки, когда аутентификация и сохранение настроек не нужны.

Подробнее об этой модели развертывания см. в разделе “Только локальный режим”.

​

Хостируемая версия

Вы можете использовать хостируемую версию ClickStack в локальном режиме; она доступна по адресу play-clickstack.clickhouse.com.

​

Самоуправляемая версия

1. ​

   Запуск с помощью Docker

   Локальный образ для самоуправляемого развертывания уже включает настроенные OpenTelemetry Collector, интерфейс ClickStack и сервер ClickHouse. Благодаря этому можно легко получать телеметрические данные из ваших приложений и визуализировать их с минимальной дополнительной настройкой. Чтобы начать работу с самоуправляемой версией, просто запустите Docker-контейнер с пробросом соответствующих портов:

   docker run -p 8080:8080 clickhouse/clickstack-local:latest
   

   В отличие от образа “Все в одном”, вам не будет предложено создать пользователя, так как локальный режим не включает аутентификацию.

2. ​

   Укажите учетные данные для подключения

   Чтобы подключиться к своему внешнему кластеру ClickHouse, можно вручную ввести учетные данные для подключения.

   Кроме того, для быстрого знакомства с продуктом можно нажать Подключиться к демо-серверу, чтобы получить доступ к предзагруженным датасетам и попробовать ClickStack без какой-либо настройки.

   При подключении к демо-серверу вы можете изучить датасет, следуя инструкциям по демо-набору данных.