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

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

ClickHouse Supported

С помощью 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

Если вы используете самоуправляемый 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.

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