Kaspersky Unified Monitoring and Analysis Platform

Виджеты

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

  • События – виджет для создания аналитики на основе событий.
  • Активные листы – виджет для создания аналитики на основе активных листов корреляторов.
  • Алерты – группа для аналитики алертов.

    В группу входят следующие виджеты:

    • Активные алерты – количество незакрытых алертов.
    • Активные алерты по тенантам – количество незакрытых алертов для каждого тенанта.
    • Алерты по тенантам – количество алертов всех статусов для каждого тенанта.
    • Неназначенные алерты – количество алертов со статусом Новый.
    • Алерты по исполнителю – количество алертов со статусом Назначен, сгруппированных по имени учетной записи.
    • Алерты по статусу – количество алертов со статусом Новый, Открыт, Назначен или Эскалирован, сгруппированных по статусу.
    • Алерты по уровню важности – количество незакрытых алертов, сгруппированных по уровню важности.
    • Алерты по правилу корреляции – количество незакрытых алертов, сгруппированных по правилам корреляции.
    • Последние алерты – таблица с информацией о последних 10 незакрытых алертах, принадлежащих выбранным в макете тенантам.
    • Распределение алертов – количество алертов, созданных в течение указанного для виджета периода.
  • Активы – группа для аналитики активов из обработанных событий. В эту группу входят следующие виджеты:
    • Затронутые активы – таблица с информацией об уровне важности активов и количестве незакрытых алертов, с которыми они связаны.
    • Категории затронутых активов – категории активов, привязанных к незакрытым алертам.
    • Количество активов – количество активов, добавленных в KUMA.
    • Активы в инцидентах по тенантам – количество активов, связанных с незакрытыми инцидентами. Сгруппированы по тенантам.
    • Активы в алертах по тенантам – количество активов, связанных с незакрытыми алертами, Сгруппированы по тенантам.
  • Инциденты – группа для аналитики инцидентов.

    В группу входят следующие виджеты:

    • Активные инциденты – количество незакрытых инцидентов.
    • Неназначенные инциденты – количество инцидентов со статусом Открыт.
    • Распределение инцидентов – количество инцидентов, созданных в течение указанного для виджета периода.
    • Инциденты по исполнителю – количество инцидентов со статусом Назначен, сгруппированных по имени учетной записи пользователя.
    • Инциденты по статусам – количество инцидентов, сгруппированных по статусу.
    • Инциденты по уровню важности – количество незакрытых инцидентов, сгруппированных по уровню важности.
    • Активные инциденты по тенантам – количество незакрытых инцидентов, сгруппированных по тенантам, доступным для учетной записи пользователя.
    • Все инциденты – количество инцидентов всех статусов.
    • Все инциденты по тенантам – количество инцидентов всех статусов, сгруппированных по тенантам.
    • Активы в инцидентах – количество активов, связанных с незакрытыми инцидентами.
    • Категории активов в инцидентах – категории активов, связанных с незакрытыми инцидентами.
    • Пользователи в инцидентах – пользователи, связанные с инцидентами.
    • Последние инциденты – таблица с информацией о последних 10 незакрытых инцидентах, принадлежащих выбранным в макете тенантам.
  • Источники событий – группа для аналитики источников событий. В группу входят следующие виджеты:
    • Топ источников событий по количеству алертов – количество незакрытых алертов, сгруппированных по источникам событий.
    • Топ источников событий по условному рейтингу – количество событий, связанных с незакрытыми алертами. Сгруппированы по источникам событий.

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

  • Пользователи – группа для аналитики о пользователях из обработанных событий. В группу входят следующие виджеты:
    • Пользователи в алертах – количество учетных записей, связанных с незакрытыми алертами.
    • Количество пользователей AD – количество учетных записей в Active Directory, полученных по LDAP в течение указанного для виджета периода.

В таблице событий, в области деталей событий, в окне алертов, а также в виджетах в качестве значений полей SourceAssetID, DestinationAssetID, DeviceAssetID, SourceAccountID, DestinationAccountID и ServiceID вместо идентификаторов отображаются названия активов, учетных записей или сервисов. При экспорте событий в файл идентификаторы сохраняются, однако в файл добавляются столбцы с названиями. Идентификаторы также отображаются при наведении указателя мыши на названия активов, учетных записей или сервисов.

Поиск по полям с идентификаторами возможен только с помощью идентификаторов.

В этом разделе

Основные принципы работы с виджетами

Особенности отображения данных в виджетах

Создание виджета

Редактирование виджета

Удаление виджета

Параметры виджетов

Отображение названий тенантов в виджетах типа Активный лист

В начало
[Topic 218042]

Основные принципы работы с виджетами

Принцип отображения данных на виджете зависит от типа графика. В KUMA доступны следующие типы графиков:

  • Круговая диаграмма (pie).
  • Счетчик (counter).
  • Таблица (table).
  • Столбчатая диаграмма (bar1).
  • Календарная диаграмма (bar2).
  • Линейная диаграмма.
  • Сложенная столбчатая диаграмма.

Основные принципы работы со всеми виджетами

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

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

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

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

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

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

