Перейти к основному содержимому
Перейти к основному содержимому

Плагин источника данных ClickHouse для Grafana

С помощью Grafana вы можете исследовать и делиться всеми вашими данными через дашборды. Grafana требует плагин для подключения к ClickHouse, который легко устанавливается через их интерфейс.

1. Соберите ваши данные для подключения​

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

  • ХОСТ и ПОРТ: обычно, порт 9440 при использовании TLS или 9000 при отсутствии TLS.

  • ИМЯ БАЗЫ ДАННЫХ: по умолчанию есть база данных с именем default, используйте имя базы данных, к которой вы хотите подключиться.

  • ИМЯ ПОЛЬЗОВАТЕЛЯ и ПАРОЛЬ: по умолчанию имя пользователя default. Используйте имя пользователя, подходящее для вашего случая.

Данные для вашей службы ClickHouse Cloud доступны в консоли ClickHouse Cloud. Выберите службу, к которой вы хотите подключиться, и нажмите Подключиться:

Кнопка подключения к службе ClickHouse Cloud

Выберите Native, и данные будут доступны в примере команды clickhouse-client.

Детали подключения ClickHouse Cloud Native TCP

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

2. Создание пользователя только для чтения​

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

Grafana не проверяет, безопасны ли запросы. Запросы могут содержать любые SQL операторы, включая DELETE и INSERT.

Чтобы настроить пользователя только для чтения, выполните следующие шаги:

  1. Создайте профиль пользователя readonly, следуя руководству Создание пользователей и ролей в ClickHouse.
  2. Убедитесь, что у пользователя readonly достаточно прав для изменения настройки max_execution_time, необходимой для используемого клиента clickhouse-go.
  3. Если вы используете общую инстанцию ClickHouse, не рекомендуется устанавливать readonly=2 в профиле readonly. Вместо этого оставьте readonly=1 и установите тип ограничения для max_execution_time на changeable_in_readonly, чтобы разрешить изменение этой настройки.

3. Установить плагин ClickHouse для Grafana​

Перед подключением Grafana к ClickHouse вам необходимо установить соответствующий плагин Grafana. Предполагая, что вы вошли в Grafana, выполните следующие шаги:

  1. На странице Подключения в боковой панели выберите вкладку Добавить новое подключение.

  2. Найдите ClickHouse и нажмите на подписанный плагин от Grafana Labs:

    Выберите плагин ClickHouse на странице подключений

  3. На следующем экране нажмите кнопку Установить:

    Установка плагина ClickHouse

4. Определите источник данных ClickHouse​

  1. После завершения установки нажмите кнопку Добавить новый источник данных. (Также вы можете добавить источник данных на вкладке Источники данных на странице Подключения.)

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

  2. Либо прокрутите вниз и найдите тип источника данных ClickHouse, либо поищите его в строке поиска на странице Добавить источник данных. Выберите источник данных ClickHouse, и появится следующая страница:

Страница настройки подключения
  1. Введите настройки вашего сервера и учетные данные. Ключевые настройки:
  • Адрес хоста сервера: имя хоста вашего сервиса ClickHouse.
  • Порт сервера: порт для вашего сервиса ClickHouse. Будет отличаться в зависимости от конфигурации сервера и протокола.
  • Протокол: протокол, используемый для подключения к вашему сервису ClickHouse.
  • Безопасное соединение: включите, если ваш сервер требует безопасного соединения.
  • Имя пользователя и Пароль: введите ваши учетные данные пользователя ClickHouse. Если вы еще не настроили никаких пользователей, попробуйте default для имени пользователя. Рекомендуется настроить пользователя только для чтения.

Для получения дополнительных настроек ознакомьтесь с документацией по конфигурации плагина.

  1. Нажмите кнопку Сохранить и протестировать, чтобы убедиться, что Grafana может подключиться к вашему сервису ClickHouse. Если все прошло успешно, вы увидите сообщение Источник данных работает:

    Выберите Сохранить и протестировать

5. Следующие шаги​

Ваш источник данных теперь готов к использованию! Узнайте больше о том, как строить запросы с помощью конструктора запросов.

Для получения дополнительной информации о конфигурации ознакомьтесь с документацией по конфигурации плагина.

Если вы ищете дополнительную информацию, которая не включена в эту документацию, ознакомьтесь с репозиторием плагина на GitHub.

Обновление версий плагинов​

Начиная с версии 4, конфигурации и запросы могут быть обновлены по мере выпуска новых версий.

Конфигурации и запросы из версии 3 мигрируют в версию 4 по мере их открытия. Хотя старые конфигурации и дашборды будут загружаться в версии 4, миграция не сохраняется, пока они не будут снова сохранены в новой версии. Если вы заметили какие-либо проблемы при открытии старой конфигурации/запроса, отмените изменения и сообщите об этом на GitHub.

Плагин не может понизить версию до предыдущих версий, если конфигурация/запрос был создан с помощью более новой версии.

Связанный контент​