Проще всего изменить конфигурацию в интерфейсе Grafana на странице конфигурации плагина, но источники данных также можно настроить с помощью YAML-файла.
На этой странице приведён список параметров, доступных для настройки в плагине ClickHouse, а также фрагменты конфигурации для тех, кто настраивает источник данных с помощью YAML.
Краткий обзор всех параметров и полный список опций конфигурации можно найти здесь.
Экран с примером конфигурации:
Пример YAML-конфигурации для общих настроек:
Обратите внимание, что при сохранении конфигурации из интерфейса добавляется свойство version. Оно показывает версию плагина, с которой была сохранена конфигурация.
Если выбрать подключение по HTTP-протоколу, отобразятся дополнительные настройки.
Если ваш HTTP-сервер доступен по другому URL-пути, укажите его здесь.
Вы можете добавлять пользовательские заголовки в запросы, отправляемые на сервер.
Заголовки могут быть либо обычным текстом, либо защищёнными.
Все имена заголовков хранятся в открытом виде, а защищённые значения заголовков сохраняются в защищённой конфигурации (аналогично полю password).
Защищённые значения по HTTPХотя защищённые значения заголовков безопасно хранятся в конфигурации, само значение всё равно будет передаваться по HTTP, если защищённое соединение отключено.
Пример YAML для обычных и защищённых заголовков:
Эти настройки необязательны.
Пример YAML:
OpenTelemetry (OTel) тесно интегрирован в плагин.
Данные OpenTelemetry можно экспортировать в ClickHouse с помощью нашего плагина-экспортёра.
Для оптимальной работы рекомендуется настроить OTel и для журналов, и для трассировок.
Также необходимо настроить эти значения по умолчанию, чтобы включить ссылки на данные — функцию, которая обеспечивает мощные сценарии обсервабилити.
Чтобы ускорить построение запросов к журналам, можно задать базу данных и таблицу по умолчанию, а также столбцы для запроса к журналам. Это позволит заранее загрузить в конструктор запросов готовый к выполнению запрос к журналам, что ускорит просмотр на странице Explore в сценариях обсервабилити.
Если вы используете OpenTelemetry, включите переключатель “Use OTel” и задайте таблицу журналов по умолчанию — otel_logs.
Это автоматически заменит столбцы по умолчанию в соответствии с выбранной версией схемы OTel.
Хотя OpenTelemetry не обязателен для журналов, использование единого набора данных для журналов и трассировки помогает выстроить более удобный процесс обсервабилити с связыванием данных.
Пример экрана конфигурации журналов:
Пример YAML-конфигурации журналов:
Чтобы ускорить построение запросов для трассировки, можно задать базу данных и таблицу по умолчанию, а также столбцы для запроса трассировки. Это позволит заранее загрузить в конструктор запросов готовый к выполнению поисковый запрос по трассировке, что ускорит просмотр данных на странице Explore для задач обсервабилити.
Если вы используете OpenTelemetry, следует включить переключатель “Use OTel” и задать таблицу трассировки по умолчанию otel_traces.
Это автоматически заменит столбцы по умолчанию в соответствии с выбранной версией схемы OTel.
Хотя OpenTelemetry не обязателен, эта возможность лучше всего работает при использовании его схемы для трассировки.
Пример экрана конфигурации трассировки:
Пример YAML-конфигурации трассировки:
Псевдонимы столбцов — это удобный способ выполнять запросы к данным, используя другие имена и типы.
С их помощью можно преобразовать вложенную схему в плоскую, чтобы в Grafana было проще выбирать нужные поля.
Псевдонимы могут быть полезны, если:
- Вы знаете свою схему и большинство её вложенных свойств/типов
- Вы храните данные в типе Map
- Вы храните JSON в виде строк
- Вы часто применяете функции для преобразования выбираемых столбцов
ALIAS-столбцы, заданные в таблице
ClickHouse изначально поддерживает псевдонимы столбцов и сразу работает с Grafana.
ALIAS-столбцы можно задавать прямо в таблице.
В приведённом выше примере мы создаём псевдоним TimestampDate, который преобразует временную метку с точностью до наносекунд в тип Date.
Эти данные, в отличие от первого столбца, не хранятся на диске, а вычисляются во время выполнения запроса.
Псевдонимы, определённые на уровне таблицы, не возвращаются при SELECT *, но это можно настроить в настройках сервера.
Подробнее см. в документации по типу столбца ALIAS.
Таблицы псевдонимов столбцов
По умолчанию Grafana предлагает столбцы на основе ответа на DESC table.
В некоторых случаях может потребоваться полностью переопределить столбцы, которые видит Grafana.
Это помогает скрыть схему в Grafana при выборе столбцов, что, в зависимости от сложности таблицы, может улучшить пользовательский опыт.
Преимущество этого подхода перед псевдонимами, заданными в самой таблице, в том, что их можно легко обновлять без изменения таблицы. В некоторых схемах это может насчитывать тысячи записей, что может загромождать определение исходной таблицы. Кроме того, это позволяет скрыть столбцы, которые пользователь должен игнорировать.
Grafana требует, чтобы таблица псевдонимов имела следующую структуру столбцов:
Вот как можно воспроизвести поведение столбца ALIAS с помощью таблицы псевдонимов:
Затем эту таблицу можно настроить для использования в Grafana. Обратите внимание, что имя может быть любым и даже может быть задано в отдельной базе данных:
Теперь Grafana будет видеть результаты таблицы псевдонимов вместо результатов DESC example_table:
Оба типа использования псевдонимов можно применять для сложных преобразований типов или извлечения полей JSON.
Ниже приведены все параметры конфигурации YAML, доступные в этом плагине.
Для некоторых полей указаны примеры значений, а для других — только тип поля.
Дополнительные сведения о настройке источников данных с помощью YAML см. в документации Grafana.
Последнее изменение 29 июня 2026 г.