Слева от значка периода отображается кнопка CSV. Вы можете скачать данные, которые отображаются на виджете, в формате CSV (кодировка UTF-8). Название скачиваемого файла имеет формат <название виджета>_<дата скачивания (ГГГГММДД)>_<время скачивания (ЧЧММСС)>.CSV.

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

Основные принципы работы с графиками типа Круговая диаграмма

Под списком тенантов отображается круговая диаграмма. Вы можете перейти в раздел веб-интерфейса KUMA с соответствующими данными, щелкнув левой кнопкой мыши по выбранному разделу диаграммы. Данные в разделе будут отсортированы в соответствии с фильтрами и/или поисковым запросом, указанным в виджете.

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

Примеры:

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

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

  • На виджете События, для которого указан SQL-запрос SELECT count(ID) AS `metric`, Name AS `value` FROM `events` GROUP BY Name ORDER BY `metric` DESC LIMIT 10, под значком периода отображается 10 событий, сгруппированных по имени и отсортированных в порядке убывания.

    Если вы хотите просмотреть в легенде события с определенными именами, вы можете снять флажки слева от имен событий, которые не должны отображаться в легенде.

Основные принципы работы с графиками типа Счетчик

На графиках этого типа отображается сумма выбранных данных.

Пример:

На виджете Количество активов отображается общее количество активов, добавленных в KUMA.

Основные принципы работы с графиками типа Таблица

На графиках этого типа данные отображаются в виде таблицы.

Пример:

На виджете События, для которого указан SQL-запрос SELECT TenantID , Timestamp , Name , DeviceProduct , DeviceVendor FROM `events` LIMIT 10, отображается таблица событий со столбцами TenantID, Timestamp, Name, DeviceProduct, DeviceVendor. Таблица содержит 10 строк.

Основные принципы работы с графиками типа Столбчатая диаграмма

Под списком тенантов отображается столбчатая диаграмма. Вы можете перейти в раздел События веб-интерфейса KUMA, щелкнув левой кнопкой мыши по выбранному разделу диаграммы. Данные в разделе будут отсортированы в соответствии с фильтрами и/или поисковым запросом, указанным в виджете. Справа от диаграммы эти данные представлены в виде таблицы.

Пример:

На виджете Netflow top internal IPs, для которого указан SQL-запрос SELECT sum(BytesIn) AS metric, DestinationAddress AS value FROM `events` WHERE (DeviceProduct = 'netflow' OR DeviceProduct = 'sflow') AND (inSubnet(DestinationAddress, '10.0.0.0/8') OR inSubnet(DestinationAddress, '172.16.0.0/12') OR inSubnet(DestinationAddress, '192.168.0.0/16')) GROUP BY DestinationAddress ORDER BY metric DESC LIMIT 10, на оси X диаграммы отображается сумма трафика в байтах, на оси Y диаграммы отображаются адреса портов назначения. Данные сгруппированы по адресам назначения в порядке убывания суммы трафика.

Основные принципы работы с графиками типа Календарная диаграмма

Под списком тенантов отображается календарная диаграмма. Вы можете перейти в раздел События веб-интерфейса KUMA с соответствующими данными, щелкнув левой кнопкой мыши по выбранному разделу диаграммы. Данные в разделе будут отсортированы в соответствии с фильтрами и/или поисковым запросом, указанным в виджете. Справа от диаграммы эти данные представлены в виде таблицы.

Пример:

На виджете События, для которого указан SQL-запрос SELECT count(ID) AS `metric`, Timestamp AS `value` FROM `events` GROUP BY Timestamp ORDER BY `metric` DESC LIMIT 250, на оси X диаграммы отображается дата создания события, на оси Y диаграммы отображается примерное количество событий. События сгруппированы по дате создания в порядке убывания.

Основные принципы работы с графиками типа Линейная диаграмма

Под списком тенантов отображается линейная диаграмма. Вы можете перейти в раздел События веб-интерфейса KUMA с соответствующими данными, щелкнув левой кнопкой мыши по выбранному разделу диаграммы. Данные в разделе будут отсортированы в соответствии с фильтрами и/или поисковым запросом, указанным в виджете. Справа от диаграммы эти данные представлены в виде таблицы.

Пример:

На виджете События, для которого указан SQL-запрос SELECT count(ID) AS `metric`, SourcePort AS `value` FROM `events` GROUP BY SourcePort ORDER BY `value` ASC LIMIT 250, на оси X диаграммы представлен примерный номер порта, на оси Y диаграммы отображаются количество событий. Данные сгруппированы по номеру порта в порядке возрастания.

Основные принципы работы с графиками типа Сложенная столбчатая диаграмма

Под списком тенантов отображается сложенная столбчатая диаграмма с легендой. В легенде отображаются названия категорий, по которым происходит разбивка столбцов. Слева от каждой категории находится флажок, с помощью которого можно скрыть или показать категорию. Количество столбцов на диаграмме соответствует количеству значений в выбранной группировке. Столбцы подписаны метками. Цвет соответствующей категории в столбце присваивается автоматически. При наведении курсора мыши на области столбца отображается подсказка со значением и описанием значения. Вы можете перейти в раздел События веб-интерфейса KUMA, щелкнув левой кнопкой мыши по выбранному разделу диаграммы.

