Работа с дашбордами

Данный раздел описывает процесс работы с виджетами и дашбордами в системе. Работа осуществляется в разделе Дашборды веб-интерфейса системы.

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

О дашбордах

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

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

Интерфейс раздела

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

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

Справа от названия дашборда отображаются следующие кнопки:

  • Кнопка plus позволяет добавить новый дашборд.

  • Кнопка import позволяет импортировать дашборды в систему.

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

  • Кнопка Добавить виджет (plus) позволяет создать новый виджет на текущем дашборде.

  • Кнопка edit позволяет изменить текущий дашборд.

  • Кнопка trash позволяет удалить текущий дашборд.

  • Кнопка export позволяет экспортировать дашборд в формате JSON.

  • Кнопка file plus позволяет сохранить дашборд как схему.

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

  • Описание дашборда (при наличии) предоставляет краткую информацию о его функциональности.

  • Кнопка Переменные (variable) позволяет открыть боковую панель для задания переменных, которые можно использовать в RQL-запросах виджетов.

  • Кнопка maximize предназначена для расширения панели дашбордов на всю страницу браузера.

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

  • refresh — для обновления данных виджета.

  • more vertical — для изменения или удаления виджета, а также скрытия или отображения его легенды.

Работа с дашбордами

Доступные операции над дашбордами:

Добавление дашборда

Создать дашборд можно следующими способами:

  • Добавить дашборд и виджеты вручную.

  • Использовать предварительно созданную схему.

Создание дашборда вручную

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

  1. Перейдите в раздел Дашборды.

  2. Нажмите на кнопку Добавить дашборд в верхней части экрана. Отобразится окно создания дашборда.

  3. Введите название дашборда.

  4. При необходимости введите описание дашборда.

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

  6. Нажмите на кнопку Добавить. Система создаст новый дашборд и отобразит соответствующее уведомление. Дашборд отобразится в выпадающем списке в верхней части раздела Дашборды. Система автоматически откроет добавленный дашборд для просмотра.

После создания дашборда добавьте в него необходимые виджеты.

Создание дашборда из схемы

Чтобы создать дашборд из схемы:

  1. Перейдите в раздел Дашборды.

  2. Нажмите на кнопку Добавить дашборд в верхней части экрана. Отобразится окно создания дашборда.

  3. Выберите из выпадающего списка схему дашборда.

    Если до выбора схемы были заполнены название и описание дашборда, они будут заменены на данные из схемы.

  4. Сопоставьте переменные виджетов с источниками информации — хранилищем событий или активным списком в зависимости от типа виджетов.

  5. При необходимости введите название и описание дашборда вместо заполненных значений из схемы.

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

  7. Нажмите на кнопку Добавить. Система создаст новый дашборд и отобразит соответствующее уведомление. Дашборд отобразится в выпадающем списке в верхней части раздела Дашборды. Система автоматически откроет добавленный дашборд для просмотра.

Просмотр дашборда

Чтобы просмотреть дашборд:

  1. Перейдите в раздел Дашборды.

  2. Нажмите на стрелку вниз в верхней части раздела. Отобразится выпадающий список дашбордов.

  3. Выберите требуемый дашборд из списка. Система отобразит виджеты, содержащиеся на дашборде.

Расширение дашборда на полный экран

Чтобы раскрыть дашборд на всю страницу браузера:

  1. Перейдите в раздел Дашборды.

  2. Нажмите на стрелку вниз в верхней части раздела. Отобразится выпадающий список дашбордов.

  3. Выберите требуемый дашборд из списка. Система отобразит виджеты, содержащиеся на дашборде.

  4. Нажмите на кнопку maximize в правом верхнем углу раздела. Содержимое дашборда будет расширено на всю страницу браузера.

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

В расширенном режиме кнопка maximize меняется на minimize и предназначена для возвращения дашборда в обычный режим отображения.

Задание переменных

Переменные можно использовать в RQL-запросах при построении виджетов событий и виджетов активных списков.

