Встроено в ClickHouse

Использование ClickStack, встроенного в ClickHouse Server, — стек обсервабилити ClickHouse

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

​

Подходит для

• первого знакомства с ClickStack с минимальной настройкой
• изучения собственных данных ClickHouse через интерфейс обсервабилити
• демонстраций и оценки

​

Ограничения

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

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

​

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

Docker

1. ​

   Запустите 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
   
2. ​

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

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

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

3. ​

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

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

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

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

Бинарный файл

1. ​

   Запустите 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
   

   После этого, открыв ClickStack, вы сможете создать Log Source для system.query_log:

   Параметр	Значение
   Name	Журналы запросов
   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
   
2. ​

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

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

3. ​

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

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

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

​

Следующие шаги

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

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