EXPLAIN и панель мониторинга
на основе таблиц system.
Перед началом работы
- Запустите LibreDB Studio в Docker (
docker run -p 3000:3000 ghcr.io/libredb/libredb-studio:latest) или с помощью Node.js 24 или более поздней версии (npx @libredb/studio), затем откройтеhttp://localhost:3000. При первом запуске пароль администратора выводится в журнал. - Убедитесь, что с машины, на которой запущена LibreDB Studio, доступен HTTP- или HTTPS-порт ClickHouse.
- Создайте пользователя ClickHouse с доступом к базам данных, к которым вы планируете выполнять запросы. Обозревателю баз данных
также требуются привилегии
SELECTнаsystem.dictionariesиsystem.data_skipping_indices, а такжеdictGetна каждую базу данных, содержащую словари. Для работы панели мониторинга выдайте привилегиюSELECTна таблицыsystem, перечисленные в разделе Мониторинг ClickHouse.
reader, который выполняет запросы к базе данных uk:
Как это работает
- Браузер отправляет оператор на сервер LibreDB Studio.
- Сервер передаёт его в ClickHouse в теле HTTP-запроса
POST /;default_format=JSONCompactи выбранная база данных передаются как параметры URL, а учётные данные — через базовую аутентификацию HTTP. - Сервер возвращает строки, типы столбцов, объявленные ClickHouse, и затраченное время, сообщённое ClickHouse. Каждый оператор выполняется как отдельный запрос без сохранения состояния; сеанс не закрепляется.
Подключение к самостоятельно размещённому ClickHouse
1
Соберите сведения о подключении
Вам понадобятся хост, HTTP-порт (по умолчанию
8123; либо HTTPS-порт, который использует ваш сервер, — обычно
8443), имя пользователя и пароль, а также при необходимости имя базы данных. Если база данных
в соединении не указана, используется default.2
Создайте подключение
- На боковой панели нажмите + (New connection).
- Выберите ClickHouse в качестве типа базы данных. В поле порта автоматически подставляется
8123. - Введите имя соединения, хост, порт, имя пользователя, пароль и при необходимости имя базы данных.
- Для HTTPS откройте SSL / TLS, выберите любой режим SSL, кроме
disable, и замените значение Port на HTTPS-порт вашего сервера (обычно8443). Во всех режимах, кромеdisable, сертификат сервера проверяется по CA, которым доверяет сервер LibreDB Studio, — именно это и описывает режимverify-system. Такой вариант подходит для ClickHouse Cloud и для серверов, сертификат которых выдан общепризнанным доверенным CA. О самоподписанных сертификатах и сертификатах частного CA см. раздел Устранение неполадок. - Нажмите Test Connection, затем Establish Connection.
clickhouse://localhost:8123/default или https://reader:secret@ch.example.com:8443/analytics.
URL со схемой https:// включает TLS.3
Выполните запрос
Откройте соединение, введите оператор в редакторе и выполните его. В обозревателе баз данных для каждой
базы данных отображаются таблицы, представления, materialized view, словари и пользовательские функции, а также
столбцы, столбцы первичного ключа, индексы пропуска данных и определения объектов.В этом примере используется набор данных UK Property Price.
Загрузите его в
uk.uk_price_paid, как описано в соответствующем руководстве, укажите uk в качестве базы данных соединения
и выполните:Мониторинг ClickHouse
Панель мониторинга считывает данные из следующих источников от имени пользователя, указанного в соединении:
Если у пользователя нет привилегии на одну из этих таблиц или
query_log отключён, соответствующая панель
просто остаётся пустой, не нарушая работу всей панели мониторинга. system.query_log сбрасывается на диск асинхронно, поэтому
только что завершившийся оператор может появиться в нём с задержкой в несколько секунд.
Кроме того, LibreDB Studio позволяет выполнить OPTIMIZE TABLE ... FINAL для таблицы, просмотреть сводку system.parts
по таблице или базе данных и остановить выполняемый запрос с помощью KILL QUERY ... SYNC. Для этих операций требуются
соответствующие привилегии.
Устранение неполадок
Соединение отклонено или истекло время ожидания
Соединение отклонено или истекло время ожидания
Запросы отправляет сервер LibreDB Studio, а не ваш браузер, поэтому хост должен быть доступен с
машины или из контейнера, где он запущен. Если LibreDB Studio работает в Docker, а ClickHouse — на
той же машине,
localhost указывает на контейнер, а не на хост. Убедитесь, что вы указали
HTTP-порт, а не порт собственного протокола 9000.HTTPS не работает с самоподписанным сертификатом или сертификатом частного центра сертификации
HTTPS не работает с самоподписанным сертификатом или сертификатом частного центра сертификации
Сервер LibreDB Studio работает на Node.js, который проверяет сертификат сервера по собственному
встроенному списку публичных CA. CA‑сертификат, вставленный в разделе SSL / TLS, игнорируется, а
одного лишь добавления CA в хранилище сертификатов операционной системы недостаточно. Запустите сервер
LibreDB Studio с переменной окружения
NODE_EXTRA_CA_CERTS, указав в ней путь к PEM-файлу
с вашим CA‑сертификатом или, если сертификат самоподписанный, с сертификатом самого сервера. При использовании Docker смонтируйте
файл в контейнер и передайте, например, -e NODE_EXTRA_CA_CERTS=/certs/ca.pem.Обозреватель баз данных не показывает объекты или словарь отображается как таблица
Обозреватель баз данных не показывает объекты или словарь отображается как таблица
Обозреватель баз данных читает
system.dictionaries, чтобы распределить объекты каждой базы данных по типам, а
system.data_skipping_indices — чтобы получить сведения о таблице. Без SELECT на system.dictionaries
список объектов не загружается, а без SELECT на system.data_skipping_indices не открываются сведения о
таблице. Словарь отображается среди таблиц, пока у пользователя нет dictGet на его базу данных.
Выдайте эти привилегии, как показано в разделе Перед началом работы, затем обновите обозреватель.Некоторые панели на панели мониторинга пусты
Некоторые панели на панели мониторинга пусты
Пользователь ClickHouse не может читать одну или несколько таблиц
system, перечисленных в разделе
Мониторинг ClickHouse. Выдайте SELECT на нужные таблицы и переподключитесь.Представление медленных запросов пусто
Представление медленных запросов пусто
Представление медленных запросов читает
system.query_log, куда ничего не записывается, пока логирование запросов выключено.
Включите настройку log_queries для пользователя, например в его профиле настроек, и выполните несколько
запросов. Новые записи появятся после сброса журнала, что может занять несколько секунд.
Если представление остаётся пустым, возможно, логирование запросов отключено для всего сервера, а не только для
пользователя. Убедитесь, что в конфигурации сервера есть раздел query_log, как описано в
system.query_log.Дальнейшие шаги
- Подробное описание работы см. в документации по провайдеру ClickHouse для LibreDB Studio.
- Сведения о конфигурации сервера см. в документации по HTTP-интерфейсу ClickHouse.