Kaspersky Symphony XDR: Open Single Management Platform

Содержание

Аналитика

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

  • События в хранилище
  • Алерты
  • Активы
  • Учетные записи, импортированные из Active Directory
  • Сведения из коллекторов о количестве обработанных событий
  • Метрики

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

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

  • Английская локализация: ГГГГ-ММ-ДД.
  • Русская локализация: ДД.ММ.ГГГГ.

В этом разделе справки

Панель мониторинга

Отчеты

Виджеты

В начало
[Topic 217736]

Панель мониторинга

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

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

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

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

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

Для удобства представления данных на панели мониторинга вы можете включить режим ТВ. В этом случае вы перейдете в режим полноэкранного просмотра панели мониторинга в FullHD-разрешении. В режиме ТВ вы также можете настроить показ слайд-шоу для выбранных макетов.

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

Создание макета панели мониторинга

Выбор макета панели мониторинга

Выбор макета панели мониторинга в качестве макета по умолчанию

Редактирование макета панели мониторинга

Удаление макета панели мониторинга

Включение и отключение режима ТВ

Предустановленные макеты панели мониторинга

В начало
[Topic 217827]

Создание макета панели мониторинга

Развернуть все | Свернуть все

Чтобы создать макет:

  1. Откройте веб-интерфейс Open Single Management Platform и выберите раздел Панель мониторинга.
  2. Откройте раскрывающийся список в правом верхнем углу окна Панель мониторинга и выберите Создать макет.

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

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

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

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

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

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

    Время в 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 или укажите точные дату и время.

  5. В раскрывающемся списке Обновлять каждые выберите частоту обновления данных в веб-виджетах макета:
    • никогда – не обновлять данные в веб-виджетах макета.
    • 1 минута.
    • 5 минут.
    • 15 минут.
    • 1 час (это значение выбрано по умолчанию).
    • 3 часа.
    • 6 часов.
    • 12 часов.
    • 24 часа.
  6. В раскрывающемся списке Добавить веб-виджет выберите требуемый веб-виджет и настройте его параметры. Вы можете добавить несколько веб-виджетов. Веб-виджеты можно перетаскивать по окну и изменять их размер с помощью кнопки DashboardResize, которая появляется при наведении указателя мыши на веб-виджет.

    Для веб-виджетов с типами графиков Круговая диаграмма, Столбчатая диаграмма, Линейная диаграмма, Счетчик и Календарная диаграмма существуют следующие ограничения:

    • В запросах SELECT можно использовать поля расширенной схемы событий с типами "Строка", "Число" и "Число с плавающей точкой".
    • В запросах WHERE можно использовать поля расширенной схемы событий со всеми типами ("Строка", "Число", "Число с плавающей точкой", "Массив строк", "Массив чисел" и "Массив чисел с плавающей точкой").

    Для веб-виджетов с типом графика Таблица в запросах SELECT можно использовать поля расширенной схемы событий со всеми типами ("Строка", "Число", "Число с плавающей точкой", "Массив строк", "Массив чисел" и "Массив чисел с плавающей точкой").

    Вы можете выполнять следующие действия с веб-виджетами:

    • Добавлять веб-виджеты.

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

      1. В раскрывающемся списке Добавить веб-виджет выберите нужный веб-виджет.

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

      2. Настройте параметры веб-виджета и нажмите на кнопку Добавить.
    • Редактировать веб-виджеты.

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

      1. Наведите указатель мыши на нужный веб-виджет и нажмите на появляющийся значок gear.
      2. В раскрывающемся списке выберите значение Изменить.

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

      3. Измените параметры веб-виджета и нажмите Сохранить.

    Вы можете редактировать и удалять добавленные веб-виджеты, наведя на них курсор мыши, нажав появившийся значок gear, после чего выбрав Изменить или Удалить.

  7. В поле Название макета введите уникальное имя макета. Должно содержать от 1 до 128 символов в кодировке Unicode.
  8. При необходимости нажмите на значок gear справа от поля названия макета и установите флажки напротив дополнительных параметров макета:
    • Универсальный – если вы установите этот флажок, в веб-виджетах макета будут отображаться данные из тенантов, которых вы выберите в разделе Выбрано тенантов, расположенном в меню слева. Это означает, что данные в веб-виджетах макета будут меняться в зависимости от выбранных вами тенантов, при этом вам не придется редактировать параметры макета. Для универсальных макетов тенанты, выбранные в раскрывающемся списке Тенанты, не учитываются.

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

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

      Универсальные макеты могут создавать и редактировать только главные администраторы. Просматривать такие макеты могут все пользователи.

    • Отображать данные по КИИ – если вы установите этот флажок, в веб-виджетах макета будут в том числе отображаться данные об активах, алертах и инцидентах, имеющих отношение к критической информационной инфраструктуре (КИИ). При этом такие макеты будут доступы для просмотра только пользователям, в параметрах которых установлен флажок Доступ к объектам КИИ.

      Если флажок не установить, в веб-виджетах макета не будут отображаться данные об активах, алертах и инцидентах, относящихся к КИИ, даже если у пользователя есть доступ к объектам КИИ.

  9. Нажмите Сохранить.