Чтобы задать переменные:

  1. Перейдите в раздел Дашборды.

  2. Нажмите на стрелку вниз в верхней части раздела. Отобразится выпадающий список дашбордов.

  3. Выберите требуемый дашборд из списка. Система отобразит виджеты, содержащиеся на дашборде.

  4. Нажмите на кнопку Переменные (variable) в верхней части раздела. Система отобразит в правой части экрана панель настройки переменных.

  5. Задайте аргументы и значения переменных.

    Чтобы добавить переменную:

    1. Нажмите на кнопку Добавить. Появится строка настройки переменной.

    2. Введите аргумент переменной. Аргумент может содержать только латинские буквы (A—​Z, a—​z) и цифры (0—​9).

    3. Выберите тип значения переменной. Доступные типы:

      • Строка;

      • Число;

      • Дата;

      • Логическое.

    4. Укажите значение переменной. Способ задания значения зависит от его типа:

      • Строка и Число — введите значение вручную.

      • Дата — введите значение вручную или задайте с помощью панели выбора даты и времени.

      • Логическое — выберите значение из выпадающего списка: True или False.

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

  6. Нажмите на кнопку Применить, чтобы применить заданные переменные и перестроить дашборд с учетом их значений.

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

Чтобы сбросить примененную переменную, нажмите на кнопку close справа от нее в верхней части рабочей области.

Чтобы сбросить сразу все переменные, выполните одно из действий:

  • Нажмите на кнопку Сбросить все (close) в верхней части рабочей области.

  • Нажмите на кнопку Сбросить все в нижней части панели настроек переменных.

Изменение дашборда

Чтобы изменить дашборд:

  1. Перейдите в раздел Дашборды.

  2. Нажмите на стрелку вниз в верхней части раздела. Отобразится выпадающий список дашбордов.

  3. Выберите требуемый дашборд из списка. Система отобразит виджеты, содержащиеся на дашборде.

  4. Нажмите на кнопку edit в верхней части раздела. Отобразится окно изменения дашборда.

  5. Внесите изменения в требуемые поля.

  6. Нажмите на кнопку Сохранить. Система сохранит изменения и отобразит соответствующее уведомление.

Настройка доступности дашборда

Только пользователь, создавший дашборд, может изменить его доступность.

Чтобы настроить доступность дашборда:

  1. Перейдите в раздел Дашборды.

  2. Нажмите на стрелку вниз в верхней части раздела. Отобразится выпадающий список дашбордов.

  3. Выберите требуемый дашборд из списка. Система отобразит виджеты, содержащиеся на дашборде.

  4. Нажмите на кнопку edit в верхней части раздела. Отобразится окно изменения дашборда.

  5. Настройте доступность дашборда:

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

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

  6. Нажмите на кнопку Сохранить. Система сохранит изменения настроек и отобразит соответствующее уведомление. Обновленная информация отобразится на панели инструментов.

Удаление дашборда

Чтобы удалить дашборд:

  1. Перейдите в раздел Дашборды.

  2. Нажмите на стрелку вниз в верхней части раздела. Отобразится выпадающий список дашбордов.

  3. Выберите требуемый дашборд из списка. Система отобразит виджеты, содержащиеся на дашборде.

  4. Нажмите на кнопку Удалить дашборд в верхней части раздела. Отобразится окно подтверждения удаления дашборда.

  5. Нажмите на кнопку Удалить. Система удалит дашборд и отобразит соответствующее уведомление. Удаленный дашборд будет исключен из выпадающего списка дашбордов. Система автоматически откроет первый дашборд из списка на просмотр.

Вместе с дашбордом также удаляются и все добавленные на него виджеты.

Импорт дашборда

Чтобы импортировать дашборд:

  1. Перейдите в раздел Дашборды.

  2. Нажмите на кнопку Импорт (import) в верхней части экрана. Отобразится окно импорта дашборда.

  3. Нажмите на кнопку Выбрать файл и выберите файл дашборда для импорта. Для импорта доступны только файлы формата JSON размером не более 10 МБ.

  4. Нажмите на кнопку Импортировать. Система импортирует дашборд и отобразит соответствующее уведомление. Новый дашборд появится в выпадающем списке дашбордов.

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