Столбцы имеют разную интерпретацию высоты в зависимости от значения параметра Формат:

  • Если выбран формат Абсолютные значения, то высота столбцов соответствует сумме значений измеряемого показателя.
  • Если выбран формат Относительные значения, %, то все столбцы имеют одинаковую высоту 100%, а размеры подкрашенных областей столбца соответствуют процентному соотношению между значениями показателя.

Если при создании пользовательского виджета на основе сложенной столбчатой диаграммы выбран параметр Показывать данные за предыдущий период и в запросе указаны стандартные псевдонимы value, category, metric, то на диаграмме отдельными столбцами показываются данные предыдущего периода. Если же в запросе вместо стандартной метрики metric применяется пользовательский расчет метрик с нестандартными псевдонимами, то параметр Показывать данные за предыдущий период не учитывается при построении диаграммы (см. примеры запросов ниже).

Примеры:

При создании пользовательского виджета с графиком типа Сложенная столбчатая диаграмма на основе SQL-запроса для виджета События действуют следующие правила:

  • Поле в запросе, указанное как псевдоним value (должно быть указано обязательно), будет использоваться на диаграмме как поле, по которому строится легенда и столбцы делятся на категории.
  • Поле в запросе, указанное как псевдоним category (должно быть указано обязательно), будет использоваться на диаграмме как поле, по значениям которого будут расположены столбцы по оси X.
  • Поле в запросе, указанное как псевдоним metric, будет использоваться на диаграмме как поле, по которому должен вестись количественный подсчет частей столбцов. В этом случае количественное распределение будет производиться автоматически.

При этом вы можете самостоятельно управлять подсчетом, используя в качестве метрик стандартные функции агрегации sum, avg, min, max, count и собственные псевдонимы с произвольным названием вместо стандартного псевдонима metric (в этом случае не будет поддерживаться отображение данных за предыдущий период).

Пример 1:

В виджете События указан следующий SQL-запрос со стандартными псевдонимами, при создании виджета выбран параметр Показывать данные за предыдущий период:

SELECT count(ID) AS `metric`,

Type AS `value`,

TenantID AS `category`

FROM `events`

GROUP BY value, category

ORDER BY metric DESC

На диаграмме по оси X отображаются соответствующие тенанты (поле, указанное как category), по оси Y отображается количество событий определенного типа (поле, указанное как value). В каждом столбце количество, соответствующее определенному типу, отображается отдельным цветом. В легенде в качестве категорий отображаются названия типов событий, по которым разбиваются столбцы. Каждой категории соответствует цвет, автоматически присвоенный ей в столбце. Если вы хотите просмотреть на диаграмме события только с определенными типами, вы можете снять или установить флажки слева от соответствующих типов событий в легенде.

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

Пример 2:

В виджете События указан следующий SQL-запрос с пользовательскими метриками, указанными как псевдонимы Base и Audit вместо стандартного metric:

SELECT SUM(IF (Type = 1,1,0)) AS `Base`,

SUM(IF (Type = 4,1,0)) AS `Audit`,

TenantID as `category`

FROM `events`

GROUP BY category

На диаграмме по оси X отображаются соответствующие тенанты (поле, указанное как category), по оси Y отображается количество событий каждого типа (пользовательские метрики, указанные как Base и Audit). В каждом столбце количество, соответствующее определенной метрике, отображается отдельным цветом. В легенде в качестве названий категорий отображаются метрики Base и Audit, по которым столбцы делятся на категории. Каждой категории соответствует цвет, автоматически присвоенный ей на столбце. Если вы хотите просмотреть на диаграмме события, соответствующие только определенной метрике, вы можете снять или установить флажки слева от нужной метрики в легенде.

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

Пример 3:

В виджете События указан следующий SQL-запрос со стандартными псевдонимами:

SELECT count(ID) AS `metric`,

TenantID as `value`,

Type as `category`

FROM events

GROUP BY value, category

ORDER BY metric DESC

В отличие от схожего запроса в примере 1, в этом случае на диаграмме по оси X отображаются соответствующие типы событий (поле, указанное как category), а тенантам (поле, указанное как value) соответствуют области значений в столбцах (по оси X) и соответствующие подписи в легенде.

Пример 4:

В виджете События указан следующий SQL-запрос со стандартными псевдонимами:

SELECT count(ID) AS `metric`,

CAST(fromUnixTimestamp64Milli(Timestamp) AS DATE) AS `category`,

Type as `value`

FROM `events`

GROUP BY category, value

ORDER BY category DESC

На диаграмме по оси X отображаются дни месяца (поле, указанное как category). По оси Y отображается количество событий определенного типа (поле, указанное как value).

Чтобы построить подобный график с расположением столбцов по дате и/или времени, используйте в запросе группировку и сортировку по следующим полям с типом timestamp:

  • Timestamp
  • DeviceCustomDate1
  • DeviceCustomDate2
  • EndTime
  • FileCreateTime
  • FileModificationTime
  • FlexDate1
  • OldFileCreateTime
  • OldFileModificationTime
  • DeviceReceiptTime
  • StartTime

