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

ClickHouse Supported

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

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

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

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

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

Выберите Native; подробные данные будут доступны в примере команды 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. На странице Connections в боковой панели выберите вкладку Add new connection.

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

   

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

   

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

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

   

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

3. Введите настройки сервера и учетные данные. Основные параметры:

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

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

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

   

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

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

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

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

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

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

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

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