Экспорт дашборда

Чтобы экспортировать дашборд:

  1. Перейдите в раздел Дашборды.

  2. Нажмите на стрелку вниз в верхней части раздела. Отобразится выпадающий список дашбордов.

  3. Выберите требуемый дашборд из списка. Система отобразит виджеты, содержащиеся на дашборде.

  4. Нажмите на кнопку Экспорт (export) в верхней части экрана. Отобразится окно экспорта дашборда.

  5. Нажмите на кнопку Экспортировать. Система загрузит данные дашборда на устройство пользователя в формате JSON и отобразит соответствующее уведомление.

Сохранение дашборда как схемы

Чтобы сохранить дашборд как схему:

  1. Перейдите в раздел Дашборды.

  2. Нажмите на стрелку вниз в верхней части раздела. Отобразится выпадающий список дашбордов.

  3. Выберите требуемый дашборд из списка. Система отобразит виджеты, содержащиеся на дашборде.

  4. Нажмите на кнопку Схема (file plus) в верхней части экрана. Отобразится окно создания схемы.

    Чтобы создать схему на основе дашборда, дашборд должен содержать хотя бы один виджет.

  5. По умолчанию название и описание создаваемой схемы идентичны названию и описанию дашборда. При необходимости измените название и описание схемы.

  6. Выберите из выпадающего списка каталог, в котором будет создана схема.

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

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

  8. Нажмите на кнопку Далее. Откроется окно создания схемы с заполненными данными.

  9. Задайте идентификатор схемы дашборда в поле id.

  10. При необходимости внесите изменения в поля схемы.

  11. Нажмите на кнопку Опубликовать версию. Система создаст схему дашборда и отобразит соответствующее уведомление. Новая схема появится в таблице раздела Экспертиза.

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

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

Работа с виджетами

Доступные операции над виджетами:

Добавление виджета

Пользователь может создавать виджеты следующих типов:

Добавление виджета метрик

Чтобы добавить виджет метрик:

  1. Перейдите в раздел Дашборды.

  2. Нажмите на стрелку вниз в верхней части раздела. Отобразится выпадающий список дашбордов.

  3. Выберите требуемый дашборд из списка. Система отобразит виджеты, содержащиеся на дашборде.

  4. Нажмите на кнопку Добавить виджет в верхней части раздела. Отобразится окно создания виджета.

  5. Введите название виджета.

  6. При необходимости введите описание виджета.

  7. Выберите Метрики из выпадающего списка Тип виджета.

  8. Выберите метрику для виджета из выпадающего списка:

    • Хост БД CPU — график использования ресурсов процессора (CPU) контейнерами БД.

    • Хост БД RAM — график использования ресурсов оперативной памяти (RAM) контейнерами БД.

    • Хост Коллектор CPU — график использования ресурсов процессора (CPU) контейнерами коллектора.

    • Хост Коллектор RAM — график использования ресурсов оперативной памяти (RAM) контейнерами коллектора.

    • Пайплайн EPS — график событий в секунду (EPS).

    • Пайплайн объем трафика — график объема трафика, поступающего в систему через конвейер.

    • Пайплайн ErrPS — график ошибок в секунду (ErrPS).

  9. Установите временной диапазон для виджета:

    1. Задайте количество единиц времени вручную или с помощью кнопок minus и plus.

    2. Выберите из выпадающего списка единицы времени.

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

    1. Задайте частоту обновления вручную или с помощью кнопок minus и plus.

    2. Выберите из выпадающего списка единицы времени периода.

  11. Чтобы предварительно просмотреть, как будут отображаться данные на виджете в соответствии с заданными настройками, нажмите на кнопку Обновить (refresh) в правой верхней части окна создания виджета.

  12. Нажмите на кнопку Добавить виджет. Система создаст виджет и отобразит соответствующее уведомление. Новый виджет появится на дашборде.