Новый макет создан и отображается в разделе Панель мониторинга веб-интерфейса Open Single Management Platform.

В начало
[Topic 252198]

Выбор макета панели мониторинга

Чтобы выбрать макет панели мониторинга:

  1. Раскройте список в верхнем правом углу окна Панель мониторинга.
  2. Выберите нужный макет.

Выбранный макет отобразится в разделе Панель мониторинга веб-интерфейса KUMA.

В начало
[Topic 217992]

Выбор макета панели мониторинга в качестве макета по умолчанию

Чтобы выбрать макет, который будет отображаться на панели мониторинга по умолчанию:

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

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

В начало
[Topic 217993]

Редактирование макета панели мониторинга

Чтобы отредактировать макет панели мониторинга:

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

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

  5. Внесите необходимые изменения. Параметры, доступные для изменения, аналогичны параметрам, доступным при создании макета.
  6. Нажмите на кнопку Сохранить.

Макет панели мониторинга будет изменен и отобразится в разделе Панель мониторинга веб-интерфейса KUMA.

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

В начало
[Topic 217855]

Удаление макета панели мониторинга

Чтобы удалить макет:

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

Макет будет удален.

В начало
[Topic 217835]

Включение и отключение режима ТВ

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

Чтобы включить режим ТВ:

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

    Откроется окно Параметры.

  3. Переведите переключатель Режим ТВ в положение Включено.
  4. Если вы хотите настроить показ макетов в режиме слайд-шоу, выполните следующие действия:
    1. Переведите переключатель Слайд-шоу в положение Включено.
    2. В поле Время ожидания укажите, через сколько секунд должно происходить переключение макетов.
    3. В раскрывающемся списке Очередь выберите макеты для просмотра. Если не выбран ни один макет, в режиме слайд-шоу будут по очереди отображаться все макеты, доступные пользователю.
    4. Если требуется, измените порядок показа макетов, перетаскивая их с помощью кнопки DragIcon.
  5. Нажмите на кнопку Сохранить.

Режим ТВ будет включен. Чтобы вернуться к работе с веб-интерфейсом KUMA, нужно отключить режим ТВ.

Чтобы отключить режим ТВ:

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

    Откроется окно Параметры.

  3. Переведите переключатель Режим ТВ в положение Выключено.
  4. Нажмите на кнопку Сохранить.

Режим ТВ будет отключен. В левой части экрана отобразится панель с разделами веб-интерфейса KUMA.

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

В начало
[Topic 230361]

Предустановленные макеты панели мониторинга

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

Предустановленные макеты

Название макета

Описание веб-виджетов в составе макета