Для полноценной работы с данными, расположенными по дате и/или времени, рекомендуется использовать тип графиков Календарная диаграмма.

В начало
[Topic 254475]

Особенности отображения данных в виджетах

Ограничение отображаемых данных

Для удобства восприятия информации в KUMA заданы ограничения на отображение данных в виджетах в зависимости от их типа:

  • Круговая диаграмма – отображается не более 20 отсеков.
  • Столбчатая диаграмма – отображается не более 40 столбцов.
  • Таблица – отображается не более 500 записей.
  • Календарная диаграмма – отображается не более 365 дней.

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

Все данные, по которым построена аналитика в виджете, можно скачать в формате CSV.

Суммирование данных

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

  • Английская локализация: порядки разделяются запятыми, дробная часть отделяется точкой.
  • Русская локализация: порядки разделяются пробелами, дробная часть отделяется запятой.
В начало
[Topic 245690]

Создание виджета

Вы можете создать виджет на макете панели мониторинга в процессе создания или редактирования макета.

Чтобы создать виджет:

  1. Создайте макет или перейдите в режим редактирования выбранного макета.
  2. Нажмите на кнопку Добавить виджет.
  3. В раскрывшемся списке выберите тип виджета.

    Отобразится окно параметров виджета.

  4. Задайте параметры виджета.
  5. Если вы хотите просмотреть, как будут отображаться данные на виджете, нажмите на кнопку Предварительный просмотр.
  6. Нажмите на кнопку Добавить.

Виджет отобразится на макете панели мониторинга.

В начало
[Topic 254403]

Редактирование виджета

Чтобы изменить виджет:

  1. В веб-интерфейсе KUMA выберите раздел Панель мониторинга.
  2. Раскройте список в верхнем правом углу окна.
  3. Наведите указатель мыши на требуемый макет.
  4. Нажмите на значок карандаша ().

    Откроется окно Настройка макета.

  5. На виджете, который вы хотите изменить, нажмите на значок шестеренки ().
  6. Выберите Изменить.

    Откроется окно параметров виджета.

  7. Задайте параметры виджета.
  8. Нажмите на кнопку Сохранить в окне параметров виджета.
  9. Нажмите на кнопку Сохранить в окне Настройка макета.

Изменения виджета будут применены.

В начало
[Topic 254407]

Удаление виджета

Чтобы удалить виджет:

  1. В веб-интерфейсе KUMA выберите раздел Панель мониторинга.
  2. Раскройте список в верхнем правом углу окна.
  3. Наведите указатель мыши на требуемый макет.
  4. Нажмите на кнопку .

    Откроется окно Настройка макета.

  5. На виджете, который вы хотите удалить, нажмите на кнопку .
  6. Выберите Удалить.
  7. В отобразившемся окне подтверждения нажмите на кнопку ОК.
  8. Нажмите на кнопку Сохранить.

Виджет будет удален.

В начало
[Topic 254408]

Параметры виджетов

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

В этом разделе

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

Виджет Активные листы

Виджет Контекстные таблицы

Пользовательский виджет Активы

Другие виджеты

В начало
[Topic 254289]

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

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

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

Вкладка Selectors

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

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

Параметр

Описание

График

Тип графика. Доступны следующие типы графиков:

  • Круговая диаграмма.
  • Столбчатая диаграмма.
  • Счетчик.
  • Линейная диаграмма.
  • Таблица.
  • Календарная диаграмма.
  • Сложенная столбчатая диаграмма

Формат

Формат отображения данных: Абсолютные значения или Относительные значения, %. Параметр доступен для графика типа Сложенная столбчатая диаграмма.

При выборе формата Абсолютные значения высота столбцов диаграммы соответствует сумме значений измеряемого показателя. При выборе формата Относительные значения, % все столбцы имеют одинаковую высоту 100%, а размеры цветных областей столбца соответствуют процентному соотношению между значениями показателя.

По умолчанию выбрано Абсолютные значения.

Тенант

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

Период

Период, за который отображаются данные на виджете. По умолчанию выбрано Как на макете – отображаются данные за период, выбранный для макета.

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

  • Выбрать точные дату и время начала и окончания периода в календаре и нажать на кнопку Применить.
  • Выбрать период относительно настоящего времени в списке Относительный период.
  • Указать значение вручную: выбрать точные дату и время или относительный период либо использовать комбинацию этих способов.

Подробнее см. ниже в подразделе Настройка значения периода.

Показывать данные за предыдущий период

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

При использовании графика типа Сложенная столбчатая диаграмма параметр Показывать данные за предыдущий период будет учитываться, если в запросе указаны стандартные псевдонимы value, category, metric. Если же в запросе вместо стандартной метрики metric используется пользовательский расчет метрик с нестандартными псевдонимами, то параметр Показывать данные за предыдущий период учитываться не будет.

Хранилище

Хранилище, в котором выполняется поиск событий. В списке отображаются доступные пространства. Можно выбрать только одно хранилище, можно выбрать одно или несколько пространств. Значения в поле Хранилище не зависит от выбранных тенантов в поле Тенант. В поле отображаются хранилища и пространства, как в разделе События.