Добавление виджета событий

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

  1. Перейдите в раздел Дашборды.

  2. Нажмите на стрелку вниз в верхней части раздела. Отобразится выпадающий список дашбордов.

  3. Выберите требуемый дашборд из списка. Система отобразит виджеты, содержащиеся на дашборде.

  4. Нажмите на кнопку Добавить виджет в верхней части раздела. Отобразится окно создания виджета.

  5. Введите название виджета.

  6. При необходимости введите описание виджета.

  7. Выберите События из выпадающего списка Тип виджета.

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

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

    • Столбчатая диаграмма.

    • График.

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

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

    • Таблица.

    • Итоги.

  10. Задайте лимит строк для виджетов вручную или с помощью кнопок minus и plus. Лимит строк определяет максимальное количество строк, которые будут использованы для построения виджета. Допустимый диапазон лимита строк: 1 — 100 000.

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

    Лимит строк также можно задать в RQL-запросе с помощью оператора LIMIT. В этом случае лимит определяется минимальным из значений поля Лимит строк и оператора LIMIT. Например:

    • Если в поле Лимит строк задано значение 100, а в запросе указано LIMIT 20, то будет установлен лимит в 20 строк.

    • Если в поле Лимит строк задано значение 20, а в запросе указано LIMIT 100, то также будет установлен лимит в 20 строк.

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

  11. Установите временной диапазон для виджета:

    1. Задайте количество единиц времени вручную или с помощью кнопок minus и plus.

    2. Выберите из выпадающего списка единицы времени.

  12. Введите запрос на языке RQL в поле запроса.

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

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

    • Указанные переменные также будут применены к дашборду.

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

    Чтобы добавить переменную:

    1. Нажмите на кнопку Добавить. Появится строка настройки переменной.

    2. Введите аргумент переменной. Аргумент может содержать только латинские буквы (A—​Z, a—​z) и цифры (0—​9).

    3. Выберите тип значения переменной. Доступные типы:

      • Строка;

      • Число;

      • Дата;

      • Логическое.

    4. Укажите значение переменной. Способ задания значения зависит от его типа:

      • Строка и Число — введите значение вручную.

      • Дата — введите значение вручную или задайте с помощью панели выбора даты и времени.

      • Логическое — выберите значение из выпадающего списка: True или False.

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

    Чтобы использовать указанную переменную в RQL-запросе, необходимо использовать шаблон Handlebars:

    • Шаблоны для обращения к переменной типа Строка, Число или Логическое:

      • {{<variable_argument>}} — обращение к переменной с экранированием специальных символов в ее значении;

      • {{{<variable_argument>}}} — обращение к переменной без экранирования специальных символов в ее значении.

    • Шаблоны для обращения к переменной типа Дата:

      • {{sqlDateTime <variable_argument>}} — обращение к значению типа DateTime64;

      • {{sqlDateTime <variable_argument> false}} — обращение к значению типа DateTime.

    Здесь:

    • <variable_argument> — аргумент переменной.

    Если аргумент переменной содержит специальные символы или 0, то при обращении к переменной необходимо экранировать ее аргумент одинарными кавычками, например: {{'<variable_argument>'}}.
    Пример использования переменных в RQL-запросе

    Предположим, что нам необходимо получить события, отфильтрованные по значениям evo.siem и evo.core поля moduleKey.

    Чтобы передавать конкретные значения в RQL-запрос, можно создать две переменные:

    • Первая переменная:

      • Аргумент: moduleKey1.

      • Тип значения: Строка.

      • Значение: evo.siem.

    • Вторая переменная:

      • Аргумент: moduleKey2.

      • Тип значения: Строка.

      • Значение: evo.core.

    Тогда для решения поставленной задачи можно использовать следующий запрос:

    SELECT id, moduleKey, tenantId WHERE moduleKey IN ("{{moduleKey1}}","{{moduleKey2}}") ORDER BY tenantId

  13. Укажите параметры в секции Сопоставление полей.

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

    Набор доступных параметров зависит от выбранного типа диаграммы:

    • Столбчатая диаграмма и Столбчатая диаграмма с накоплением: доступны поля Легенда, Значение и Группировка (последнее поле обязательно для типа Столбчатая диаграмма с накоплением).

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

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

      Пример

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

      Запрос:

      SELECT sourceIp, type, count(id) as cnt GROUP BY sourceIp, type

      В поле Легенда указывается атрибут, возвращающий IP-адрес источника; в поле Значение указывается атрибут, возвращающий количество событий; в поле Группировка указывается атрибут, возвращающий тип события.

    • Круговая диаграмма: доступны поля Легенда и Значение.

      Пример

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

      Запрос:

      SELECT count(*) as cnt, collectorId GROUP BY collectorId

      В поле Легенда указывается атрибут, возвращающий ID коллектора; в поле Значение указывается атрибут, возвращающий количество событий.

    • График: доступны поля Ось Х, Ось Y и Группировка.

      Пример

      Необходимо построить график, показывающий зависимость количества событий от ID коллекторов.

      Запрос:

      SELECT collectorId, count(*) AS cnt WHERE collectorId like '%' GROUP BY collectorId

      В поле Ось Х указывается collectorId — атрибут, возвращающий ID коллектора; в поле Ось Y указывается cnt — псевдоним атрибута, возвращающего количество событий.

    • Итоги: доступно поле Значение.

      Пример

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

      Запрос:

      SELECT count(id) AS cnt, toStartOfHour(timestamp) as timestamp GROUP BY timestamp

      В поле Значение указывается cnt — псевдоним атрибута, возвращающего количество событий.

    • Таблица: для каждого столбца таблицы доступны по два поля: Название колонки и Атрибут из запроса.

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

      Пример

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

      Запрос:

      SELECT collectorId, count(*) AS cnt WHERE collectorId like '%' GROUP BY collectorId
      Название колонки Атрибут из запроса

      Коллектор

      collectorId — атрибут, возвращающий ID коллектора

      Количество событий

      cnt — псевдоним атрибута, возвращающего количество событий

      В поле Лимит строк указывается значение 10, что позволяет вывести в таблицу не более 10 записей.

      Лимит строк также можно указать в запросе с помощью оператора LIMIT:

      SELECT collectorId, count(*) AS cnt WHERE collectorId like '%' GROUP BY collectorId LIMIT 10

      В этом случае лимит строк в таблице определяется минимальным из значений поля Лимит строк и оператора LIMIT.

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

    1. Задайте частоту обновления вручную или с помощью кнопок minus и plus.

    2. Выберите из выпадающего списка единицы времени периода.

  15. Чтобы предварительно просмотреть, как будут отображаться данные на виджете в соответствии с заданными настройками, нажмите на кнопку Обновить (refresh) в правой верхней части окна создания виджета. Доступны два варианта предпросмотра:

    1. Диаграмма — отображает визуальное представление виджета на дашборде.

    2. Данные — отображает результаты RQL-запроса в табличной форме.

  16. Нажмите на кнопку Добавить виджет. Система создаст виджет и отобразит соответствующее уведомление. Новый виджет появится на дашборде.

