Содержание
Параметры виджетов
Этот раздел содержит описание параметров всех доступных в KUMA виджетов.
Виджет "События"
Вы можете использовать виджет События для получения необходимой аналитики на основе SQL-запросов.
При создании этого виджета вам требуется указать значения для следующих параметров:
Вкладка :
- График – тип графика. Доступны следующие типы графиков:
- Круговая диаграмма.
- Столбчатая диаграмма.
- Счетчик.
- Линейная диаграмма.
- Таблица.
- Календарная диаграмма.
Тенант – тенант, по которому отображаются данные на виджете. Вы можете выбрать несколько тенантов. По умолчанию данные отображаются по тенантам, которые вы выбрали в параметрах макета.
- Период – период, за который отображаются данные на виджете. Доступны следующие периоды:
- Как на макете – отображаются данные за период, выбранный для макета. Значение по умолчанию.
- 1 час – отображаются данные за предыдущий час.
- 1 день – отображаются данные за предыдущий день.
- 7 дней – отображаются данные за предыдущие 7 дней.
- 30 дней – отображаются данные за предыдущие 30 дней.
- В течение периода – отображаются данные за выбранный период времени. При выборе этого варианта в открывшемся календаре выберите дату начала и окончания периода и нажмите Применить фильтр. Формат даты и времени зависит от настроек вашей операционной системы. При необходимости вы можете изменить значения даты вручную.
Верхняя граница периода не включается в определяемый с ее помощью отрезок времени. Это означает, что, например, для получения аналитики за сутки следует настроить период <День 1>, 00:00:00 – <День 2>, 00:00:00, а не <День 1>, 00:00:00 – <День 1>, 23:59:59.
- Показывать данные за предыдущий период – включение отображения данных сразу за два периода: за текущий и за предыдущий.
- Хранилище – хранилище, в котором выполняется поиск событий.
- Поле SQL-запроса (
) – запрос для фильтрации и поиска событий вручную. Вы можете составить запрос в конструкторе запросов, нажав на кнопку
.
Как создать запрос в конструкторе запросов
Пример условий поиска в конструкторе запросов
Существуют следующие ограничения:
- Псевдонимы
metric
иvalue
в SQL-запросах недоступны для изменения для всех типов виджета с аналитикой по событиям, кроме таблиц. - Псевдонимы в виджетах типа Таблица могут содержать латинские и кириллические символы, а также пробелы. При использовании пробелов или кириллицы псевдоним необходимо выделять кавычками:
"Псевдоним с пробелом"
,`Другой псевдоним`
. - Не поддерживается использование SQL-запроса
ARRAY JOIN
. - При отображении данных за предыдущий период сортировка по параметру
count(ID)
может работать неправильно. Мы рекомендуем использовать сортировку по параметруmetric
. Например,SELECT count(ID) AS "metric", Name AS "value" FROM `events` GROUP BY Name ORDER BY metric ASC LIMIT 250
. - В виджетах типа Счетчик для значений функции
SELECT
требуется указывать способ обработки данных:count
,max
,min
,avg
,sum
.
- Псевдонимы
Вкладка :
Вкладка отображается, если на вкладке в поле График вы выбрали одно из следующих значений: Столбчатая диаграмма, Линейная диаграмма, Календарная диаграмма.
- Минимальное значение Y и Максимальное значение Y – масштаб оси Y.
- Минимальное значение X и Максимальное значение X – масштаб оси X.
На осях графиков могут отображаться отрицательные значения. Это связано с масштабированием графиков на виджете и может быть исправлено выставлением нуля в качестве минимальных значений графиков вместо Авто.
- Толщина линии – толщина линии на графике. Поле отображается для типа графика "Линейная диаграмма".
- Размер указателя – размер указателя на графике. Поле отображается для типа графика "Линейная диаграмма".
Вкладка :
- Название – название виджета.
- Описание – описание виджета.
- Цвет – цвет отображения информации:
- по умолчанию – цвет шрифта, который используется в вашем браузере по умолчанию;
- зеленый;
- красный;
- синий;
- желтый.
- Горизонтальный – использование горизонтальной гистограммы вместо вертикальной.
При включении этого параметра горизонтальная прокрутка при большом количестве данных не будет отображаться и вся имеющаяся информация будет отражена в заданном размере виджета. Если данных для отображения много, рекомендуется увеличить размер виджета.
- Итоговые значения – суммы значений.
- Легенда – легенда для аналитики. По умолчанию переключатель включен.
Пустые значения в легенде – отображение параметров с нулевым значением в легенде для аналитики. По умолчанию переключатель выключен.
- Десятичные знаки – количество десятичных знаков, до которых отображаемое значение должно быть округлено.
- Длительность отрезков периода (доступно для графика типа Календарная диаграмма) – длительность отрезков, на которые требуется делить период.
Виджет "Активные листы"
Вы можете использовать виджет Активные листы для получения аналитики на основе SQL-запросов.
При создании этого виджета вам требуется указать значения для следующих параметров:
Вкладка :
- График – тип графика. Доступны следующие типы графиков:
- Столбчатая диаграмма.
- Круговая диаграмма.
- Счетчик.
- Таблица.
Тенант – тенант, по которому отображаются данные на виджете. Вы можете выбрать несколько тенантов. По умолчанию данные отображаются по тенантам, которые вы выбрали в параметрах макета.
- Коррелятор – название коррелятора, содержащего активный лист, по которому вы хотите получать данные.
- Активный лист – название активного листа, по которому вы хотите получать данные.
Один и тот же активный лист может использоваться в разных корреляторах. При этом для каждого коррелятора создается своя сущность активного листа. Таким образом, содержимое активных листов, используемых разными корреляторами, различается, даже если идентификатор и название активных листов одинаковые.
- Поле SQL-запроса – в этом поле вы можете ввести запрос для фильтрации и поиска данных активного листа вручную.
Структура запроса аналогична той, которая используется при поиске событий.
При создании запроса по активным листам вам нужно учитывать следующие особенности:
- Для функции FROM требуется указать значение `records`.
- Если вы хотите получать данные по полям, названия которых содержат пробелы и символы кириллицы, в запросе такие названия требуется выделять кавычками:
- в функции SELECT псевдонимы следует выделять двойными или косыми кавычками: "псевдоним", `другой псевдоним`;
- в функции ORDER BY псевдонимы следует выделять косыми кавычками: `другой псевдоним`;
- значения полей событий выделяются прямыми кавычками: WHERE DeviceProduct = 'Microsoft';
Название полей событий выделять кавычками не требуется.
Если название поля активного листа начинается или заканчивается пробелами, в виджете эти пробелы не отображаются. Название поля не должно состоять только из пробелов.
Если значения полей активного листа могут содержать пробелы в конце или в начале, поиск по ним рекомендуется осуществлять с помощью функции LIKE '%значение поля%'.
- Вы можете использовать в запросе служебные поля _key (поле с ключами записей активного листа) и _count (сколько раз эта запись была добавлена в активный лист), а также пользовательские поля.
- Псевдонимы metric и value в SQL-запросах недоступны для изменения для всех типов виджета с аналитикой по активным листам, кроме таблиц.
- Если в SQL-запросе используется функция преобразования даты и времени (например, fromUnixTimestamp64Milli) и при этом обрабатываемое поле не содержит даты и времени, в виджете будет отображаться ошибка. Чтобы избежать этого, используйте функции, которые могут обрабатывать нулевое значение. Пример: SELECT _key, fromUnixTimestamp64Milli(toInt64OrNull(DateTime)) as Date FROM `records` LIMIT 250.
- Если задать большие значения для функции LIMIT, это может привести к ошибкам в работе браузера.
- Если в качестве типа графика вы выбрали Счетчик, необходимо для значений функции SELECT указывать способ обработки данных: count, max, min, avg, sum.
- Вы можете получать в виджете названия тенантов, а не их идентификаторы.
Особенности использования псевдонимов в SQL-функциях: и SELECT допустимо использовать двойные и косые кавычки: ", `.
Если в качестве типа графика вы выбрали Счетчик, псевдонимы могут содержать латинские и кириллические символы, а также пробелы. При использовании пробелов или кириллицы псевдоним необходимо выделять кавычками: "Псевдоним с пробелом", `Другой псевдоним`.
При отображении данных за предыдущий период сортировка по параметру count(ID) может работать некорректно. Рекомендуется использовать сортировку по параметру metric. Например, SELECT count(ID) AS "metric", Name AS "value" FROM `events` GROUP BY Name ORDER BY metric ASC LIMIT 250.
Примеры запросов для получения аналитики по активным листам:
SELECT * FROM `records` WHERE "Источник событий" = 'Екатеринбург' LIMIT 250
Запрос, который возвращает ключ активного листа с названием поля "Источник событий" и значением этого поля "Екатеринбург".
SELECT count(_key) AS metric, Status AS value FROM `records` GROUP BY value ORDER BY metric DESC LIMIT 250
Запрос для круговой диаграммы, который возвращает количество ключей активного листа (агрегация count по полю _key) и все варианты значений пользовательского поля Status. В виджете отображается круговая диаграмма с общим количеством записей активного листа, пропорционально разделенным на количество вариантов значений поля Status.
SELECT Name, Status, _count AS Number FROM `records` WHERE Description ILIKE '%ftp%' ORDER BY Name DESC LIMIT 250
Запрос для таблицы, которая возвращает значения пользовательских полей Name и Status, а также служебного поля _count у тех записей активного листа, в которых значения пользовательского поля Description соответствует запросу ILIKE '%ftp%'. В виджете отображается таблица со столбцами Status, Name и Number.
Вкладка :
Вкладка отображается, если на вкладке в поле График вы выбрали значение Столбчатая диаграмма.
- Минимальное значение Y и Максимальное значение Y – масштаб оси Y.
- Минимальное значение X и Максимальное значение X – масштаб оси X.
На осях графиков могут отображаться отрицательные значения. Это связано с масштабированием графиков на виджете и может быть исправлено выставлением нуля в качестве минимальных значений графиков вместо Авто.
Вкладка :
- Название – название виджета.
- Описание – описание виджета.
- Цвет – цвет отображения информации:
- по умолчанию – цвет шрифта, который используется в вашем браузере по умолчанию;
- зеленый;
- красный;
- синий;
- желтый.
- Горизонтальный – использование горизонтальной гистограммы вместо вертикальной.
При включении этого параметра вся имеющаяся информация будет отражена в заданном размере виджета. Если данных много, Вы можете увеличить размер виджета для их оптимального отображения.
- Итоговые значения – суммы значений.
- Легенда – легенда для аналитики. По умолчанию переключатель включен.
Пустые значения в легенде – отображение параметров с нулевым значением в легенде для аналитики. По умолчанию переключатель выключен.
Виджет "Контекстные таблицы"
Вы можете использовать виджет Контекстные таблицы для получения аналитики на основе SQL-запросов.
При создании этого виджета вам требуется указать значения для следующих параметров:
Вкладка :
- График – тип графика. Доступны следующие типы графиков:
- Столбчатая диаграмма.
- Круговая диаграмма.
- Счетчик.
- Таблица.
Тенант – тенант, по которому отображаются данные на виджете. Вы можете выбрать несколько тенантов. По умолчанию данные отображаются по тенантам, которые вы выбрали в параметрах макета.
- Коррелятор – название коррелятора, содержащего контекстную таблицу, по которой вы хотите получать данные.
- Контекстная таблица – название контекстной таблицы, по которой вы хотите получать данные.
Одна и та же контекстная таблица может использоваться в разных корреляторах. При этом для каждого коррелятора создается своя сущность контекстной таблицы. Таким образом, содержимое контекстных таблиц, используемых разными корреляторами, различается, даже если идентификатор и название контекстных таблиц одинаковые.
- Поле SQL-запроса – в этом поле вы можете ввести запрос для фильтрации и поиска данных контекстной таблицы вручную. По умолчанию для каждого типа графика в поле указан запрос, который получает схему контекстной таблицы и ключ по ключевым полям.
Структура запроса аналогична той, которая используется при поиске событий.
При создании запроса по контекстным таблицам вам нужно учитывать следующие особенности:
- Для функции
FROM
требуется указать значение`records`
. - Вы можете получить данных только по полям, указанным в схеме контекстной таблицы.
- Вы можете использовать поддерживаемые функции ClickHouse.
- Если вы хотите получать данные по полям, названия которых содержат пробелы и символы кириллицы, в запросе такие названия требуется выделять кавычками:
- в функции
SELECT
псевдонимы следует выделять двойными или косыми кавычками:"<
псевдоним
>"
,`<
другой псевдоним
>`
; - в функции
ORDER BY
псевдонимы следует выделять косыми кавычками:`<
другой псевдоним
>`
; - значения полей событий выделяются прямыми кавычками:
WHERE DeviceProduct = 'Microsoft'
;
Название полей событий выделять кавычками не требуется.
Если название поля активного листа начинается или заканчивается пробелами, в виджете эти пробелы не отображаются. Название поля не должно состоять только из пробелов.
Если значения полей активного листа могут содержать пробелы в конце или в начале, поиск по ним рекомендуется осуществлять с помощью функции
LIKE '%<
значение поля
>%'
. - в функции
- Вы можете использовать в запросе служебное поле
_count
(сколько раз эта запись была добавлена в контекстную таблицу), а также пользовательские поля. - Псевдонимы
metric
иvalue
в SQL-запросах недоступны для изменения для всех типов виджета с аналитикой по активным листам, кроме таблиц. - Если в SQL-запросе используется функция преобразования даты и времени (например,
fromUnixTimestamp64Milli
) и при этом обрабатываемое поле не содержит даты и времени, в виджете будет отображаться ошибка. Чтобы избежать этого, используйте функции, которые могут обрабатывать нулевое значение. Пример:SELECT _key,
fromUnixTimestamp64Milli(toInt64OrNull(DateTime)) as Date FROM `records` LIMIT 250
. - Если задать большие значения для функции
LIMIT
, это может привести к ошибкам в работе браузера. - Если в качестве типа графика вы выбрали Счетчик, необходимо для значений функции
SELECT
указывать способ обработки данных:count
,max
,min
,avg
,sum
. - Вы можете получать в виджете названия тенантов, а не их идентификаторы.
Особенности использования псевдонимов в SQL-функциях и
SELECT
: допустимо использовать двойные и косые кавычки: ",`
.
При использовании пробелов или кириллицы псевдоним необходимо выделять кавычками:"<
Псевдоним с пробелом
>"
, значения следует выделять прямыми одинарными кавычками:'<
Значение с пробелом
>'
.
При отображении данных за предыдущий период сортировка по параметруcount(ID)
может работать неправильно. Рекомендуется использовать сортировку по параметруmetric
. Например,SELECT count(ID) AS "metric"
,Name AS "value" FROM `events` GROUP BY Name ORDER BY metric ASC LIMIT 250
.Примеры запросов для получения аналитики по активным листам:
SELECT * FROM `records` WHERE "Источник событий" = 'Екатеринбург' LIMIT 250
Запрос, который возвращает ключ активного листа с названием поля
"Источник событий"
и значением этого поля"Екатеринбург"
.SELECT count(_key) AS metric, Status AS value FROM `records` GROUP BY value ORDER BY metric DESC LIMIT 250
Запрос для круговой диаграммы, который возвращает количество ключей активного листа (агрегация
count
по полю_key
) и все варианты значений пользовательского поляStatus
. В виджете отображается круговая диаграмма с общим количеством записей активного листа, пропорционально разделенным на количество вариантов значений поляStatus
.SELECT Name, Status, _count AS Number FROM `records` WHERE Description ILIKE '%ftp%' ORDER BY Name DESC LIMIT 250
Запрос для таблицы, которая возвращает значения пользовательских полей
Name
иStatus
, а также служебного поля_count
у тех записей активного листа, в которых значения пользовательского поляDescription
соответствует запросуILIKE '%ftp%'
. В виджете отображается таблица со столбцамиStatus
,Name
иNumber
.
- Для функции
Вкладка :
Вкладка отображается, если на вкладке в поле График вы выбрали значение Столбчатая диаграмма.
- Минимальное значение Y и Максимальное значение Y – масштаб оси Y.
- Минимальное значение X и Максимальное значение X – масштаб оси X.
- На осях графиков могут отображаться отрицательные значения. Это связано с масштабированием графиков на виджете и может быть исправлено выставлением нуля в качестве минимальных значений графиков вместо Авто.
Вкладка :
- Название – название виджета.
- Описание – описание виджета.
- Цвет – цвет отображения информации:
- по умолчанию – цвет шрифта, который используется в вашем браузере по умолчанию;
- зеленый;
- красный;
- синий;
- желтый.
- Горизонтальный – использование горизонтальной гистограммы вместо вертикальной.
При включении этого параметра вся имеющаяся информация будет отражена в заданном размере виджета. Если данных много, вы можете увеличить размер виджета для оптимального отображения.
- Итоговые значения – суммы значений.
- Легенда – легенда для аналитики. По умолчанию переключатель включен.
Пустые значения в легенде – отображение параметров с нулевым значением в легенде для аналитики. По умолчанию переключатель выключен.
Другие виджеты
В этом разделе описываются параметры всех виджетов, кроме виджетов События и Активные листы.
Набор параметров, доступных для виджета, зависит от типа графика, который отображается на виджете. В KUMA доступны следующие типы графиков:
- Круговая диаграмма (
).
- Счетчик (
).
- Таблица (
).
- Столбчатая диаграмма (
).
- Календарная диаграмма (
).
- Линейная диаграмма.
- Сложенная столбчатая диаграмма.
Параметры для круговых диаграмм
- Название – название виджета.
- Описание – описание виджета.
Тенант – тенант, по которому отображаются данные на виджете. Вы можете выбрать несколько тенантов. По умолчанию данные отображаются по тенантам, которые вы выбрали в параметрах макета.
- Период – период, за который отображаются данные на виджете. Доступны следующие периоды:
- Как на макете – отображаются данные за период, выбранный для макета. Значение по умолчанию.
- 1 час – отображаются данные за предыдущий час.
- 1 день – отображаются данные за предыдущий день.
- 7 дней – отображаются данные за предыдущие 7 дней.
- 30 дней – отображаются данные за предыдущие 30 дней.
- В течение периода – отображаются данные за выбранный период времени. При выборе этого варианта в открывшемся календаре выберите дату начала и окончания периода и нажмите Применить фильтр. Формат даты и времени зависит от настроек вашей операционной системы. При необходимости вы можете изменить значения даты вручную.
Верхняя граница периода не включается в определяемый с ее помощью отрезок времени. Это означает, что, например, для получения аналитики за сутки следует настроить период <День 1>, 00:00:00 – <День 2>, 00:00:00, а не <День 1>, 00:00:00 – <День 1>, 23:59:59.
- Итоговые значения – суммы значений.
- Легенда – легенда для аналитики. По умолчанию переключатель включен.
Пустые значения в легенде – отображение параметров с нулевым значением в легенде для аналитики. По умолчанию переключатель выключен.
- Десятичные знаки – количество десятичных знаков, до которых отображаемое значение должно быть округлено.
Параметры для счетчиков
- Название – название виджета.
- Описание – описание виджета.
Тенант – тенант, по которому отображаются данные на виджете. Вы можете выбрать несколько тенантов. По умолчанию данные отображаются по тенантам, которые вы выбрали в параметрах макета.
- Период – период, за который отображаются данные на виджете. Доступны следующие периоды:
- Как на макете – отображаются данные за период, выбранный для макета. Значение по умолчанию.
- 1 час – отображаются данные за предыдущий час.
- 1 день – отображаются данные за предыдущий день.
- 7 дней – отображаются данные за предыдущие 7 дней.
- 30 дней – отображаются данные за предыдущие 30 дней.
- В течение периода – отображаются данные за выбранный период времени. При выборе этого варианта в открывшемся календаре выберите дату начала и окончания периода и нажмите Применить фильтр. Формат даты и времени зависит от настроек вашей операционной системы. При необходимости вы можете изменить значения даты вручную.
Верхняя граница периода не включается в определяемый с ее помощью отрезок времени. Это означает, что, например, для получения аналитики за сутки следует настроить период <День 1>, 00:00:00 – <День 2>, 00:00:00, а не <День 1>, 00:00:00 – <День 1>, 23:59:59.
Параметры для таблиц
- Название – название виджета.
- Описание – описание виджета.
Тенант – тенант, по которому отображаются данные на виджете. Вы можете выбрать несколько тенантов. По умолчанию данные отображаются по тенантам, которые вы выбрали в параметрах макета.
- Период – период, за который отображаются данные на виджете. Доступны следующие периоды:
- Как на макете – отображаются данные за период, выбранный для макета. Значение по умолчанию.
- 1 час – отображаются данные за предыдущий час.
- 1 день – отображаются данные за предыдущий день.
- 7 дней – отображаются данные за предыдущие 7 дней.
- 30 дней – отображаются данные за предыдущие 30 дней.
- В течение периода – отображаются данные за выбранный период времени. При выборе этого варианта в открывшемся календаре выберите дату начала и окончания периода и нажмите Применить фильтр. Формат даты и времени зависит от настроек вашей операционной системы. При необходимости вы можете изменить значения даты вручную.
Верхняя граница периода не включается в определяемый с ее помощью отрезок времени. Это означает, что, например, для получения аналитики за сутки следует настроить период <День 1>, 00:00:00 – <День 2>, 00:00:00, а не <День 1>, 00:00:00 – <День 1>, 23:59:59.
- Показывать данные за предыдущий период – включение отображения данных сразу текущий и предыдущий периоды.
- Цвет – цвет отображения информации:
- по умолчанию – цвет шрифта, который используется в вашем браузере по умолчанию;
- зеленый;
- красный;
- синий;
- желтый.
- Десятичные знаки – количество десятичных знаков, до которых отображаемое значение должно быть округлено.
Параметры для столбчатых и календарных диаграмм
Вкладка :
- Минимальное значение Y и Максимальное значение Y – масштаб оси Y.
- Минимальное значение X и Максимальное значение X – масштаб оси X.
На осях графиков могут отображаться отрицательные значения. Это связано с масштабированием графиков на виджете и может быть исправлено выставлением нуля в качестве минимальных значений графиков вместо Авто.
- Десятичные знаки – количество десятичных знаков, до которых отображаемое значение должно быть округлено.
Вкладка :
- Название – название виджета.
- Описание – описание виджета.
Тенант – тенант, по которому отображаются данные на виджете. Вы можете выбрать несколько тенантов. По умолчанию данные отображаются по тенантам, которые вы выбрали в параметрах макета.
- Период – период, за который отображаются данные на виджете. Доступны следующие периоды:
- Как на макете – отображаются данные за период, выбранный для макета. Значение по умолчанию.
- 1 час – отображаются данные за предыдущий час.
- 1 день – отображаются данные за предыдущий день.
- 7 дней – отображаются данные за предыдущие 7 дней.
- 30 дней – отображаются данные за предыдущие 30 дней.
- В течение периода – отображаются данные за выбранный период времени. При выборе этого варианта в открывшемся календаре выберите дату начала и окончания периода и нажмите Применить фильтр. Формат даты и времени зависит от настроек вашей операционной системы. При необходимости вы можете изменить значения даты вручную.
Верхняя граница периода не включается в определяемый с ее помощью отрезок времени. Это означает, что, например, для получения аналитики за сутки следует настроить период <День 1>, 00:00:00 – <День 2>, 00:00:00, а не <День 1>, 00:00:00 – <День 1>, 23:59:59.
- Показывать данные за предыдущий период – включение отображения данных сразу за два периода: за текущий и за предыдущий.
- Цвет – цвет отображения информации:
- по умолчанию – цвет шрифта, который используется в вашем браузере по умолчанию;
- зеленый;
- красный;
- синий;
- желтый.
- Горизонтальный – использование горизонтальной гистограммы вместо вертикальной. При включении этого параметра вся имеющаяся информация будет отражена в заданном размере виджета. Если данных много, вы можете увеличить размер виджета для их оптимального отображения.
- Итоговые значения – суммы значений.
- Легенда – легенда для аналитики. По умолчанию переключатель включен.
Пустые значения в легенде – отображение параметров с нулевым значением в легенде для аналитики. По умолчанию переключатель выключен.
- Длительность отрезков периода (доступно для графика типа Календарная диаграмма) – длительность отрезков, на которые требуется делить период.