Если в хранилище было создано новое пространство, в параметрах виджета новое пространство по умолчанию не выбрано. Следует выбрать новое пространство вручную.

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

Если у пользователя нет прав доступа к одному или нескольким пространствам хранилища, данные на виджете будут недоступны для просмотра, пользователь не может редактировать виджет, но может продублировать виджет с помощью кнопки Дублировать. Дублирование не зависит от прав доступа к пространствам. При дублировании шаблона в тех виджетах, где были указаны недоступные пользователю пространства, значение в поле Хранилище будет сброшено. В таких виджетах будет отображаться ошибка Access denied (Operation returns no results because of allowed and selected event spaces). Для сохранения шаблона необходимо указать пространства в виджетах.

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

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

Если адрес электронной почты пользователя указан в списке получателей отчета по расписанию, пользователь получит полную версию отчета независимо от доступных пространств.

Поле SQL-запроса (icon_search_events)

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

Вы можете использовать поля расширенной схемы событий для построение графика типа таблица.

Пример

Предварительное условие:

Из 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-запроса в конструкторе запроса см. ниже.

Существуют следующие ограничения:

  • Псевдонимы 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.

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

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

  • При необходимости измените дату и время в параметре Период одним из следующих способов:
    • Если вы хотите указать точную дату, в календаре слева выберите даты начала и окончания периода и нажмите на кнопку Применить.

      Вы можете выбрать дату до текущей включительно. Формат даты и времени зависит от параметров вашего браузера. Если в поле Дата от или Дата до есть значение и вы не меняли вручную значение времени, при выборе даты в календаре в поле Дата от автоматически подставится время 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. Укажите значения для следующих параметров:
    1. SELECT – поля событий, которые следует возвращать. Количество доступных полей зависит от выбранного типа графика.
      • В раскрывающемся списке слева выберите поля событий, данные по которым должны отображаться на виджете.
      • Среднее поле показывает, для чего выбранное поле используется в виджете: metric (метрики) или value (значение).

        Если вы выбрали тип графика Таблица, в средних полях нужно указать названия столбцов, используя символы ANSII-ASCII.

      • В раскрывающемся списке справа вы можете выбрать операцию, которую следует произвести над данными:
        • count – подсчет событий. Эта операция доступна только для поля события ID. Используется по умолчанию для линейных, круговых и столбчатых диаграмм, а также для счетчиков. Является единственно возможным вариантом для календарных диаграмм.
        • max – максимальное значение поля события из выборки событий.
        • min – минимальное значение поля события из выборки событий.
        • avg – среднее значение поля события из выборки событий.
        • sum – сумма значений полей событий из выборки событий.
    2. SOURCE – тип источника данных. Для выбора доступно только значение events (события).
    3. WHERE – условия фильтрации событий.
      • В раскрывающемся списке слева выберите поле события, которое вы хотите использовать для фильтрации.
      • В среднем раскрывающемся списке выберите нужный оператор. Доступные операторы зависят от типа значения выбранного поля события.
      • В раскрывающемся списке справа введите значение условия. В зависимости от выбранного типа поля вам потребуется ввести значение вручную, выбрать его в раскрывающемся списке или выбрать в календаре.

      Вы можете добавить условия поиска, нажав на кнопку Добавить условие или удалить их, нажав на кнопку X..

      Вы можете добавить группы условий, нажав на кнопку Добавить группу. По умолчанию группы условий добавляются с оператором AND, но при необходимости вы можете изменить значение. Доступные значения: AND, OR, NOT. Группы условий удаляются с помощью кнопки Удалить группу.

    4. GROUP BY – поля событий или псевдонимы, по которым следует группировать возвращаемые данные. Этот параметр недоступен для графиков типа Счетчик.
    5. ORDER BY – столбцы, по которым следует сортировать возвращаемые данные. Этот параметр недоступен для графиков следующих типов: Календарная диаграмма и Счетчик.
      • В раскрывающемся списке слева выберите значение, которое будет использоваться для сортировки.
      • В раскрывающемся списке справа выберите порядок сортировки: ASC  – по возрастанию, DESC  – по убыванию.
      • Для графиков типа Таблица можно добавить условия сортировки с помощью кнопки Добавить столбец.
    6. LIMIT – максимальное количество точек данных для виджета. Этот параметр недоступен для графиков типа Календарная диаграмма и Счетчик.
  2. Нажмите на кнопку Применить.

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

WidgetCustomExample

Параметры условий поиска для отображения в виджете среднего количества байт в расчете на один хост

Вкладка Actions

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

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

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

Параметр

Описание

Минимальное значение Y и Максимальное значение Y

Масштаб оси Y.

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

Минимальное значение X и Максимальное значение X

Масштаб оси X.

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

Толщина линии

Толщина линии на графике. Поле отображается для типа графика Линейная диаграмма.

Размер указателя

Размер указателя на графике. Поле отображается для типа графика Линейная диаграмма.

Вкладка wrench

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

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

Параметр

Описание

Название

Название виджета.

Описание

Описание виджета.

Цвет

Цвет отображения информации:

  • по умолчанию – цвет шрифта, который используется в вашем браузере по умолчанию;
  • зеленый;
  • красный;
  • синий;
  • желтый.

