Работа с VRL-сниппетами
Данный раздел описывает процесс работы с VRL-сниппетами в системе R-Vision SIEM. Работа осуществляется в разделе Инструменты → Сниппеты веб-интерфейса системы.
| Раздел доступен администраторам, пользователям, которые имеют соответствующее разрешение в составе своих ролей, а также учетным записям со статусом Суперадминистратор. |
О сниппетах
Сниппет — это компонент системы, предназначенный для хранения шаблонов кода на языке VRL и их использования в VRL-программах.
Применение сниппетов ускоряет процесс написания программ, позволяя многократно использовать одни и те же фрагменты кода. Например, если один и тот же фрагмент кода планируется использовать в нескольких программах, его можно сохранить в виде сниппета, а затем с помощью этого сниппета добавить его в нужные места программ.
Вставка фрагмента кода из сниппета осуществляется в конфигурациях элементов экспертизы.
Интерфейс раздела
Панель инструментов раздела включает в себя следующие компоненты:
-
Кнопка Создать (
) позволяет создать новый сниппет. -
Поле Поиск предназначено для быстрого поиска сниппетов в отображаемом списке по названию.
В рабочей области отображается таблица имеющихся сниппетов. Колонки таблицы представлены следующим образом:
-
Название — имя сниппета, используемое для его идентификации в системе.
-
Описание — краткое описание функциональности сниппета.
-
Дата создания — дата и время создания сниппета.
-
Дата изменения — дата и время последнего изменения сниппета.
При выборе сниппета в правой части рабочей области отображается его карточка с детальной информацией.
В верхней части карточки имеется иконка (
). При нажатии на эту иконку открывается выпадающее меню, предлагающее опции для изменения и удаления сниппета.
Карточка отображает общие сведения о сниппете:
-
ID — уникальный идентификационный код сниппета, генерируемый автоматически при его создании.
-
Название — имя сниппета, используемое для его идентификации в системе.
-
Описание — краткое описание функциональности сниппета.
-
ID тенанта — уникальный идентификационный код тенанта, к которому относится сниппет.
-
Дата создания — дата и время создания сниппета.
-
Создал — пользователь, инициировавший создание сниппета.
-
Дата изменения — дата и время последнего изменения сниппета.
-
Изменил — пользователь, выполнивший последнее изменение сниппета.
В нижней части карточки расположена кнопка Просмотр для просмотра конфигурации сниппета.
При работе с таблицей сниппетов доступны следующие операции:
-
Поиск сниппетов по полю Название.
-
Сортировка сниппетов по полям Название, Дата создания и Дата изменения.
-
Настройка отображения таблицы сниппетов.
Работа со сниппетами
Доступные операции над сниппетами:
Создание сниппета
Чтобы создать сниппет:
-
Перейдите в раздел Инструменты → Сниппеты. Система отобразит сведения об имеющихся сниппетах.
-
Нажмите на кнопку Создать (
). Отобразится окно создания сниппета. -
Введите название сниппета. Название должно быть уникальным в рамках системы.
-
При необходимости введите описание сниппета.
-
Введите фрагмент кода на языке VRL, который будет храниться в сниппете.
-
Нажмите на кнопку Создать. Система создаст новый сниппет и отобразит уведомление о его добавлении. Сниппет отобразится в списке раздела Инструменты → Сниппеты и станет доступен для вставки в элементах экспертизы.
Просмотр сниппета
Чтобы просмотреть сниппет:
-
Перейдите в раздел Инструменты → Сниппеты. Система отобразит сведения об имеющихся сниппетах.
-
Нажмите на строку сниппета в списке. Система отобразит в правой части экрана карточку этого сниппета с подробной информацией о нем.
Название сниппета отображается в верхней части карточки.
Чтобы закрыть карточку, нажмите на крестик в ее правом верхнем углу.
Карточка отображает общие сведения о сниппете:
-
ID — уникальный идентификационный код сниппета, генерируемый автоматически при его создании.
-
Название — имя сниппета, используемое для его идентификации в системе.
-
Описание — краткое описание функциональности сниппета.
-
ID тенанта — уникальный идентификационный код тенанта, к которому относится сниппет.
-
Дата создания — дата и время создания сниппета.
-
Создал — пользователь, инициировавший создание сниппета.
-
Дата изменения — дата и время последнего изменения сниппета.
-
Изменил — пользователь, выполнивший последнее изменение сниппета.
-
-
Чтобы просмотреть конфигурацию сниппета, нажмите на кнопку Просмотр в нижней части карточки. Откроется окно просмотра его настроек.
Изменение сниппета
Чтобы изменить сниппет:
-
Перейдите в раздел Инструменты → Сниппеты. Система отобразит сведения об имеющихся сниппетах.
-
Нажмите на строку сниппета в списке. Система отобразит в правой части экрана карточку этого сниппета с подробной информацией о нем.
-
Выберите опцию Изменить в выпадающем меню Действия (
) в верхней части карточки сниппета. Отобразится окно настроек сниппета.Вы также можете перейти в режим изменения настроек сниппета из окна просмотра его конфигурации. Для этого нажмите на кнопку Изменить в правом нижнем углу окна конфигурации сниппета. -
Внесите требуемые изменения в поля сниппета.
-
Нажмите на кнопку Сохранить. Система сохранит измененные данные сниппета и отобразит соответствующее уведомление.
Удаление сниппета
Чтобы удалить сниппет:
-
Перейдите в раздел Инструменты → Сниппеты. Система отобразит сведения об имеющихся сниппетах.
-
Нажмите на строку сниппета в списке. Система отобразит в правой части экрана карточку этого сниппета с подробной информацией о нем.
-
Выберите опцию Удалить в выпадающем меню Действия (
) в верхней части карточки сниппета. Подтвердите удаление сниппета. Система отобразит уведомление об удалении выбранного сниппета, и сниппет исчезнет из списка раздела Инструменты → Сниппеты.