Alerts Overview (Обзор алертов)

  • Active alerts (Активные алерты) – количество незакрытых алертов.
  • Unassigned alerts (Неназначенные алерты) – количество алертов со статусом Новый.
  • Latest alerts (Последние алерты) – таблица с информацией о последних 10 незакрытых алертах, принадлежащих выбранным в макете тенантам.
  • Alerts distribution (Распределение алертов) – количество алертов, созданных в течение указанного для веб-виджета периода.
  • Alerts by priority (Алерты по уровню важности) – количество незакрытых алертов, сгруппированных по уровню важности.
  • Alerts by assignee (Алерты по исполнителю) – количество алертов со статусом Назначен. Сгруппированы по имени учетной записи.
  • Alerts by status (Алерты по статусу) – количество алертов, имеющих статус Новый, Открыт, Назначен или Эскалирован. Сгруппированы по статусу.
  • Affected users in alerts (Затронутые пользователи) – количество пользователей, связанных с алертами, имеющими статус Новый, Назначен или Эскалирован. Сгруппированы по имени учетной записи.
  • Affected assets (Затронутые активы) – таблица с информацией об уровне важности активов и количестве незакрытых алертов, с которыми они связаны.
  • Affected assets categories (Затронутые категории активов) – категории активов, привязанных к незакрытым алертам.
  • Top event source by alerts number (Топ источников событий по количеству алертов) – количество алертов со статусом Новый, Назначен или Эскалирован, сгруппированных по источнику алерта (поле события DeviceProduct). На веб-виджете отображается не более 10 источников событий.
  • Alerts by rule (Количество алертов по правилу) – количество алертов со статусом Новый, Назначен или Эскалирован, сгруппированных по правилам корреляции.

Incidents Overview (Обзор инцидентов)

  • Active incidents (Активные инциденты) – количество незакрытых инцидентов.
  • Unassigned Incidents (Неназначенные инциденты) – количество инцидентов со статусом Открыт.
  • Latest Incidents (Последние инциденты) – таблица с информацией о последних 10 незакрытых инцидентах, принадлежащих выбранным в макете тенантам.
  • Incidents distribution (Распределение инцидентов) – количество инцидентов, созданных в течение указанного для веб-виджета периода.
  • Incidents by priority (Инциденты по уровню важности) – количество незакрытых инцидентов, сгруппированных по уровню важности.
  • Incidents by assignee (Инциденты по исполнителю) – количество инцидентов со статусом Назначен. Сгруппированы по имени учетной записи пользователя.
  • Incidents by status (Инциденты по статусам) – количество инцидентов, сгруппированных по статусу.
  • Affected assets in incidents (Активы в инцидентах) – количество активов, связанных с незакрытыми инцидентами.
  • Affected users in incidents (Пользователи в инцидентах) – пользователи, связанные с инцидентами.
  • Affected asset categories in incidents (Категории активов в инцидентах) – категории активов, связанных с незакрытыми инцидентами.
  • Active incidents by tenant (Инциденты по тенантам) – количество инцидентов всех статусов, сгруппированных по тенантам.

Network Overview (Обзор сетевой активности)

  • Netflow top internal IPs (Топ внутренних IP-адресов по полученному netflow-трафику) – суммарный размер полученного активом netflow-трафика в байтах. Данные сгруппированы по внутренним IP-адресам активов.
  • На веб-виджете отображается не более 10 IP-адресов.
  • Netflow top external IPs (Топ внешних IP-адресов по полученному netflow-трафику) – суммарный размер полученного активом netflow-трафика в байтах. Данные сгруппированы по внешним IP-адресам активов.
  • Netflow top hosts for remote control (Топ активов, на которые были обращения на порты для удаленного управления) – количество событий, связанных с обращением на один из следующих портов: 3389, 22, 135. Данные сгруппированы по именам активов.
  • Netflow total bytes by internal ports (Топ внутренних портов по приему netflow-трафика) – количество байт, переданное на внутренние порты активов. Данные сгруппированы по номерам портов.
  • Top Log Sources by Events count (Топ источников событий) – 10 источников, от которых было получено наибольшее количество событий.

[OOTB] KATA & EDR

  • KATA. Top-10 detections by type – визуализирует 10 самых распространенных типов событий, выявленных системой KATA.
  • KATA. Top-10 detections by file type – визуализирует 10 самых распространенных типов файлов, выявленных системой KATA.
  • KATA. Top-10 user names in detections – визуализирует 10 самых распространенных имен пользователей, выявленных системой KATA.
  • KATA. Top-10 IDS detections – визуализирует 10 самых распространенных угроз, выявленных модулем IDS системы KATA.
  • KATA. Top-10 URL detections – визуализирует 10 самых распространенных подозрительных URL-адресов, выявленных системой KATA.
  • KATA. Top-10 AV detections – визуализирует 10 самых распространенных угроз, выявленных модулем антивируса системы KATA.
  • EDR. Top-10 MITRE technique detections – визуализирует 10 самых распространенных техник матрицы MITRE ATT&CK, выявленных системой EDR.
  • EDR. Top-10 MITRE tactic detections – визуализирует 10 самых распространенных тактик матрицы MITRE ATT&CK, выявленных системой EDR.

[OOTB] KSC

  • KSC. Top-10 users with the most KAV alerts – визуализирует 10 самых распространенных имен пользователей, присутствующих в событиях, связанных с выявлением вредоносного программного обеспечения, сведения о которых содержатся в системе KSС.
  • KSC. Top-10 most common threats – визуализирует 10 самых распространенных типов вредоносного программного обеспечения, сведения о которых содержатся в системе KSС.
  • KSC. Number of devices that received AV database updates – визуализирует количество устройств, на которых были установлены обновления антивирусных баз данных, сведения о которых содержатся в системе KSС.
  • KSC. Number of devices on which the virus was found – визуализирует количество устройств, на которых было выявлено вредоносное программное обеспечение, сведения о которых содержатся в системе KSС.
  • KSC. Malware detections by hour – визуализирует распределение по часам количества вредоносного программного обеспечения, сведения о которых содержатся в системе KSС.

[OOTB] KSMG

  • KSMG. Top-10 senders of blocked emails – визуализирует 10 самых распространенных отправителей писем, заблокированных системой KSMG.
  • KSMG. Top-10 events by action – визуализирует 10 самых распространенных действий, выполненных системой KSMG.
  • KSMG. Top-10 events by outcome – визуализирует 10 самых распространенных результатов действий, выполненных системой KSMG.
  • KSMG. Blocked emails by hour – визуализирует распределение по часам количества писем, заблокированных системой KSMG.

 

[OOTB] KWTS

  • KWTS. Top-10 IP addresses with the most blocked web traffic – визуализирует 10 самых распространенных IP-адресов, трафик с которых был заблокирован системой KWTS.
  • KWTS. Top-10 IP addresses with the most allowed web traffic – визуализирует 10 самых распространенных IP-адресов, трафик с которых был разрешен системой KWTS.
  • KWTS. Top 10 requests by client application – визуализирует 10 самых распространенных приложений, использовавшихся для доступа к сетевым ресурсам, выявленных системой KWTS.
  • KWTS. Top-10 blocked URLs – визуализирует 10 самых распространенных URL-адресов, трафик с которых был разрешен системой KWTS.
  • KWTS. System action types – визуализирует 10 самых распространенных действий, выполненных системой KWTS.
  • KWTS. Top-10 users with the most allowed web traffic – визуализирует 10 самых распространенных имен пользователей, трафик которых был разрешен системой KWTS.

[OOTB] KSMG files and hashes*

  • KSMG. Top-5 blocked hashes – визуализирует 5 самых распространенных хешей файлов в письмах, заблокированных системой KSMG.
  • KSMG. Top-5 net-transferred hashes – визуализирует 5 самых распространенных "чистых" хешей файлов в письмах, отслеженных системой KSMG.
  • KSMG. Top-5 clean file names – визуализирует 5 самых распространенных "чистых" имен файлов в письмах, отслеженных системой KSMG.
  • KSMG. Top-5 blocked files – визуализирует 5 самых распространенных имен файлов в письмах, заблокированных системой KSMG.

[OOTB] KSMG rules and URLs*

  • KSMG. Top-5 rules – визуализирует 5 самых распространенных сработанных правил системы KSMG.
  • KSMG. Top-5 URLs – визуализирует 5 самых распространенных доменов из ссылок в письмах, отслеженных системой KSMG.

[OOTB] KSMG results*

  • KSMG. All results in the last 24 hours – визуализирует распределение по часам действий, выполненных системой KSMG за сутки.
  • KSMG. Top-5 results – визуализирует 5 самых распространенных действий, выполненных системой KSMG.

[OOTB] KSMG e-mail subjects and accounts*

  • KSMG. Top-5 e-mail subjects – визуализирует 5 самых распространенных тем писем, отслеженных системой KSMG.
  • KSMG. Top-5 source accounts – визуализирует 5 самых распространенных аккаунтов отправителей писем, отслеженных системой KSMG.
  • KSMG. Top-5 destination accounts – визуализирует 5 самых распространенных аккаунтов получателей писем, отслеженных системой KSMG.

*Панели мониторинга доступны начиная с KUMA 3.4.1. Виджеты будут корректно отображать информацию при использовании нормализатора [OOTB] KSMG 2.1+ syslog CEF.

В начало
[Topic 222445]

Отчеты

В KUMA можно настроить регулярное формирование отчетов о процессах приложения.

Отчеты формируются с помощью шаблонов отчетов, которые созданы и хранятся на вкладке Шаблоны раздела Отчеты.

Сформированные отчеты хранятся на вкладке Сформированные отчеты раздела Отчеты.

Для возможности сохранять сформированные отчеты в форматах HTML и PDF необходимо установить требуемые пакеты на устройстве с Ядром KUMA.

При развертывании KUMA в отказоустойчивом варианте временная зона сервера Ядра приложения и время в браузере пользователя могут различаться. Это различие проявляется в расхождении времени, которое проставляется в отчетах, сформированных по расписанию, и данных, которые пользователь может экспортировать из веб-виджетов. Чтобы избежать расхождения, рекомендуется настроить расписание формирования отчетов с учетом разницы временной зоны пользователей и временем UTC.

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

Шаблон отчета

Сформированные отчеты

В начало
[Topic 217966]

Шаблон отчета

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

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

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

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

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

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

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

  • Расписание – периодичность, с которой отчеты должны формироваться по созданным шаблонам. Если расписание отчета не настроено, отображается значение выключено.
  • Создал – имя пользователя, создавшего шаблон отчета.
  • Последнее обновление – дата последнего обновления шаблона отчета.

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

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

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

  • Создать отчет – используйте эту команду, чтобы немедленно сформировать отчет. Созданные отчеты отображаются на вкладке Сформированные отчеты.
  • Изменить расписание – используйте эту команду, чтобы настроить расписание для формирования отчетов и определить пользователей, которые должны получать уведомления по электронной почте о сформированных отчетах.
  • Изменить шаблон отчета – используйте эту команду, чтобы настроить веб-виджеты и период времени, за который должна быть извлечена аналитика.
  • Дублировать шаблон отчета – используйте эту команду, чтобы создать копию существующего шаблона отчета.
  • Удалить шаблон отчета – используйте эту команду, чтобы удалить шаблон отчета.

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

Создание шаблона отчета

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

Изменение шаблона отчета

Копирование шаблона отчета

Удаление шаблона отчета

В начало
[Topic 217965]

Создание шаблона отчета

Развернуть все | Свернуть все

Чтобы создать шаблон отчета:

  1. Откройте веб-интерфейс KUMA и выберите раздел ОтчетыШаблоны.
  2. Нажмите на кнопку Новый шаблон.

    Откроется окно Новый шаблон отчета.

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

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

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

    Время в 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 или укажите точные дату и время.

  5. В поле Срок хранения укажите, на протяжении какого времени следует хранить сформированные по этому шаблону отчеты.
  6. В поле Название шаблона введите уникальное название шаблона отчета. Должно содержать от 1 до 128 символов в кодировке Unicode.
  7. В раскрывающемся списке Добавить веб-виджет выберите требуемый веб-виджет и настройте его параметры. Вы можете добавить несколько веб-виджетов. Веб-виджеты можно перетаскивать по окну и изменять их размер с помощью кнопки DashboardResize, которая появляется при наведении указателя мыши на веб-виджет.

    Для веб-виджетов с типами графиков Круговая диаграмма, Столбчатая диаграмма, Линейная диаграмма, Счетчик и Календарная диаграмма существуют следующие ограничения:

    • В запросах SELECT можно использовать поля расширенной схемы событий с типами "Строка", "Число" и "Число с плавающей точкой".
    • В запросах WHERE можно использовать поля расширенной схемы событий со всеми типами ("Строка", "Число", "Число с плавающей точкой", "Массив строк", "Массив чисел" и "Массив чисел с плавающей точкой").

    Для веб-виджетов с типом графика Таблица в запросах SELECT можно использовать поля расширенной схемы событий со всеми типами ("Строка", "Число", "Число с плавающей точкой", "Массив строк", "Массив чисел" и "Массив чисел с плавающей точкой").

    Вы можете выполнять следующие действия с веб-виджетами:

    • Добавлять веб-виджеты.

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

      1. В раскрывающемся списке Добавить веб-виджет выберите нужный веб-виджет.

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

      2. Настройте параметры веб-виджета и нажмите на кнопку Добавить.
    • Редактировать веб-виджеты.

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

      1. Наведите указатель мыши на нужный веб-виджет и нажмите на появляющийся значок gear.
      2. В раскрывающемся списке выберите значение Изменить.

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

      3. Измените параметры веб-виджета и нажмите Сохранить.

    Вы можете редактировать и удалять добавленные веб-виджеты, наведя на них курсор мыши, нажав появившийся значок gear, после чего выбрав Изменить или Удалить.

  8. При необходимости можно поменять логотип шаблона отчетов с помощью кнопки Загрузить логотип.

    Если нажать на кнопку Загрузить логотип, открывается окно загрузки, в котором можно указать файл изображения для логотипа. Изображение должно быть файлом .jpg, .png или .gif размером не более 3 МБ.

    Добавленный логотип будет отображаться в отчете вместо логотипа KUMA.

  9. При необходимости установите флажок Отображать данные по КИИ, чтобы в веб-виджетах макета в том числе отображались данные об активах, алертах и инцидентах, имеющих отношение к критической информационной инфраструктуре (КИИ). При этом такие макеты будут доступы для просмотра только пользователям, в параметрах которых установлен флажок Доступ к объектам КИИ.

    Если флажок не установить, в веб-виджетах макета не будут отображаться данные об активах, алертах и инцидентах, относящихся к КИИ, даже если у пользователя есть доступ к объектам КИИ.

  10. Нажмите Сохранить.

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

В начало
[Topic 217811]

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

Чтобы настроить расписание отчетов:

  1. Откройте веб-интерфейс KUMA и выберите раздел ОтчетыШаблоны.
  2. В таблице шаблонов отчета нажмите имя шаблона отчета и в раскрывающемся списке выберите Изменить расписание.

    Откроется окно Параметры отчета.

  3. Если вы хотите, чтобы отчет формировался регулярно:
    1. Включите переключатель Расписание.

      В группе настроек Повторять каждый задайте периодичность создания отчетов.

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

    2. В поле Время укажите время, когда должен быть сформирован отчет. Вы можете ввести значение вручную или с помощью значка часов.
  4. Чтобы выбрать формат отчетов и указать адресатов для рассылки, настройте следующие параметры:
    1. В группе настроек Отправить нажмите Добавить.
    2. В открывшемся окне Добавление адресов электронной почты в разделе Группы пользователей нажмите Добавить группу.
    3. В появившемся поле укажите адрес электронной почты и нажмите Enter или щелкните вне поля ввода - адрес электронной почты будет добавлен. Можно добавить несколько адресов. Отчеты будут отправлены по указанным адресам каждый раз, когда вы сформируете отчет вручную или KUMA сформирует отчет автоматически по расписанию.

      Чтобы сформированные отчеты можно было отправлять по электронной почте, следует настроить SMTP-соединение.

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

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

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

    4. В раскрывающемся списке выберите формат отчета для отправки. Доступные форматы: PDF, HTML, , Excel.
  5. Нажмите Сохранить.

Расписание отчетов настроено.

В начало
[Topic 217771]

Изменение шаблона отчета

Чтобы изменить шаблон отчета:

  1. Откройте веб-интерфейс KUMA и выберите раздел ОтчетыШаблоны.
  2. В таблице шаблонов отчета нажмите имя шаблона отчета и в раскрывающемся списке выберите Изменить шаблон отчета.

    Откроется окно Изменить шаблон отчета.

    Это окно также можно открыть на вкладке ОтчетыСформированные отчеты, нажав имя существующего отчета и выбрав в раскрывающемся списке Изменить шаблон отчета.

  3. Внесите необходимые изменения:
    • Измените список тенантов, которым принадлежит шаблон отчета.
    • Обновите период времени, за который вам требуется аналитика.
    • Добавьте веб-виджеты

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

      1. В раскрывающемся списке Добавить веб-виджет выберите нужный веб-виджет.

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

      2. Настройте параметры веб-виджета и нажмите на кнопку Добавить.
    • Измените расположение веб-виджетов, перетаскивая их.
    • Измените размер веб-виджетов с помощью кнопки DashboardResize, которая появляется при наведении указателя мыши на веб-виджет.
    • Отредактируйте веб-виджеты

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

      1. Наведите указатель мыши на нужный веб-виджет и нажмите на появляющийся значок gear.
      2. В раскрывающемся списке выберите значение Изменить.

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

      3. Измените параметры веб-виджета и нажмите Сохранить.
    • Удалите веб-виджеты, наведя на них указатель мыши, а затем нажав на появившийся значок gear и выбрав Удалить.
    • В поле справа от раскрывающегося списка Добавить веб-виджет введите уникальное имя шаблона отчета. Должно содержать от 1 до 128 символов в кодировке Unicode.
    • Измените логотип отчета, загрузив его с помощью кнопки Загрузить логотип. Если в шаблоне уже есть логотип, его предварительно потребуется удалить.
    • Измените срок хранения отчетов, сформированных по этому шаблону.
    • При необходимости установите или снимите флажок Отображать данные по КИИ.
  4. Нажмите Сохранить.

