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

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

ClickHouse Supported

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

5. Далее​

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

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

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

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

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

Конфигурации и запросы из версии 3 переносятся в версию 4 по мере их открытия. Хотя старые конфигурации и панели будут загружаться в версии 4, миграция не сохраняется до тех пор, пока они не будут сохранены снова в новой версии. Если вы заметили какие-либо проблемы при открытии старой конфигурации/запроса,Discard your changes and report the issue on GitHub.

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

Связанное содержание​