Конструктор запросов

Любой запрос можно выполнять с помощью плагина ClickHouse. Конструктор запросов — удобный вариант для простых запросов, но для сложных запросов потребуется редактор SQL.

Все запросы в конструкторе запросов имеют тип запроса, и для них нужно выбрать как минимум один столбец.

Доступны следующие типы запросов:

• Таблица: самый простой тип запроса для отображения данных в табличном виде. Подходит как универсальный вариант и для простых, и для сложных запросов с агрегатными функциями.
• Журналы: оптимизирован для построения запросов к журналам. Лучше всего работает в представлении Explore с настроенными параметрами по умолчанию.
• Временные ряды: лучше всего подходит для построения запросов временных рядов. Позволяет выбрать отдельный временной столбец и добавлять агрегатные функции.
• Трассировки: оптимизирован для поиска и просмотра трассировок. Лучше всего работает в представлении Explore с настроенными параметрами по умолчанию.
• редактор SQL: редактор SQL можно использовать, если вам нужен полный контроль над запросом. В этом режиме можно выполнять любые SQL-запросы.

Параметр Query Type изменяет компоновку конструктора запросов в зависимости от типа создаваемого запроса. Тип запроса также определяет, какая панель используется для визуализации данных.

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

Данные для этого типа запроса отображаются в виде таблицы.

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

Фильтры Время и Уровень добавляются по умолчанию вместе с ORDER BY для столбца Time. Эти фильтры привязаны к соответствующим полям и обновляются при изменении столбцов. Фильтр Уровень по умолчанию исключён из SQL; если изменить его значение с IS ANYTHING, он будет включён.

Тип запроса журналов поддерживает ссылки на данные.

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

Дополнительные столбцы, выбранные в запросе, можно просмотреть в раскрытой строке журнала:

Тип запроса для временных рядов похож на таблицу, но ориентирован на данные временных рядов.

Оба представления в целом одинаковы, за исключением следующих важных отличий:

• Отдельное поле время.
• В режиме Aggregate для поля время автоматически применяются макрос временного интервала и Group By.
• В режиме Aggregate поле "Columns" скрыто.
• Для поля время автоматически добавляются фильтр диапазона времени и Order By.

Этот тип запроса отображает данные на панели временных рядов.

Тип запроса Trace предоставляет конструктор запросов для удобного поиска и просмотра трассировок. Он предназначен для данных OpenTelemetry, но для отображения трассировок из другой схемы можно выбрать соответствующие столбцы. Значения по умолчанию можно настроить в конфигурации трассировок источника данных, чтобы конструктор запросов заранее загружался с базой данных, таблицей и столбцами по умолчанию. Если значения по умолчанию настроены, блок выбора столбцов по умолчанию будет свернут. Также можно включить OpenTelemetry, чтобы столбцы автоматически выбирались в соответствии с версией схемы.

Фильтры по умолчанию добавляются, чтобы показывать только спаны верхнего уровня. Также добавляется ORDER BY для столбцов Time и Duration Time. Эти фильтры привязаны к соответствующим полям и будут обновляться при изменении столбцов. Фильтр Service Name по умолчанию исключен из SQL; если изменить его значение с IS ANYTHING, он будет включен.

Тип запроса Trace поддерживает ссылки на данные.

Этот тип запроса отображает данные в виде таблицы в режиме Trace Search и на панели трассировки в режиме Trace ID.

Для запросов, которые слишком сложны для конструктора запросов, можно использовать редактор SQL. Он дает полный контроль над запросом, позволяя писать и выполнять запросы на обычном ClickHouse SQL.

Редактор SQL можно открыть, выбрав "Редактор SQL" в верхней части редактора запросов.

Макрофункции по-прежнему можно использовать в этом режиме.

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

В Grafana ссылки на данные можно использовать для перехода к новым запросам. Эта возможность доступна в плагине ClickHouse: она позволяет связывать трассировки с журналами и наоборот. Лучше всего она работает, когда OpenTelemetry настроен и для журналов, и для трассировок в конфигурации источника данных

Пример ссылок на трассировки в таблице

Пример ссылок на трассировки в журналах

Вы можете создать ссылку на данные, выбрав в запросе столбец с именем traceID. Для этого имени используется регистронезависимый поиск; также поддерживается добавление символа подчёркивания перед "ID". Например, traceId, TraceId, TRACE_ID и tracE_iD будут корректными вариантами.

Если OpenTelemetry включен в запросе журнала или трассировки, столбец с trace ID будет добавлен автоматически.

Если в данных есть столбец с trace ID, к ним будут добавлены ссылки "View Trace" и "View Logs".

Если настроены ссылки на данные, вы можете открывать трассировки и журналы по указанному trace ID.

"View Trace" откроет разделённую панель с трассировкой, а "View Logs" — запрос к журналам, отфильтрованный по trace ID. Если нажать ссылку на панели мониторинга, а не в разделе Explore, она откроется в новой вкладке раздела Explore.

Для перехода между типами запросов (из журналов в трассировки и из трассировок в журналы) должны быть настроены значения по умолчанию и для журналов, и для трассировок. Для открытия ссылки того же типа запроса значения по умолчанию не нужны, поскольку запрос можно просто скопировать.

Пример просмотра трассировки (справа) из запроса к журналам (слева)

Макросы — это простой способ добавить в запрос динамический SQL. Перед отправкой запроса на сервер ClickHouse плагин развернёт макрос и заменит его полным выражением.

Макросы можно использовать в запросах как из редактора SQL, так и из конструктора запросов.

Макросы можно использовать в любом месте запроса, при необходимости — несколько раз.

Вот пример использования макроса $__timeFilter:

Входные данные:

SELECT log_time, log_message
FROM logs
WHERE $__timeFilter(log_time)

Итоговый результат запроса:

SELECT log_time, log_message
FROM logs
WHERE log_time >= toDateTime(1415792726) AND log_time <= toDateTime(1447328726)

В этом примере временной диапазон панели мониторинга Grafana применяется к столбцу log_time.

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

Ниже приведён список всех макросов, доступных в плагине: