Руководство оператора#

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

Термины и сокращения#

Раздел доступен в документе «Общее описание продукта Platform V Monitor (OPM)». В таблице ниже приведен перечень терминов и определений касающихся только компонента BAMN

Термины	Определение
BAMN	Компонент Business activity monitoring (BAMN) входящий в состав продукта Platform V Monitor (OPM). Сервис, предназначенный для сбора событий бизнес-процессов
Администратор проекта	Роль пользователя в BAMN с соответствующими разрешениями
Суперадминистратор	Роль пользователя в BAMN с соответствующими разрешениями
Дашборд	Интерактивная информационная панель
BPMN	Business Process Model and Notation

Доступ к приложению#

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

Администратор проекта;
Суперадминистратор.

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

Откройте новую вкладку в браузере.
Перейдите по ссылке для входа (она зависит от вида установки, ссылка для входа настраивается в конфигурационном файле, подробнее в инструкции по установке)
В поле "Имя пользователя" (Login) введите ваш логин.Аутентификация производится на стороне Platform V IAM(IAM).
В поле "Пароль" (Password) введите ваш пароль.
Нажмите кнопку "Вход" (Log In)

После входа необходимо в левой боковой панели выбрать из списка интерфейс BAMN

Использование приложения оператором#

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

Сценарий использования	Раздел руководства оператора
Просмотр проектов и процессов Platform V Flow (BPM) пользовательского подключения	Управление сбором событий
Просмотр пользовательских проектов и процессов Platform V Flow (BPM) на дашбордах	Настройки дашборда
Создание пользовательского подключения	Создание нового подключения
Блокировка событий по процессам проектов Platform V Flow (BPM) пользовательского подключения	Управление сбором событий
Инициализация подключения для процессов с неустановленным владельцем	Создание подключения с неустановленным владельцем
Просмотр проектов Platform V Flow (BPM) и процессов с неустановленным владельцем	Управление сбором событий
Просмотр проектов и процессов Platform V Flow (BPM) с неустановленным владельцем на дашбордах	Настройки дашборда
Блокировка событий по процессам проектов Platform V Flow (BPM) с неустановленным владельцем	Управление сбором событий
Просмотр журнала подключений	Просмотр журнала подключений

Предварительные условия#

Предварительно перед созданием новых подключений бизнес-мониторинга необходимо произвести настройку компонентов системы (см.Руководство по установке Platform V Monitor BAMN). Для создания нового источника данных и его настройки необходимо выбрать в разделе Configuration пункт Data Sources.

В разделе Data Sources необходимо выбрать подходящий источник данных из предлагаемых на выбор. Пример на изображении: "Abyss UI Datasource".

После того, как источник выбран, необходимо заполнить все элементы формы, переключателем определяем настройки http. Если подключение (BAMN) планируется сделать по умолчанию, то необходимо перевести переключатель Default в активное состояние. После заполнения всех элементов формы необходимо нажать «Save&test», далее будет проведена проверка соединения и в случае успеха новое подключение будет создано. Адрес(URL) необходимо уточнить у администратора стенда. Нужно обратить внимание, что сервис Platform V Monitor Indicator (INDA) по умолчанию развертывается вместе с istio который самостоятельно формирует запросы по протоколу HTTPs, потому в настройках адрес указывается через http://(some url).

Создание нового подключения#

Для создания нового подключения необходимо перейти во вкладку "Управление подключениями" и нажать кнопку «Создать подключение».

В форме создания подключений выбрать проект Abyss – например, "bam" (или любой другой доступный проект), ввести идентификатор проекта и нажать «Создать подключение». Данные с указанным идентификатором будут поступать в индекс выбранного проекта Abyss.

Создание подключения с неустановленным владельцем#

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

Изменение и удаление подключений#

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

Управление сбором событий#

В разделе "Управление сбором событий" отображаются проекты и процессы пользовательского подключения, а также проекты и процессы с неустановленным владельцем. В интерфейсе предусмотрена возможность управления сбором событий (фильтрации данных используемых подключений) проектов и процессов (в том числе с неустановленным владельцем) Platform V Flow (BPM). Для этого необходимо на вкладке "Управление сбором событий" выбрать проект (верхний уровень иерархии), раскрыть его до составляющих (процессов), выбрать проект целиком или один из процессов внутри и нажать «Выключить» (отключается хранение событий для проекта, либо для процесса в проекте).

Включение компонентов подключения производится в обратном порядке нажатием кнопки «Включить».

Просмотр журнала подключений#

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

"Действие" - в данном столбце отражаются непосредственно шаги операции по установке/удаления подключения. Полный перечень шагов подключений представлен в разделе "Описание шагов создания подключения".
"Проект Abyss" - в данном столбце отображается наименование проекта Abyss".
"Идентификатор подключения" - в данном столбце отображаются идентификаторы подключения (project_id)
"Дата начала" - в данном столбце отображается дата начала шага по установке подключения.
"Дата завершения" - в данном столбце отображается дата окончания шага по установке подключения.
"Длительность" - Временная разница между столбцами "Дата начала" и "Дата завершения".

Описание шагов создания подключения#

Шаги операции в случае создания новой сущности в Platform V Monitor Abyss(LGDB) (шаги операции выполняются последовательно):

Проверка существования проекта в Platform V Monitor Abyss (LGDB) ;
Проверка на отсутствие активного подключения по переданному project_id;
Запрос на создание топика в Platform V Monitor Abyss (LGDB) ;
Запрос на создание ACL;
Запрос на создание задачи индексации (datasource);
Сохранение подключения в БД BAMN.

Шаги операции без создания новой сущности в Platform V Monitor Abyss (LGDB):

Проверка существования проекта в Platform V Monitor Abyss (LGDB).

Управление дашбордами#

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

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

Настройки дашборда#

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

Для того, чтобы обновить данные, нажмите на кнопку , а кнопка позволяет включить автообновление и настроить период автообновления. Для выбора варианта дашборда (пункт 2. Раздел "Управление дашбордами") нажмите на кнопку "Dashboard links".

Описание метрик#

Есть две группы метрик: одна группа относится к процессам, вторая – к шагам процесса. Каждая группа содержит одни и те же метрики, относящиеся либо к процессу, либо к шагу процесса:

№	Процесс	Шаг процесса	Описание
1	Количество начатых процессов	Количество запусков шага	Количество запущенных процессов/шагов процессов в течение выбранного периода
2	Количество успешных процессов	Количество успешных выполнений шага процесса	Количество процессов/шагов процессов, выполнение которых было завершено без ошибок
3	Количество ошибочных процессов	Количество ошибочных вызовов шага процесса	Количество процессов/шагов процессов, выполнение которых было завершено с ошибкой
4	Средняя длительность успешных процессов	Средняя длительность успешных выполнений шагов процесса	Среднее время выполнения процессов/шагов процессов из метрики 2

Вариант 1.

Вариант 2.

Вариант 3.

Тепловая карта#

В блоке отображается BPMN-схема процесса.
Чтобы увидеть тепловую карту, необходимо перевести переключатель "Показать карту" во включенное состояние.
Тепловая карта показывает, какие шаги процесса наиболее часто (наиболее длительно) проходятся.
Для выбора отображаемого параметра выберите "По частоте" или "По длительности".
Цветовая гамма – в зависимости от графика («по частоте» или «по длительности») показывает как часто или как долго выполнялся шаг процесса, относительно других шагов.

Часто встречающиеся проблемы и пути их устранения#

Работа при недоступности Apache Kafka (является частью внешней системы Platform V Flow (BPM), интеграция происходит путем настройки параметра BAM_KAFKA_SERVERS, который находится в файле custom_property.conf.yml(См. Руководство по установке BAMN)). Pull processing (BAMN) следит за появлением новой конфигурации в Platform V Pangolin при ее появлении, начинает в постоянном режиме, в соответствии с конфигурацией, вычитывать сообщения из Apache Kafka (Platform V Flow (BPM)).При недоступности Apache Kafka в процессе работы,Pull processing (BAMN) повторно направит запрос на вычитку сообщений из Apache Kafka (Platform V Flow (BPM)) до момента выполнения процедуры.
Работа при недоступности Platform V Monitor Abyss (LGDB). Selector, в соответствии с конфигурацией, выполняет выборку данных с помощью API Platform V Monitor Abyss и возвращает их в Indicator. В случае недоступности Platform V Monitor Abyss, возвращается ошибка и необходимо ждать восстановления работоспособности Platform V Monitor Abyss (LGDB). Уведомление от Platform V Monitor Abyss (LGDB) в Selector не предусмотрено. Для получения результата необходим повторно направлять запросы.
Ошибка аутентификации. При отсутствии соответствующих прав пользователю может быть отказано в доступе к проектам. Для получения доступа необходимо обратиться к администратору сервиса авторизации.
Ошибка создания конфигурации. Administrator сохраняет информацию о созданной конфигурации в БД BAMN. В случае недоступности БД BAMN процедура не будет завершена корректно и пользователю будет возвращена ошибка создания конфигурации. Для успешного выполнения необходимо повторить процесс создания конфигурации после восстановления работоспособности БД BAMN.

Параметры настройки#

Группа	Показывает и управляет подключениями Platform V Flow (BPM)
Управление подключениями	Показывает и управляет подключениями Platform V Flow (BPM)
Управление событиями	Показывает список проектов с возможностью фильтрации
Журнал подключений	Показывает действия совершаемые с подключением

Параметр	Группа	Пользовательские роли	Ограничения
Создание подключений	Управление подключениями	Администратор	Отсутствуют
Удаление подключений	Управление подключениями	Администратор	Отсутствуют
Установка подключения по умолчанию	Управление подключениями	Администратор	Отсутствуют
Показать архивные подключения	Управление подключениями	Администратор	Отсутствуют
Скрыть архивные подключения	Управление подключениями	Администратор	Отсутствуют
Включить проект	Управление событиями	Администратор	Отсутствуют
Выключить проект	Управление событиями	Администратор	Отсутствуют
Установка количества событий за промежуток времени	Управление событиями	Администратор	Макс.значение – «За неделю» Мин.значение – «За минуту»
Включение процесса	Управление событиями	Администратор	Отсутствуют
Выключение процесса	Управление событиями	Администратор	Отсутствуют

Правила эксплуатации#

Правила эксплуатации среды функционирования#

В ВAMN отсутствует программное обеспечение, влияющее на защищаемую информацию программного компонента.

Правила эксплуатации внешних программных средств защиты информации#

В состав BAMN не входят отдельные программные и/или программно-аппаратные средства защиты информации.

Принципы безопасной работы BAMN#

Принципы безопасной работы Platform V Monitoring BAMN:

в Сервисе исключена возможность прямого обращения неавторизованного пользователя к защищенным ресурсам по известному URL;
доступ к любым ресурсам возможен только после проведения процедуры аутентификации и авторизации;
в сервисе реализована ролевая модель, позволяющая предоставить пользователю строго ограниченный список действий;
хранение критичной информации (учетные записи, пароли, пути к конфигурационным файлам и пр.) в Сервисе запрещено;
учетные данные пользователей хранятся в защищенном виде в удаленной системе аутентификации, доступа к учетным данным пользователей из Platform V Monitoring BAMN нет.

Принципы безопасной работы в среде платформы приложений-контейнеров:

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