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

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

ClickHouse Supported

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

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

To connect to ClickHouse with native TCP you need this information:

  • The HOST and PORT: typically, the port is 9440 when using TLS, or 9000 when not using TLS.

  • The DATABASE NAME: out of the box there is a database named default, use the name of the database that you want to connect to.

  • The USERNAME and PASSWORD: out of the box the username is default. Use the username appropriate for your use case.

The details for your ClickHouse Cloud service are available in the ClickHouse Cloud console. Select the service that you will connect to and click Connect:

Choose Native, and the details are available in an example clickhouse-client command.

If you are using self-managed ClickHouse, the connection details are set by your ClickHouse administrator.

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, миграция не сохраняется до тех пор, пока они не будут снова сохранены в новой версии. Если вы заметили какие-либо проблемы при открытии старой конфигурации/запроса, отклоните ваши изменения и сообщите об ошибке на GitHub.

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

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