Виджет События

Вы можете использовать виджет События для получения необходимой аналитики на основе SQL-запросов.

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

Вкладка Общие

В таблице ниже описаны параметры, расположенные на вкладке Общие.

Описание параметров

Параметр	Описание
График	Тип графика. Доступны следующие типы графиков: Круговая диаграмма. Столбчатая диаграмма. Счетчик. Линейная диаграмма. Таблица. Календарная диаграмма. Сложенная столбчатая диаграмма. Спидометр.
Формат	Формат отображения данных: Абсолютные значения или Относительные значения, %. Параметр доступен для графика типа Сложенная столбчатая диаграмма. При выборе формата Абсолютные значения высота столбцов диаграммы соответствует сумме значений измеряемого показателя. При выборе формата Относительные значения, % все столбцы имеют одинаковую высоту 100%, а размеры цветных областей столбца соответствуют процентному соотношению между значениями показателя. По умолчанию выбрано Абсолютные значения.
Вид временной диаграммы	Формат отображения временных данных: Столбчатая диаграмма или Линейная диаграмма. Параметр доступен для графика типа Календарная диаграмма. При выборе формата Столбчатая диаграмма данные по умолчанию отображаются в виде вертикальных столбцов. Если SQL-запрос содержит дополнительное поле с псевдонимом `category`, столбчатая диаграмма будет представлена в виде сложенной диаграммы, то есть с разбивкой каждого столбца по значениям этого поля. При выборе формата Линейная диаграмма данные отображаются в виде одной или нескольких (в зависимости от запроса) ломаных линий, соединяющих точки на временной оси. По умолчанию выбран формат Столбчатая диаграмма.
Тенант	Тенант, по которому отображаются данные на виджете. Вы можете выбрать несколько тенантов. По умолчанию данные отображаются по тенантам, которые вы выбрали в параметрах макета.
Период	Период, за который отображаются данные на виджете. По умолчанию выбрано Как на макете – отображаются данные за период, выбранный для макета. Вы также можете указать период для виджета одним из следующих способов: Выбрать точные дату и время начала и окончания периода в календаре и нажать на кнопку Применить. Выбрать период относительно настоящего времени в списке Относительный период. Указать значение вручную: выбрать точные дату и время или относительный период либо использовать комбинацию этих способов. Подробнее см. ниже в подразделе Настройка значения периода.
Показывать данные за предыдущий период	Включение отображения данных сразу за два периода: за текущий и за предыдущий. При использовании графика типа Сложенная столбчатая диаграмма параметр Показывать данные за предыдущий период будет учитываться, если в запросе указаны стандартные псевдонимы `value`, `category`, `metric`. Если же в запросе вместо стандартной метрики `metric` используется пользовательский расчет метрик с нестандартными псевдонимами, то параметр Показывать данные за предыдущий период учитываться не будет.
Доступные переменные	Локальные или глобальные переменные, которые вы можете использовать для фильтрации данных виджета. Нажмите на кнопку Добавить. Если вы добавляете локальную переменную, введите произвольное имя переменной, затем укажите значение переменной. Если вы добавляете глобальную переменную, выберите из списка имя переменной, которую вы указали в свойствах панели мониторинга.
Хранилище	Хранилище, в котором выполняется поиск событий. В списке отображаются доступные пространства. Можно выбрать только одно хранилище, можно выбрать одно или несколько пространств. Значения в поле Хранилище не зависит от выбранных тенантов в поле Тенант. В поле отображаются хранилища и пространства, как в разделе События. Если в хранилище было создано новое пространство, в параметрах виджета новое пространство по умолчанию не выбрано. Следует выбрать новое пространство вручную. Если у пользователя есть доступ ко всем пространствам, указанным в виджете, тогда на виджете будут доступны для просмотра данные по событиям тенантов, указанным в наборе пространств и в правах пользователя. Если у пользователя нет прав доступа к одному или нескольким пространствам хранилища, данные на виджете будут недоступны для просмотра, пользователь не может редактировать виджет, но может продублировать виджет с помощью кнопки Дублировать. Дублирование не зависит от прав доступа к пространствам. При дублировании шаблона в тех виджетах, где были указаны недоступные пользователю пространства, значение в поле Хранилище будет сброшено. В таких виджетах будет отображаться ошибка Access denied (Operation returns no results because of allowed and selected event spaces). Для сохранения шаблона необходимо указать пространства в виджетах. В тех виджетах, где были указаны пространства, доступные пользователю, значение поля Хранилище не сбрасывается и сохраняется при дублировании шаблона. При выгрузке отчета пользователь получит файл, в котором скрыты данные недоступных виджетов. Если адрес электронной почты пользователя указан в списке получателей отчета по расписанию, пользователь получит полную версию отчета независимо от доступных пространств.
Поле SQL-запроса	Запрос для фильтрации и поиска событий вручную. Вы можете составить запрос в конструкторе запросов, нажав на кнопку Использовать конструктор SQL. Вы можете использовать поля расширенной схемы событий для построения графика типа таблица. Пример с полями расширенной схемы Предварительное условие: Из FWSaaS-системы поступают события. 10.08.2023 12:12:12 src=10.10.10.10 ReqUrls=[https://google.com, https:/ya.ru] 10.08.2023 12:12:23 src=10.10.10.20 ReqUrls=[https://google.com, https:/yndex.ru] 10.08.2023 12:12:33 src=10.10.10.30 ReqUrls=[https://google.com, https:/ya.ru, https://mail.ru] Главный администратор KUMA добавил поле расширенной схемы событий в разделе KUMA Параметры → Другое → Поля расширенной схемы событий. В нормализаторе KUMA настроено сопоставление полей ReqUrls и SA.urls. В KUMA нормализованные события выглядят следующим образом: DeviceReceiptTime=10.08.2023 12:12:12 SourceAddress=10.10.10.10 SA.urls=[https://google.com, https:/ya.ru] DeviceReceiptTime=10.08.2023 12:12:23 SourceAddress=10.10.10.20 SA.urls=[https://google.com, https:/yandex.ru] DeviceReceiptTime=10.08.2023 12:12:30 SourceAddress=10.10.10.30 SA.urls=[https://google.com, https:/ya.ru, https://mail.ru] Вы хотите построить панель мониторинга Top URLs за 30 мин. Пример запроса в разделе События и в виджетах: SELECT res.1 AS url, res.2 AS count FROM ( SELECT arrayJoin(groupArray((url, count))) AS res FROM ( SELECT url, count() AS count FROM ( SELECT SA.urls AS urls FROM `events` ) ARRAY JOIN urls AS url GROUP BY url ) GROUP BY url ) Результат: url count google.com 3 ya.ru 2 mail.ru 1 yandex.ru 1 При составлении SQL-запроса вы можете использовать переменные. Переменные можно указывать только при составлении запроса вручную. В конструкторе SQL переменные использовать нельзя. Пример с использованием переменных Пример SQL-запроса с использованием локальной переменной: `SELECT count(ID) AS 'metric', Name AS 'value', TenantID AS 'category' FROM 'events' WHERE filter(Name = $Name) GROUP BY Name, TenantID ORDER BY metric DESC LIMIT 250` В этом запросе использована локальная переменная `$Name`. В эту переменную будет подставляться значение из поля события Name. Вы сможете применить переменную, нажав на значок воронки () на виджете. В открывшемся окне вы сможете выбрать значение для переменной. Виджет отфильтрует выборку по выбранному значению поля Name. Обратите внимание, если в SQL-запросе вы прописываете переменную для поля, которое принимает числовое значение, такое значение надо преобразовать в строку. Для этого используйте функцию `toString`. В противном случае SQL-запрос вернет ошибку. Пример: SELECT count(ID) AS `metric`, SourcePort AS `value` FROM `events` WHERE (filter(toString(SourcePort) like $SourcePort)) GROUP BY SourcePort ORDER BY value ASC LIMIT 250 В этом запросе поле события SourcePort имеет числовое значение, поэтому оно преобразовано в строку: `toString(SourcePort)`. Подробнее о создании 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`. В виджетах с графиком типа Таблица градиент строится по значениям числового или временного поля (например, `Timestamp`), указанного в SQL-запросе. Это поле можно выбрать в раскрывающемся списке Поле с индикатором градиента (если в запросе указано несколько числовых или временных полей, они все будут доступны для выбора). После этого ячейки выбранного столбца будут подсвечены маркерами градиентной заливки. Если поле отсутствует в запросе, на вкладке Внешний вид не отображаются поля Градиент и Поле с индикатором градиента. В виджетах с графиком типа Сложенная столбчатая диаграмма значения временного поля `Timestamp` не отображаются по оси X при использовании стандартного запроса. Если требуется отображение времени по оси X, рекомендуется использовать график типа Линейная диаграмма. Если вам нужно использовать график типа Сложенная столбчатая диаграмма, значение `Timestamp` нужно конвертировать в строку toString(Timestamp) AS `category`.

Настройка значения периода

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

При необходимости измените дату и время в параметре Период одним из следующих способов:
- Если вы хотите указать точную дату, в календаре слева выберите даты начала и окончания периода и нажмите на кнопку Применить.
  Вы можете выбрать дату до текущей включительно. Формат даты и времени зависит от параметров вашего браузера. Если в поле Дата от или Дата до есть значение и вы не меняли вручную значение времени, при выборе даты в календаре в поле Дата от автоматически подставится время 00:00:00.000, а в поле Дата до – 23:59:59.999. Если вы вручную удалили значение в поле Дата от или Дата до, при выборе даты в календаре в поле автоматически подставится текущее время. После того как вы выберите значение в одном из полей, фокус переключается на другое поле. Если в поле Дата до вы выбираете значение, которое меньше значения в поле Дата от, это меньшее значение будет автоматически подставлено в поле Дата от.
- Если вы хотите указать относительный период, выберите один из доступных периодов в списке Относительный период справа.
  Период рассчитывается относительно настоящего времени.
- Если вы хотите задать пользовательский период, укажите или измените значение вручную в полях Дата от и Дата до.
  Вы можете указать точные дату и время в формате DD.MM.YYYY HH:mm:ss.SSS для русской локализации и YYYY-MM-DD HH:mm:ss.SSS для английской локализации или период относительно текущего времени в виде формулы. При необходимости вы также можете комбинировать эти способы. Если при вводе точной даты вы не указали миллисекунды, значение 000 подставляется автоматически. Если вы вручную изменили время в полях Дата от или Дата до, при переключении даты в календаре значение времени не меняется.
  
  В формулах относительного периода используйте параметр now для обозначения текущих даты и времени и язык параметризации интервалов: символы + (только в поле Дата до), -, / (округление до ближайшего), а также единицы изменения времени y (год), M (месяц), w (неделя), d (день), h (час), m (минута), s (секунда). Например, вы можете указать период now-5d, чтобы получить данные за последние пять дней, или now/w, чтобы получить данные с начала первого дня текущей недели (00:00:00:000 в UTC) до текущего времени now.
  
  Поле Дата от является обязательным, и его значение не может превышать значение, установленное в поле Дата до, а также не может быть меньше 01.01.1970 (при указании точной даты или относительного периода). Значение в поле Дата до не должно быть меньше значения, установленного в поле Дата от. Если вы не укажете значение в поле Дата до, параметр now указывается автоматически.
Время в KUMA хранится в UTC, но в интерфейсе оно конвертируется в соответствии с часовым поясом вашего браузера. Это нужно учитывать для относительных периодов Сегодня, Вчера, Эта неделя и Этот месяц. Например, если в браузере установлен часовой пояс UTC+3 и вы выбрали период отображения данных Сегодня, данные будут отображаться за период с 03:00:00.000 до текущего времени, а не с 00:00:00.000.

Если при выборе относительного периода Сегодня, Вчера, Эта неделя или Этот месяц вы хотите отобразить данные в соответствии с вашим часовым поясом, вам нужно вручную добавить сдвиг по времени в поля Дата от и Дата до (если указано значение кроме now), прибавив или убавив необходимое количество часов. Например, если в браузере установлен часовой пояс UTC+3 и вы хотите отобразить данные за период Вчера, вам нужно изменить значение в поле Дата от на now-1d/d-3h, а в поле Дата до – на now/d-3h. Если же вы хотите отобразить данные за период Сегодня, вам нужно изменить значение только в поле Дата от на now/d-3h.

Если вам нужны результаты до 23:59:59:999 вчерашнего дня в UTC, то используйте SQL-запрос с фильтром по Timestamp или укажите точные дату и время.

Границы периода включаются: например, для периода Сегодня отобразятся события с начала сегодняшнего дня 00:00:00:000 в UTC до текущего времени now включительно, а для периода Вчера – с начала вчерашнего дня 00:00:00:000 до 00:00:00:000 в UTC сегодняшнего дня. Вы можете посмотреть дату и время последнего обновления данных и точный период, за который отображаются данные, наведя курсор на значок периода на виджете.

Если для виджета вы включили параметр Показывать данные за предыдущий период, и данные на виджете отображаются за относительный период, во всплывающей подсказке также будет отображаться предыдущий период. Предыдущий период рассчитывается относительно текущего периода как значения начала и конца текущего периода минус длительность текущего периода. Например, если данные обновляются ежедневно и отображаются за месяц, но прошли только первые 10 дней месяца, прошлым периодом будут считаться последние 10 дней прошлого месяца.
Если вы хотите отобразить на виджете данные за период, выбранный для макета, вы можете нажать на кнопку Сбросить. При изменении периода отображения данных на макете, также изменится отображаемый на виджете период.

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

Чтобы создать запрос в конструкторе запросов:

Укажите значения для следующих параметров:
1. SELECT – поля событий, которые следует возвращать. Количество доступных полей зависит от выбранного типа графика.
  - В раскрывающемся списке слева выберите поля событий, данные по которым должны отображаться на виджете.
  - Среднее поле показывает, для чего выбранное поле используется в виджете: metric (метрики) или value (значение).
    Если вы выбрали тип графика Таблица, в средних полях нужно указать названия столбцов, используя символы ANSII-ASCII.
  - В раскрывающемся списке справа вы можете выбрать операцию, которую следует произвести над данными:
    - count – подсчет событий. Эта операция доступна только для поля события ID. Используется по умолчанию для линейных, круговых и столбчатых диаграмм, а также для счетчиков. Является единственно возможным вариантом для календарных диаграмм.
    - max – максимальное значение поля события из выборки событий.
    - min – минимальное значение поля события из выборки событий.
    - avg – среднее значение поля события из выборки событий.
    - sum – сумма значений полей событий из выборки событий.
2. SOURCE – тип источника данных. Для выбора доступно только значение events (события).
3. WHERE – условия фильтрации событий.
  - В раскрывающемся списке слева выберите поле события, которое вы хотите использовать для фильтрации.
  - В среднем раскрывающемся списке выберите нужный оператор. Доступные операторы зависят от типа значения выбранного поля события.
  - В раскрывающемся списке справа введите значение условия. В зависимости от выбранного типа поля вам потребуется ввести значение вручную, выбрать его в раскрывающемся списке или выбрать в календаре.
  Вы можете добавить условия поиска, нажав на кнопку Добавить условие или удалить их, нажав на кнопку .
  
  Вы можете добавить группы условий, нажав на кнопку Добавить группу. По умолчанию группы условий добавляются с оператором AND, но при необходимости вы можете изменить значение. Доступные значения: AND, OR, NOT. Группы условий удаляются с помощью кнопки Удалить группу.
4. GROUP BY – поля событий или псевдонимы, по которым следует группировать возвращаемые данные. Этот параметр недоступен для графиков типа Счетчик.
5. ORDER BY – столбцы, по которым следует сортировать возвращаемые данные. Этот параметр недоступен для графиков следующих типов: Календарная диаграмма и Счетчик.
  - В раскрывающемся списке слева выберите значение, которое будет использоваться для сортировки.
  - В раскрывающемся списке справа выберите порядок сортировки: ASC – по возрастанию, DESC – по убыванию.
  - Для графиков типа Таблица можно добавить условия сортировки с помощью кнопки Добавить столбец.
6. LIMIT – максимальное количество точек данных для виджета. Этот параметр недоступен для графиков типа Календарная диаграмма и Счетчик.
Нажмите на кнопку Применить.

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

Вкладка Оси

В таблице ниже описаны параметры, расположенные на вкладке Оси.

Вкладка отображается, если на вкладке Общие в поле График вы выбрали одно из следующих значений: Столбчатая диаграмма, Линейная диаграмма, Календарная диаграмма.

Описание параметров

Параметр	Описание
Размер указателя	Размер указателя на графике. Поле отображается для типа графика Линейная диаграмма.
Толщина линии	Толщина линии на графике. Поле отображается для типа графика Линейная диаграмма.
Минимальное и максимальное значение для оси Y	Масштаб оси Y. На осях графиков могут отображаться отрицательные значения. Это связано с масштабированием графиков на виджете и может быть исправлено выставлением нуля в качестве минимальных значений графиков вместо Авто.
Минимальное и максимальное значение для оси Х	Масштаб оси X. На осях графиков могут отображаться отрицательные значения. Это связано с масштабированием графиков на виджете и может быть исправлено выставлением нуля в качестве минимальных значений графиков вместо Авто.
Десятичные знаки	Количество десятичных знаков, до которых отображаемое значение должно быть округлено.

Вкладка Внешний вид

В таблице ниже описаны параметры, расположенные на вкладке Внешний вид.

Описание параметров

Параметр	Описание
Название	Название виджета.
Описание	Описание виджета.
Легенда	Отображение легенды для аналитики. По умолчанию переключатель включен.
Пустые значения в легенде	Отображение параметров с нулевым значением в легенде для аналитики. По умолчанию переключатель включен. Пустые значения отображаются только при включенном параметре Показать данные за предыдущий период, если в текущем периоде данных нет, а в предыдущем были.
Цвет	Цвет отображения информации: по умолчанию – цвет шрифта, который используется в вашем браузере по умолчанию; зеленый; красный; синий; желтый. Параметр доступен для графиков типа Столбчатая диаграмма, Счетчик, Линейная диаграмма, Календарная диаграмма.
Градиент	Градиентная заливка графика: двухцветная (красно-зеленая); трехцветная (красно-желто-зеленая). Параметр доступен для графиков типа Столбчатая диаграмма, Календарная диаграмма (с видом диаграммы Столбчатая диаграмма), Таблица. Вы можете настроить направление заливки, нажав на значок переключения направления (), а также задать пороговые значения. Если границы градиента не заданы вручную, они рассчитываются автоматически по значениям данных. Если между заданными границами нет данных, градиент не применяется. Вместо него используется два цвета: один для значений ниже нижней границы, другой – для значений выше верхней.
Поле с индикатором градиента	Столбец, в котором отображаются маркеры градиентной заливки. Параметр доступен для графика типа Таблица.
Горизонтальный	Использование горизонтальной гистограммы вместо вертикальной. При включении этого параметра горизонтальная прокрутка при большом количестве данных не будет отображаться и вся имеющаяся информация будет отражена в заданном размере виджета. Если данных для отображения много, рекомендуется увеличить размер виджета.
Итоговые значения	Суммы значений.
Длительность отрезков периода	Длительность отрезков, на которые требуется делить период. Доступно для графика типа Календарная диаграмма.
Шкала	Шкала для отображения данных. Доступно для графика типа Сложенная столбчатая диаграмма. Возможны следующие значения: Линейная. Квадратичная. Логарифмическая. По умолчанию выбрано значение Линейная.
Регрессия	Вариант указания среднего значения на графике. Возможны следующие значения: Не выбрано. Линейная. LOESS (кривая с локально взвешенным сглаживанием диаграмм рассеяния). Доступно для графиков типа Календарная диаграмма и Линейная диаграмма.

Вкладка Действия

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

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

В начало