Параметр доступен для графиков типа Столбчатая диаграмма, Счетчик, Линейная диаграмма, Календарная диаграмма.

Горизонтальный

Использование горизонтальной гистограммы вместо вертикальной.

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

Итоговые значения

Суммы значений.

Легенда

Отображение легенды для аналитики. По умолчанию переключатель включен.

Пустые значения в легенде

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

Десятичные знаки

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

Длительность отрезков периода

Длительность отрезков, на которые требуется делить период. Доступно для графика типа Календарная диаграмма.

Шкала

Шкала для отображения данных. Доступно для графика типа Сложенная столбчатая диаграмма. Возможны следующие значения:

  • Линейная.
  • Квадратичная.
  • Логарифмическая.

По умолчанию выбрано значение Линейная.

В начало
[Topic 217867]

Виджет Активные листы

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

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

Вкладка Selectors

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

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

Параметр

Описание

График

Тип графика. Доступны следующие типы графиков:

  • Столбчатая диаграмма.
  • Круговая диаграмма.
  • Счетчик.
  • Таблица.

Тенант

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

Коррелятор

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

Активный лист

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

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

Поле 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.

Вы можете получать в виджете названия тенантов, а не их идентификаторы.

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

  1. Экспорт списка тенантов.
  2. Создание словаря типа Таблица и импорт в него полученного ранее списка тенантов.
  3. Добавление в корреляционное правило локальной переменной с функцией dict для распознания имени тенанта по идентификатору.

    Пример:

    • Переменная: TenantName
    • Значение: dict('<Название ранее созданного словаря с тенантами>', TenantID)
  4. Добавление в корреляционное правило действия над активными листами, с помощью которого значение ранее созданной переменной будет с помощью функции Установить записываться в активный лист в формате Ключ–Значение. В качестве ключа следует задать поле активного листа (например, Тенант), а в поле значения обратиться к ранее созданной переменной (например, $TenantName).

В результате срабатывания этого правила в активный лист будет помещаться название тенанта, опознанного функцией dict по идентификатору среди словаря тенантов. При создании виджетов по активным листам можно получить название тенанта, обратившись к названию поля активного листа (в примере выше это Тенант).

Описанный метод можно применять и к другим полям событий с идентификаторами.

Примеры запросов для получения аналитики по активным листам:

  • 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.

Вкладка Actions

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

Вкладка отображается, если на вкладке Selectors в поле График вы выбрали значение Столбчатая диаграмма.

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

Параметры

Описание

Минимальное значение Y и Максимальное значение Y

Масштаб оси Y.

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

Минимальное значение X и Максимальное значение X

Масштаб оси X.

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

Вкладка wrench

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

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

Параметр

Описание

Название

Название виджета.

Описание

Описание виджета.

Цвет

Цвет отображения информации:

  • по умолчанию – цвет шрифта, который используется в вашем браузере по умолчанию;
  • зеленый;
  • красный;
  • синий;
  • желтый.

Горизонтальный

Использование горизонтальной гистограммы вместо вертикальной.

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

Итоговые значения

Суммы значений.

Легенда

Отображение легенды для аналитики. По умолчанию переключатель включен.

Пустые значения в легенде

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

В начало
[Topic 234198]

Виджет Контекстные таблицы

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

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

Вкладка Selectors

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

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

Параметр

Описание

График

Тип графика. Доступны следующие типы графиков:

  • Столбчатая диаграмма.
  • Круговая диаграмма.
  • Счетчик.
  • Таблица.

Тенант

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

Коррелятор

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

Контекстная таблица

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

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

Поле 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.

Вы можете получать в виджете названия тенантов, а не их идентификаторы.

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

  1. Экспорт списка тенантов.
  2. Создание словаря типа Таблица и импорт в него полученного ранее списка тенантов.
  3. Добавление в корреляционное правило локальной переменной с функцией dict для распознания имени тенанта по идентификатору.

    Пример:

    • Переменная: TenantName
    • Значение: dict('<Название ранее созданного словаря с тенантами>', TenantID)
  4. Добавление в корреляционное правило действия над активными листами, с помощью которого значение ранее созданной переменной будет с помощью функции Установить записываться в активный лист в формате Ключ–Значение. В качестве ключа следует задать поле активного листа (например, Тенант), а в поле значения обратиться к ранее созданной переменной (например, $TenantName).

В результате срабатывания этого правила в активный лист будет помещаться название тенанта, опознанного функцией dict по идентификатору среди словаря тенантов. При создании виджетов по активным листам можно получить название тенанта, обратившись к названию поля активного листа (в примере выше это Тенант).

Описанный метод можно применять и к другим полям событий с идентификаторами.

Примеры запросов для получения аналитики по активным листам:

  • 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.

Вкладка Actions

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

Вкладка отображается, если на вкладке Selectors в поле График вы выбрали значение Столбчатая диаграмма.

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

Параметр

Описание

Минимальное значение Y и Максимальное значение Y

Масштаб оси Y.

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

Минимальное значение X и Максимальное значение X

Масштаб оси X.

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