Добавление виджета активного списка

Чтобы добавить виджет активного списка:

  1. Перейдите в раздел Дашборды.

  2. Нажмите на стрелку вниз в верхней части раздела. Отобразится выпадающий список дашбордов.

  3. Выберите требуемый дашборд из списка. Система отобразит виджеты, содержащиеся на дашборде.

  4. Нажмите на кнопку Добавить виджет в верхней части раздела. Отобразится окно создания виджета.

  5. Введите название виджета.

  6. При необходимости введите описание виджета.

  7. Выберите Активный список из выпадающего списка Тип виджета.

  8. Выберите активный список, из которого требуется брать информацию о записях.

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

    • Столбчатая диаграмма.

    • График.

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

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

    • Таблица.

    • Итоги.

  10. Задайте лимит строк для виджетов вручную или с помощью кнопок minus и plus. Лимит строк определяет максимальное количество строк, которые будут использованы для построения виджета. Допустимый диапазон лимита строк: 1 — 100 000.

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

    Лимит строк также можно задать в RQL-запросе с помощью оператора LIMIT. В этом случае лимит определяется минимальным из значений поля Лимит строк и оператора LIMIT. Например:

    • Если в поле Лимит строк задано значение 100, а в запросе указано LIMIT 20, то будет установлен лимит в 20 строк.

    • Если в поле Лимит строк задано значение 20, а в запросе указано LIMIT 100, то также будет установлен лимит в 20 строк.

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

  11. Установите временной диапазон для виджета:

    1. Задайте количество единиц времени вручную или с помощью кнопок minus и plus.

    2. Выберите из выпадающего списка единицы времени.

  12. Введите запрос на языке RQL в поле запроса.

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

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

    • Указанные переменные также будут применены к дашборду.

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

    Чтобы добавить переменную:

    1. Нажмите на кнопку Добавить. Появится строка настройки переменной.

    2. Введите аргумент переменной. Аргумент может содержать только латинские буквы (A—​Z, a—​z) и цифры (0—​9).

    3. Выберите тип значения переменной. Доступные типы:

      • Строка;

      • Число;

      • Дата;

      • Логическое.

    4. Укажите значение переменной. Способ задания значения зависит от его типа:

      • Строка и Число — введите значение вручную.

      • Дата — введите значение вручную или задайте с помощью панели выбора даты и времени.

      • Логическое — выберите значение из выпадающего списка: True или False.

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

    Чтобы использовать указанную переменную в RQL-запросе, необходимо использовать шаблон Handlebars:

    • Шаблоны для обращения к переменной типа Строка, Число или Логическое:

      • {{<variable_argument>}} — обращение к переменной с экранированием специальных символов в ее значении;

      • {{{<variable_argument>}}} — обращение к переменной без экранирования специальных символов в ее значении.

    • Шаблоны для обращения к переменной типа Дата:

      • {{sqlDateTime <variable_argument>}} — обращение к значению типа DateTime64;

      • {{sqlDateTime <variable_argument> false}} — обращение к значению типа DateTime.

    Здесь:

    • <variable_argument> — аргумент переменной.

    Если аргумент переменной содержит специальные символы или 0, то при обращении к переменной необходимо экранировать ее аргумент одинарными кавычками, например: {{'<variable_argument>'}}.
    Пример использования переменных в RQL-запросе

    Предположим, что нам необходимо получить события, отфильтрованные по значениям evo.siem и evo.core поля moduleKey.

    Чтобы передавать конкретные значения в RQL-запрос, можно создать две переменные:

    • Первая переменная:

      • Аргумент: moduleKey1.

      • Тип значения: Строка.

      • Значение: evo.siem.

    • Вторая переменная:

      • Аргумент: moduleKey2.

      • Тип значения: Строка.

      • Значение: evo.core.

    Тогда для решения поставленной задачи можно использовать следующий запрос:

    SELECT id, moduleKey, tenantId WHERE moduleKey IN ("{{moduleKey1}}","{{moduleKey2}}") ORDER BY tenantId

  13. Укажите параметры в секции Сопоставление полей.

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

    Набор доступных параметров зависит от выбранного типа диаграммы:

    • Столбчатая диаграмма и Столбчатая диаграмма с накоплением: доступны поля Легенда, Значение и Группировка (последнее поле обязательно для типа Столбчатая диаграмма с группировкой).

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

      Столбчатая диаграмма с накоплением позволяет сравнивать сгруппированные показатели с другими группами тех же показателей, например, распределение DDOS-атак по IP-адресам с их группировкой по типам. Столбцы значений в каждой группе расположены друг поверх друга, формируя единый столбец в рамках группы.

      Пример

      Необходимо построить диаграмму, показывающую распределение количества IP-адресов DDOS-атак по IP-адресам с их группировкой по типам.

      Запрос:

      SELECT ip, attack_type, (count(id) AS cnt GROUP BY Ip, attack_type

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

      • Легенда — ip (IP, замеченные в атаке);

      • Значение — cnt (количество записей);

      • Группировка — attack_type (тип атаки).

    • Круговая диаграмма: доступны поля Легенда и Значение.

      Пример

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

      Запрос:

      SELECT attack_type, sum(involved_attacks) AS total_attacks GROUP BY attack_type

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

      • Легенда — attack_type (тип атаки);

      • Значение — total_attacks (суммарное количество атак).

    • График: доступны поля Ось Х, Ось Y и Группировка.

      Пример

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

      Запрос:

      SELECT ip, reputation_score, sum(involved_attacks) AS total_attacks GROUP BY ip, reputation_score

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

      • Ось Х — reputation_score (оценка рейтинга);

      • Ось Y — total_attacks (суммарное количество атак).

    • Итоги: доступно поле Значение.

      Пример

      Необходимо вывести количество IP, замеченных в DDOS-атаках.

      Запрос:

      SELECT uniq(ip) AS uniq

      В поле Значение указывается uniq — псевдоним атрибута, возвращающего количество уникальных значений в столбце ip.

    • Таблица: нужно заполнить для каждого столбца таблицы по два поля: Название колонки и Атрибут из запроса. Чтобы создать новый столбец в таблице, нажмите на кнопку Добавить колонку.

      Пример

      Необходимо создать таблицу с информацией об IP-адресах из определенной подсети, замеченных в DDOS-атаках. Таблица должна быть отсортирована по времени последнего обнаружения от позднего к раннему.

      Запрос:

      SELECT ip, attack_type, involved_attacks, last_detected WHERE ip IN '192.0.2.0/24' ORDER BY last_detected DESC
      Название колонки Атрибут из запроса

      IP

      ip (атрибут, возвращающий IP источника атаки)

      Тип атаки

      attack_type

      Количество атак

      involved_attacks

      Время

      last_detected (атрибут, возвращающий метку времени последнего обнаружения)

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

    1. Задайте частоту обновления вручную или с помощью кнопок minus и plus.

    2. Выберите из выпадающего списка единицы времени периода.

  15. Чтобы предварительно просмотреть, как будут отображаться данные на виджете в соответствии с заданными настройками, нажмите на кнопку Обновить (refresh) в правой верхней части окна создания виджета. Доступны два варианта предпросмотра:

    1. Диаграмма — отображает визуальное представление виджета на дашборде.

    2. Данные — отображает результаты RQL-запроса в табличной форме.

  16. Нажмите на кнопку Добавить виджет. Система создаст виджет и отобразит соответствующее уведомление. Новый виджет появится на дашборде.

Обновление виджета

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

Обновление виджета вручную

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

  1. Перейдите в раздел Дашборды.

  2. Нажмите на стрелку вниз в верхней части раздела. Отобразится выпадающий список дашбордов.

  3. Выберите требуемый дашборд из списка. Система отобразит виджеты, содержащиеся на дашборде.

  4. Нажмите на кнопку refresh в правом верхнем углу выбранного виджета. Данные на виджете будут обновлены.

Автоматическое обновление виджета

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

  1. Перейдите в раздел Дашборды.

  2. Нажмите на стрелку вниз в верхней части раздела. Отобразится выпадающий список дашбордов.

  3. Выберите требуемый дашборд из списка. Система отобразит виджеты, содержащиеся на дашборде.

  4. Нажмите на кнопку действий (more vertical) в верхнем правом углу виджета и выберите опцию Редактировать. Отобразится окно редактирования виджета.

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

    1. Задайте частоту обновления вручную или с помощью кнопок minus и plus.

    2. Выберите из выпадающего списка единицы времени периода.

  6. Нажмите на кнопку Изменить виджет. Система сохранит измененные данные виджета. Данные на виджете будут автоматически обновляться по истечении указанного периода времени.

Изменение размеров виджета

Чтобы изменить размеры (высоту и ширину) виджета:

  1. Перейдите в раздел Дашборды.

  2. Нажмите на стрелку вниз в верхней части раздела. Отобразится выпадающий список дашбордов.

  3. Выберите требуемый дашборд из списка. Система отобразит виджеты, содержащиеся на дашборде.

  4. Наведите курсор на правый нижний угол выбранного виджета. Курсор примет вид двунаправленной стрелки.

  5. Потяните за правый нижний угол виджета:

    • вправо/влево — для изменения ширины;

    • вверх/вниз — для изменения высоты.

    Размеры виджета будут изменены.

Перемещение виджета

Чтобы переместить виджет на дашборде:

  1. Перейдите в раздел Дашборды.

  2. Нажмите на стрелку вниз в верхней части раздела. Отобразится выпадающий список дашбордов.

  3. Выберите требуемый дашборд из списка. Система отобразит виджеты, содержащиеся на дашборде.

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

  5. Перетащите виджет в нужное положение на дашборде. Виджет будет перемещен.

Изменение настроек виджета

Чтобы изменить настройки виджета:

  1. Перейдите в раздел Дашборды.

  2. Нажмите на стрелку вниз в верхней части раздела. Отобразится выпадающий список дашбордов.

  3. Выберите требуемый дашборд из списка. Система отобразит виджеты, содержащиеся на дашборде.

  4. Нажмите на кнопку действий (more vertical) в верхнем правом углу виджета и выберите опцию Редактировать. Отобразится окно редактирования виджета.

  5. Внесите изменения в требуемые поля.

  6. Нажмите на кнопку Изменить виджет. Система сохранит изменения и отобразит соответствующее уведомление. Обновленная информация отобразится на дашборде.

Настройка отображения легенды виджета

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

Легенда не отображается для виджетов событий с типом Таблица или Итоги.

Чтобы скрыть легенду, нажмите на кнопку действий (more vertical) в верхнем правом углу виджета и выберите опцию Скрыть легенду. Легенда перестанет отображаться на виджете, а диаграмма визуализации данных займет всю ширину виджета.

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

Настройка отображения рядов данных виджета

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

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

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

Просмотр деталей ряда данных виджета

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

Просмотр событий ряда данных

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

  • Столбчатая диаграмма.

  • График.

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

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

На виджетах должна быть задана группировка только по одному атрибуту (например: GROUP BY collectorId).

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

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

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

  1. Перейдите в раздел Дашборды.

  2. Нажмите на стрелку вниз в верхней части раздела. Отобразится выпадающий список дашбордов.

  3. Выберите требуемый дашборд из списка. Система отобразит виджеты, содержащиеся на дашборде.

  4. Нажмите на кнопку действий (more vertical) в верхнем правом углу виджета и выберите опцию Создать копию. Система создаст копию виджета и отобразит соответствующее уведомление. Новый виджет появится на дашборде в конце списка.

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

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

  1. Перейдите в раздел Дашборды.

  2. Нажмите на стрелку вниз в верхней части раздела. Отобразится выпадающий список дашбордов.

  3. Выберите требуемый дашборд из списка. Система отобразит виджеты, содержащиеся на дашборде.

  4. Нажмите на кнопку действий (more vertical) в верхнем правом углу виджета и выберите опцию Удалить. Система отобразит окно подтверждения удаления виджета.

  5. Нажмите на кнопку Удалить. Система удалит виджет и отобразит соответствующее уведомление. Удаленный виджет исчезнет с дашборда.

Экспорт виджета

Чтобы экспортировать виджет:

  1. Перейдите в раздел Дашборды.

  2. Нажмите на стрелку вниз в верхней части раздела. Отобразится выпадающий список дашбордов.

  3. Выберите требуемый дашборд из списка. Система отобразит виджеты, содержащиеся на дашборде.

  4. Нажмите на кнопку Экспорт (export) в правом верхнем углу выбранного виджета. Отобразится окно экспорта виджета.

  5. Нажмите на кнопку Экспортировать. Система загрузит данные виджета на устройство пользователя в формате CSV и отобразит соответствующее уведомление.

+7 (499) 755 55 70 sales@rvision.ru

О компании Пользовательское соглашение Политика cookies