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

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

ClickHouse Supported

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

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

Для подключения к ClickHouse по протоколу native TCP вам потребуется следующая информация:

Параметр(ы)Описание
HOST и PORTОбычно используется порт 9440 при использовании TLS или 9000 при подключении без TLS.
DATABASE NAMEПо умолчанию существует база данных с именем default; используйте имя базы данных, к которой вы хотите подключиться.
USERNAME и PASSWORDПо умолчанию имя пользователя — default. Используйте имя пользователя, подходящее для вашего сценария.

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

Кнопка подключения сервиса ClickHouse Cloud

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

Сведения о подключении по Native TCP к ClickHouse Cloud

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

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

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

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

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

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

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

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

  1. На странице Connections в боковой панели выберите вкладку Add new connection.

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

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

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

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

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

  1. После завершения установки нажмите кнопку Add new data source. (Вы также можете добавить источник данных на вкладке Data sources на странице Connections.)

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

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

Страница настройки соединения
  1. Введите настройки сервера и учётные данные. Ключевые параметры:
  • Server host address: имя хоста вашего сервиса ClickHouse.
  • Server port: порт вашего сервиса ClickHouse. Может отличаться в зависимости от конфигурации сервера и протокола.
  • Protocol протокол, используемый для подключения к вашему сервису ClickHouse.
  • Secure connection включите, если ваш сервер требует защищённое соединение.
  • Username и Password: введите ваши учётные данные пользователя ClickHouse. Если вы не настроили пользователей, попробуйте default в качестве имени пользователя. Рекомендуется настроить пользователя только для чтения.

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

  1. Нажмите кнопку Save & test, чтобы проверить, может ли Grafana подключиться к вашему сервису ClickHouse. В случае успеха вы увидите сообщение Data source is working:

    Выбор Save & test

5. Дальнейшие шаги​

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

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

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

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

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

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

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