Настройка конфигурации актива

Обратите внимание!

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

Подробнее об обновлении описано в разделе Миграция конфигурации актива

Для корректной работы обновленного алгоритма расчёта необходимо настроить взаимодействие с Postgres, подробнее описано здесь

Список конфигураций активов

Страница конфигурации актива представляет собой таблицу существующих конфигураций активов:

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

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

• Теги - список тегов
• Разрешения - ограничение конфигураций активов на чтение или запись по ролям
• Включить/Выключить - включение/выключение фоновой работы сбора активов расчетным модулем
• Статистика запусков - переход на страницу статистика запусков расчетного модуля
• Удалить - удаление конфигурацию актива

Для редактирования конфигурации можно нажать на кнопку Редактировать

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

Связи конфигураций активов

Для перехода на страницу всех связей конфигураций активов необходимо перейти на вкладку Связи.

Страница содержит в себе информацию о настроенных связях между конфигурациями активов:

Информация представлена в виде таблицы Список связей и визуализации Карта связей.

предупреждение

Связывать между собой можно только конфигурации активов с обновленным алгоритмом расчёта!

Список связей

Список связей отображает все существующие связи.

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

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

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

• Редактировать - редактирование настроек связи
• Удалить - удаление связь

Для просмотра полей связи можно нажать на иконку раскрытия строки:

Карта связей

Карта связей конфигураций активов представляет собой отображение конфигураций активов в виде узлов и их связей в виде стрелок.

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

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

примечание

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

Для отображения конфигураций только со связями можно проставить переключатель Скрыть узлы без связей.

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

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

Описание настроек конфигурации актива

Управление конфигурациями

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

примечание

Обязательными к заполнению являются поля из раздела Основное и Расписание

Перечень настроек, которые составляют создаваемую конфигурацию:

• Общие настройки - общая информация по активу
• Поля — поля, которые составляют основную информацию по активу, разделяются на базовые и дополнительные
• Источники — список источников, которые используются для создания базы активов, а также включает в себя создание правила сопоставления полей источников и базовых/дополнительных полей
• Связывание — поля источников, где настраивается их связь
• Приоритизация — правило, которое определяет приоритет извлечения базовых/дополнительных полей из источников

примечание

Обязательными к заполнению являются поля из раздела Основное и Расписание из Общие настройки

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

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

Общие настройки

Вкладка общие настройки состоит из таких разделов, как:

• Основное - содержит в себе настройки имени конфигурации и названия хранилища
• Расписание - содержит в себе настройку периодичности запуска фоновой задачи по сбору активов.
  примечание

  На выбор доступны следующие типы расписаний: Интервал или Cron-выражение

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

примечание

Параметр Имя актива поддерживает токены на основе базовых и дополнительных полей. Пример использования: $hostname$ - $os$.

В поле Время жизни актива можно ввести целое число от 1 с указанием единицы времени (s - секунды, m - минуты, h - часы, d - дни). Значение не может быть составным. Примеры: 20h, 2d, 30s.

Обратите внимание!

Раздел Настройка отображения и опция Включить репликацию данных в индекс доступны только для конфигураций с обновленным алгоритмом расчёта!

Опции параметров запуска Пакетные изменения, С использованием индекса, Объединять с пустыми и Только быстрый поиск доступны только для конфигураций со старым алгоритмом расчёта!

Обратите внимание!

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

Если индекса ранее не было, он будет создан автоматически.

Поля

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

• Базовое поле - флаг, определяющий является ли поле базовым или дополнительным

• Название поля - техническое имя поля актива, которое будет участвовать в расчётах (не может дублироваться)

• Отображаемое название (опционально) - отображаемое в интерфейсах наименование поля