Вкладка wrench

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

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

Параметры

Описание

Название

Название виджета.

Описание

Описание виджета.

Цвет

Цвет отображения информации:

  • по умолчанию – цвет шрифта, который используется в вашем браузере по умолчанию;
  • зеленый;
  • красный;
  • синий;
  • желтый.

Горизонтальный

Использование горизонтальной гистограммы вместо вертикальной.

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

Итоговые значения

Суммы значений.

Легенда

Отображение легенды для аналитики. По умолчанию переключатель включен.

Пустые значения в легенде

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

В начало
[Topic 265363]

Пользовательский виджет Активы

Вы можете использовать виджет АктивыПользовательский виджет для получения расширенной аналитики по активам из обработанных событий с помощью конструктора запросов. В запросе необходимо указать поле актива и соответствующее ему условие или набор условий, по которым должен вестись подсчет активов (ось Y). Также вы можете также указать одно или несколько дополнительных условий (категорий), по которым будет производиться сравнение количества активов для каждого поля.

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

Вкладка Selectors

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

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

Параметр

Описание

График

Тип графика. Доступны следующие типы графиков:

  • Круговая диаграмма.

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

  • Счетчик.

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

  • Таблица.

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

  • Сложенная столбчатая диаграмма.

    Подсчет активов выполняется по указанным категориям по всем выбранным тенантам с возможностью группировки по тенантам (в этом случае отдельные тенанты располагаются по оси X). Каждой категории соответствует своя область на столбцах диаграммы, выделенная отдельным цветом. Названия категорий отображаются в легенде. С помощью флажков слева от названий категорий можно скрыть или показать соответствующие области на столбцах.

Формат

Параметр доступен для графика типа Сложенная столбчатая диаграмма. Формат отображения данных: Абсолютные значения или Относительные значения, %. При выборе формата Абсолютные значения высота столбцов диаграммы соответствует сумме значений измеряемого показателя. При выборе формата Относительные значения, % все столбцы имеют одинаковую высоту 100%, а размеры цветных областей столбца соответствуют процентному соотношению между значениями показателя.

По умолчанию выбрано Абсолютные значения.

Тенант

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

Категория активов

Категория активов, для которой отображаются данные на виджете.

Искать в активах без категории

Параметр позволяет отображать активы без категории.

По умолчанию флажок не установлен.

Группа параметров Выбор осей графика

Ось Y

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

Категория оси Y

Категория для выбранного поля. Не используется для графика типа Счетчик. Параметр является необязательным для полей оси Y, значения которых являются перечислением (могут выбираться из конечного списка значений). Для всех остальных полей параметр является обязательным.

Группировка по тенантам

Параметр доступен для графика типа Сложенная столбчатая диаграмма. Задает дополнительную группировку активов по тенантам. Если флажок установлен, активы на диаграмме разбиваются по оси X на столбцы, соответствующие отдельным тенантам. Если флажок не установлен, все активы отображаются на одном столбце. По умолчанию флажок не установлен.

Вкладка wrench

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

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

Параметр

Описание

Название

Название виджета.

Описание

Описание виджета.

Итоговые значения

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

Цвет

Параметр доступен для графика типа Счетчик. Цвет отображения информации:

  • по умолчанию – цвет шрифта, который используется в вашем браузере по умолчанию;
  • зеленый;
  • красный;
  • синий;
  • желтый.

Горизонтальный

Использование горизонтальной гистограммы вместо вертикальной.

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

Легенда

Отображение легенды для аналитики. По умолчанию переключатель включен.

Пустые значения в легенде

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

Десятичные знаки

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

Шкала

Доступно для графика типа Сложенная столбчатая диаграмма. Шкала для отображения данных. Возможны следующие значения:

  • Линейная.
  • Квадратичная.
  • Логарифмическая.

По умолчанию выбрано значение Линейная.

В начало
[Topic 294568]

Другие виджеты

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

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

  • Круговая диаграмма (pie).
  • Счетчик (counter).
  • Таблица (table).
  • Столбчатая диаграмма (bar1).
  • Календарная диаграмма (bar2).
  • Линейная диаграмма.
  • Сложенная столбчатая диаграмма.

Параметры для круговых диаграмм

В таблице ниже представлены параметры для графиков типа Круговая диаграмма.

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

Параметр

Описание

Название

Название виджета.

Описание

Описание виджета.

Тенант

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

Период

Период, за который отображаются данные на виджете. По умолчанию выбрано Как на макете – отображаются данные за период, выбранный для макета.

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

  • Выбрать точные дату и время начала и окончания периода в календаре и нажать на кнопку Применить.
  • Выбрать период относительно настоящего времени в списке Относительный период.
  • Указать значение вручную: выбрать точные дату и время или относительный период либо использовать комбинацию этих способов.

Подробнее см. ниже в подразделе Настройка значения периода.

Итоговые значения

Суммы значений.

Легенда

Отображение легенды для аналитики. По умолчанию переключатель включен.

Пустые значения в легенде

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

Десятичные знаки

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

Параметры для счетчиков

В таблице ниже представлены параметры для графиков типа Счетчик.

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

Параметр

Описание

Название

Название виджета.