Шаблон отчета изменен и отображается на вкладке ОтчетыШаблоны веб-интерфейса KUMA.

В начало
[Topic 217856]

Копирование шаблона отчета

Чтобы создать копию шаблона отчета:

  1. Откройте веб-интерфейс KUMA и выберите раздел ОтчетыШаблоны.
  2. В таблице шаблонов отчета нажмите имя шаблона отчета и в раскрывающемся списке выберите Дублировать шаблон отчета.

    Откроется окно Новый шаблон отчета. Название веб-виджета изменено на <Шаблон отчета> - копия.

  3. Внесите необходимые изменения:
    • Измените список тенантов, которым принадлежит шаблон отчета.
    • Обновите период времени, за который вам требуется аналитика.
    • Добавьте веб-виджеты

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

      1. В раскрывающемся списке Добавить веб-виджет выберите нужный веб-виджет.

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

      2. Настройте параметры веб-виджета и нажмите на кнопку Добавить.
    • Измените расположение веб-виджетов, перетаскивая их.
    • Измените размер веб-виджетов с помощью кнопки DashboardResize, которая появляется при наведении указателя мыши на веб-виджет.
    • Отредактируйте веб-виджеты

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

      1. Наведите указатель мыши на нужный веб-виджет и нажмите на появляющийся значок gear.
      2. В раскрывающемся списке выберите значение Изменить.

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

      3. Измените параметры веб-виджета и нажмите Сохранить.
    • Удалите веб-виджеты, наведя на них указатель мыши, а затем нажав на появившийся значок gear и выбрав Удалить.
    • В поле справа от раскрывающегося списка Добавить веб-виджет введите уникальное имя шаблона отчета. Должно содержать от 1 до 128 символов в кодировке Unicode.
    • Измените логотип отчета, загрузив его с помощью кнопки Загрузить логотип. Если в шаблоне уже есть логотип, его предварительно потребуется удалить.
  4. Нажмите Сохранить.

Шаблон отчета создан и отображается на вкладке ОтчетыШаблоны веб-интерфейс KUMA.

В начало
[Topic 217778]

Удаление шаблона отчета

Чтобы удалить шаблон отчета:

  1. Откройте веб-интерфейс KUMA и выберите раздел ОтчетыШаблоны.
  2. В таблице шаблонов отчета нажмите имя шаблона отчета и в раскрывающемся списке выберите Удалить шаблон отчета.

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

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

Шаблон отчета удален.

В начало
[Topic 217838]

Сформированные отчеты

Все отчеты формируются с помощью шаблонов отчетов. Сформированные отчеты доступны на вкладке Сформированные отчеты в разделе Отчеты и отображаются в таблице со следующими столбцами:

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

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

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

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

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

  • Тенант – название тенанта, которому принадлежит отчет.
  • Пользователь – имя пользователя, который сформировал отчет вручную. Если отчет был сформирован по расписанию, значение будет пустым. Если отчет был сформирован в версии KUMA ниже 2.1, значение будет пустым.

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

  • Открыть отчет – используйте эту команду, чтобы открыть окно с данными отчета.
  • Сохранить как – используйте эту команду, чтобы сохранить сформированный отчет в нужном формате. Доступные форматы: HTML, PDF, CSV, разделенный CSV, Excel. По умолчанию во всех форматах выводится 250 строк. Максимальное количество значений, которые могут отображаться в таблицах в форматах PDF и HTML: 500. Если вы хотите выводить в отчет более 500 строк, задайте в SQL-запросе желаемое значение параметра LIMIT и сохраните отчет в формате CSV.
  • Создать отчет – используйте эту команду, чтобы немедленно сформировать отчет. Обновите окно браузера, чтобы увидеть вновь созданный отчет в таблице.
  • Изменить шаблон отчета – используйте эту команду, чтобы настроить веб-виджеты и период времени, за который должна быть извлечена аналитика.
  • Удалить отчет – используйте эту команду, чтобы удалить отчет.

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