• Коэффициент

  примечание

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

  Сходство определяется через коэффициент сходства k рассчитываемый по формуле k = c/(a+b-c), где:

  • c - количество совпадающих базовых полей у существующего и нового актива

  • a - количество базовых полей существующего актива

  • b - количество базовых полей нового актива.

  Активы считаются схожими, если k >= 0.5 при b <= 5 или если k >= 0.554 при b > 5. Коэффициент базового поля умножает присутствие поля в суммах a, b и c. Если коэффициент равен 0, то поле не учитывается в суммах. Если коэффициент равен 1, то поле учитывается в суммах по одному разу. Если коэффициент указан n, то поле будет учитываться в суммах n раз.

примечание

Для дополнения нового поля воспользуйтесь кнопкой Добавить поле.

Источники

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

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

• Наименование источника в активах — наименование источника

• Индекс — где хранится хранится необходимая информация

• Временной интервал — в течение какого времени производится забор информации для ограничения выборки данных из источника

  примечание

  В поле Временной интервал указывается величина интервала фильтра в виде интервала или паттерна по полю @timestamp (по умолчанию). Можно задать глобально для всех источников или определить для каждого отдельно.

  Величина интервала указывается как положительное число единиц времени, таких как 90d (90 дней), 24h (24 часа), 15m (15 минут). Поддерживаются следующие единицы времени: m - минута, h - час, d - день, w - неделя, M - месяц, y - год. Подробнее о единицах времени можно узнать в документации OpenSearch.

  Если временной интервал указан в минутах, то правая граница фильтра соответствует текущему моменту (now), иначе правая граница равна началу предыдущего часа (now-1h/h). Левая граница вычисляется как разность правой границы и временного промежутка.

  В фильтр попадают все документы источника у которых @timestamp больше или равен левой границе и меньше либо равен правой границе фильтра.

• Автоопределение агрегированных полей - при включении будут использоваться поля агрегируемого типа (по умолчанию: включено)

• Правила сопоставления полей — маппинг, по которому идёт сопоставления полей из источника и полей, которые были указаны в параметрах Базовые поля и Дополнительные поля

примечание

Для дополнения маппинга воспользуйтесь кнопкой Добавить поле.

Связывание

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

Настройка ключевого поля состоит из следующих пунктов:

• Источники для связывания — какие источники необходимо связывать, берутся из вкладки Источники
• Поля связывания — выбор полей, которые было указаны в параметрах Базовые поля и Дополнительные поля

Приоритизация

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

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

• Поле — по какому полю ведётся приоритет
• Порядок извлечения поля — извлечение поля из источника по заданному приоритету

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

примечание

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

Процесс настройки

Чтобы перейти на страницу списка конфигураций выберите пункт Активы в навигационном меню в разделе Inventory:

Для настройки конфигурации необходимо нажать на кнопку Создать или нажать на кнопку Редактировать. Так осуществляется переход к форме настройки конфигурации:

После перехода к форме необходимо заполнить поля вкладки Общие настройки, затем задать базовые и дополнительные поля во вкладке Поля:

Во вкладке Источники добавить необходимые источники и заполнить их:

Во вкладке Связывание связать источники и поля при необходимости:

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

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

Миграция конфигурации актива

примечание

Информация в этом разделе актуальна для конфигураций со старым алгоритмом расчёта

Обратите внимание!

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

При переходе в карточку конфигурации актива в верхнем углу будет присутствовать уведомление о доступном обновлении алгоритма расчёта:

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

---

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

Обратите внимание!

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

База активов переносится порциями по 10000 записей

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

В ходе миграции будет обновляться информация о прохождении миграции, её можно посмотреть нажав на уведомление. Также при необходимости можно отменить процесс миграции нажав соответствующую кнопку:

---

После завершения миграции будет выведено уведомление об успешном завершении процесса:

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

примечание

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

---

Если в процесс миграция возникла ошибка, то уведомление сменится на соответствующую:

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

Обратите внимание!

В случае возникновении ошибки или если отменить процесс миграции вручную, все данные, которые были перенесены, будут удалены!