Подключение Superset к ClickHouse

Apache Superset — платформа с открытым исходным кодом для анализа и визуализации данных.

Apache Superset — это платформа с открытым исходным кодом для анализа и визуализации данных, написанная на Python. Superset подключается к ClickHouse с помощью Python-драйвера от ClickHouse. Давайте посмотрим, как это работает…

​

Цель

В этом руководстве вы создадите панель мониторинга в Superset на основе данных из базы данных ClickHouse. Панель мониторинга будет выглядеть так:

Добавьте данные

Если у вас нет датасета для работы, вы можете добавить один из примеров. В этом руководстве используется датасет UK Price Paid, поэтому можно выбрать именно его. В этом же разделе документации есть и другие варианты.

​

1. Подготовьте сведения о подключении

Чтобы подключиться к ClickHouse по HTTP(S), вам понадобится следующая информация:

Параметр(ы)	Описание
HOST and PORT	Обычно используется порт 8443 при использовании TLS и 8123 без TLS.
DATABASE NAME	По умолчанию есть база данных default; используйте имя базы данных, к которой хотите подключиться.
USERNAME and PASSWORD	По умолчанию имя пользователя — default. Используйте имя пользователя, подходящее для вашего сценария использования.

Сведения о подключении для вашего сервиса ClickHouse Cloud доступны в консоли ClickHouse Cloud. Выберите сервис и нажмите Connect:

Выберите HTTPS. Сведения о подключении будут показаны в примере команды curl.

Если вы используете самоуправляемый ClickHouse, сведения о подключении задаёт ваш администратор ClickHouse.

​

2. Установите драйвер

1. Superset использует драйвер clickhouse-connect для подключения к ClickHouse. Подробнее о clickhouse-connect см. на странице https://pypi.org/project/clickhouse-connect/. Установить его можно следующей командой:

   pip install clickhouse-connect
   

Настройка Docker Compose

Для установок на базе Docker см. руководство по настройке базы данных в Superset, где описано, как добавить clickhouse-connect в контейнер.

2. Запустите (или перезапустите) Superset.

​

3. Подключите Superset к ClickHouse

1. В Superset выберите Data в верхнем меню, затем в раскрывающемся списке — Databases. Чтобы добавить новую базу данных, нажмите кнопку + Database:

2. На первом шаге выберите ClickHouse Connect в качестве типа базы данных:

3. На втором шаге:

• Включите или отключите SSL.
• Введите сведения о подключении, которые вы собрали ранее.
• Укажите DISPLAY NAME: это может быть любое имя на ваш выбор. Если вы планируете подключаться к нескольким базам данных ClickHouse, задайте более описательное имя.

4. Нажмите кнопки CONNECT, а затем FINISH, чтобы завершить мастер настройки. После этого база данных появится в списке.

​

4. Добавьте датасет

1. Чтобы работать с данными ClickHouse в Superset, необходимо создать датасет. В верхнем меню Superset выберите Data, затем в раскрывающемся списке — Datasets.

2. Нажмите кнопку добавления датасета. Выберите свою новую базу данных в качестве источника данных — после этого вы увидите таблицы, созданные в этой базе данных:

3. Нажмите кнопку ADD в нижней части диалогового окна, и таблица появится в списке датасетов. Теперь можно создать панель мониторинга и приступить к анализу данных ClickHouse!

​

5. Создание диаграмм и панели мониторинга в Superset

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

1. Начните с панели мониторинга. В верхнем меню Superset выберите Dashboards. Нажмите кнопку в правом верхнем углу, чтобы добавить новую панель мониторинга. На следующем примере панель мониторинга называется UK property prices:

2. Чтобы создать новую диаграмму, выберите Charts в верхнем меню и нажмите кнопку добавления новой диаграммы. Вам будет доступно множество вариантов. В следующем примере показана диаграмма Pie Chart, использующая dataset uk_price_paid из выпадающего списка CHOOSE A DATASET:

3. Для круговых диаграмм в Superset требуются Dimension и Metric, остальные настройки необязательны. Вы можете выбрать свои поля для размерности и метрики; в этом примере в качестве размерности используется поле ClickHouse district, а в качестве метрики — AVG(price).

5. Если вы предпочитаете кольцевые диаграммы круговым, этот и другие параметры можно задать в разделе CUSTOMIZE:

6. Нажмите кнопку SAVE, чтобы сохранить диаграмму, затем выберите UK property prices в выпадающем списке ADD TO DASHBOARD, после чего нажмите SAVE & GO TO DASHBOARD — диаграмма будет сохранена и добавлена на панель мониторинга:

7. Вот и всё. Создание панелей мониторинга в Superset на основе данных из ClickHouse открывает целый мир невероятно быстрой аналитики данных!