Просмотр отчетов

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

Сохранение отчетов

Удаление отчетов

В начало
[Topic 217882]

Просмотр отчетов

Чтобы просмотреть отчет:

  1. Откройте веб-интерфейс KUMA и выберите раздел ОтчетыСформированные отчеты.
  2. В таблице отчета нажмите имя сформированного отчета и в раскрывающемся списке выберите Открыть отчет.

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

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

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

  3. Отчет можно сохранить в выбранном формате с помощью кнопки Сохранить как.
В начало
[Topic 217945]

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

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

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

  1. Откройте веб-интерфейс KUMA и выберите раздел ОтчетыШаблоны.
  2. В таблице шаблонов отчета нажмите имя шаблона отчета и в раскрывающемся списке выберите Создать отчет.

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

Отчет создается и помещается на вкладку ОтчетыСформированные отчеты.

Чтобы создавать отчеты автоматически, настройте расписание отчетов.

В начало
[Topic 217883]

Сохранение отчетов

Чтобы сохранить отчет в нужном формате:

  1. Откройте веб-интерфейс KUMA и выберите раздел ОтчетыСформированные отчеты.
  2. В таблице отчета нажмите имя сформированного отчета и в раскрывающемся списке выберите Сохранить как, а затем выберите нужный формат: HTML, PDF, CSV, разделенный CSV, Excel.

    Отчет сохраняется в папку загрузки, настроенную в вашем браузере.

Отчет также можно сохранить в выбранном формате при просмотре.

В начало
[Topic 217985]

Удаление отчетов

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

  1. Откройте веб-интерфейс KUMA и выберите раздел ОтчетыСформированные отчеты.
  2. В таблице отчета нажмите имя сформированного отчета и в раскрывающемся списке выберите Удалить отчет.

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

  3. Нажмите ОК.
В начало
[Topic 217837]

Виджеты

С помощью веб-виджетов вы можете осуществлять мониторинг работы приложения. Виджеты организованы в группы, каждая из которых связана с типом аналитики, которую она предоставляет. В 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. Нажмите на кнопку EditResource.

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

  5. На веб-виджете, который вы хотите отредактировать, нажмите на кнопку GearGrey.
  6. Выберите Изменить.

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

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

Виджет будет отредактирован.

В начало
[Topic 254407]

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

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

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

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

  5. На веб-виджете, который вы хотите удалить, нажмите на кнопку GearGrey.
  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.

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

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

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

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

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

WidgetCustomExample

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

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

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

Вкладка отображается, если на вкладке 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. Добавьте действие с активными листами в правило корреляции. Это действие запишет значение ранее созданной переменной в формате "ключ-значение" в активный лист с помощью функции Установить. В качестве ключа следует задать поле активного листа (например, Tenant), а в поле Value обратиться к ранее созданной переменной (например, $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.

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

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

Вкладка отображается, если на вкладке 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. Добавьте действие с активными листами в правило корреляции. Это действие запишет значение ранее созданной переменной в формате "ключ-значение" в активный лист с помощью функции Установить. В качестве ключа следует задать поле активного листа (например, Tenant), а в поле Value обратиться к ранее созданной переменной (например, $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.

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

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

Вкладка отображается, если на вкладке 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).
  • Линейная диаграмма.

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

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

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

Параметр

Описание

Название

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

Описание

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

Тенант

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

Период

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

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

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

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

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

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

Легенда

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

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

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

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

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

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

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

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

Параметр

Описание

Название

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

Описание

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

Тенант

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

Период

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

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

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

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

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

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

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

Параметр

Описание

Название

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

Описание

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

Тенант

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

Период

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

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

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

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

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

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

Цвет

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

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

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

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

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

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

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

Параметр

Описание

Минимальное значение 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]