Описание

Описание виджета.

Тенант

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

Период

Период, за который отображаются данные на виджете. По умолчанию выбрано Как на макете – отображаются данные за период, выбранный для макета.

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

  • Выбрать точные дату и время начала и окончания периода в календаре и нажать на кнопку Применить.
  • Выбрать период относительно настоящего времени в списке Относительный период.
  • Указать значение вручную: выбрать точные дату и время или относительный период либо использовать комбинацию этих способов.

Подробнее см. ниже в подразделе Настройка значения периода.

Параметры для таблиц

В таблице ниже представлены параметры для графиков типа Таблица.

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

Параметр

Описание

Название

Название виджета.

Описание

Описание виджета.

Тенант

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

Период

Период, за который отображаются данные на виджете. По умолчанию выбрано Как на макете – отображаются данные за период, выбранный для макета.

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

  • Выбрать точные дату и время начала и окончания периода в календаре и нажать на кнопку Применить.
  • Выбрать период относительно настоящего времени в списке Относительный период.
  • Указать значение вручную: выбрать точные дату и время или относительный период либо использовать комбинацию этих способов.

Подробнее см. ниже в подразделе Настройка значения периода.

Показывать данные за предыдущий период

Включение отображения данных сразу текущий и предыдущий периоды.

Цвет

Цвет отображения информации:

  • по умолчанию – цвет шрифта, который используется в вашем браузере по умолчанию;
  • зеленый;
  • красный;
  • синий;
  • желтый.

Десятичные знаки

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

Параметры для столбчатых, сложенных столбчатых и календарных диаграмм

В таблице ниже представлены параметры для графиков типа Столбчатая диаграмма и Календарная диаграмма, расположенные на вкладке Actions.

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

Параметр

Описание

Минимальное значение Y и Максимальное значение Y

Масштаб оси Y.

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

Минимальное значение X и Максимальное значение X

Масштаб оси X.

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

Десятичные знаки

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

В таблице ниже представлены параметры для графиков типа Столбчатая диаграмма, Сложенная столбчатая диаграмма и Календарная диаграмма, расположенные на вкладке wrench.

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

Параметр

Описание

Название

Название виджета.

Описание

Описание виджета.

Тенант

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

Период

Период, за который отображаются данные на виджете. По умолчанию выбрано Как на макете – отображаются данные за период, выбранный для макета.

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

  • Выбрать точные дату и время начала и окончания периода в календаре и нажать на кнопку Применить.
  • Выбрать период относительно настоящего времени в списке Относительный период.
  • Указать значение вручную: выбрать точные дату и время или относительный период либо использовать комбинацию этих способов.

Подробнее см. ниже в подразделе Настройка значения периода.

Показывать данные за предыдущий период

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

Цвет

Цвет отображения информации:

  • по умолчанию – цвет шрифта, который используется в вашем браузере по умолчанию;
  • зеленый;
  • красный;
  • синий;
  • желтый.

Горизонтальный

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

Итоговые значения

Суммы значений.

Легенда

Отображение легенды для аналитики. По умолчанию переключатель включен.

Пустые значения в легенде

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

Длительность отрезков периода

Длительность отрезков, на которые требуется делить период. Доступно для графика типа Календарная диаграмма.

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

Для графиков типа Круговая диаграмма, Счетчик, Таблица, Столбчатая диаграмма, Сложенная столбчатая диаграмма, Календарная диаграмма вы можете настроить период отображения данных на виджете с помощью параметра Период. По умолчанию период отображения данных в виджете совпадает с периодом отображения данных на панели мониторинга.

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

  • При необходимости измените дату и время в параметре Период одним из следующих способов:
    • Если вы хотите указать точную дату, в календаре слева выберите даты начала и окончания периода и нажмите на кнопку Применить.

      Вы можете выбрать дату до текущей включительно. Формат даты и времени зависит от параметров вашего браузера. Если в поле Дата от или Дата до есть значение и вы не меняли вручную значение времени, при выборе даты в календаре в поле Дата от автоматически подставится время 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 дней прошлого месяца.

  • Если вы хотите отобразить на виджете данные за период, выбранный для макета, вы можете нажать на кнопку Сбросить. При изменении периода отображения данных на макете, также изменится отображаемый на виджете период.

В начало
[Topic 221919]

Отображение названий тенантов в виджетах типа Активный лист

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

Процесс настройки состоит из следующих этапов:

  1. Экспорт списка тенантов.
  2. Создание словаря типа Таблица.
  3. Импорт списка тенантов, полученного на шаге 1, в словарь, созданный на шаге 2 этой инструкции.
  4. Добавление в корреляционное правило локальной переменной с функцией dict для распознания имени тенанта по идентификатору.

    Пример:

    • Переменная: TenantName.
    • Значение: dict('<Название ранее созданного словаря с тенантами>', TenantID).
  5. Добавление в корреляционное правило действия Установить, с помощью которого значение ранее созданной переменной будет записываться в активный лист в формате <ключ> – <значение>. В качестве ключа следует задать поле активного листа (например, Тенант), а в поле значения указать переменную (например, $TenantName).

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

В начало
[Topic 254498]