Сигналы
В данном разделе документации содержится информация о Сигналах и способах работы с ними.
Сигнал - это динамический сигнал тревоги, имеющий время начала и время завершения. Сигнализирует о выходе какого-либо параметра из штатного состояния и в основном предназначен для дедупликации первичных событий. Так как сигнал имеет начало и конец своего существования, поэтому нельзя открыть сигнал повторно после его закрытия, необходимо открывать новый сигнал.
Сигнал обладает следующими свойствами:
- ID - общесистемный идентификатор сигнала
- Время начала - время создания сигнала
- Время завершения - время закрытия сигнала
- Критичность (приоритет) - уровень важности сигнала (неизменяемое свойство сигнала).
- Связанные КЕ - связанные с сигналом конфигурационные единицы
- Связанные первичные события - связанные с сигналом события из внешних источников (события открытия, подтверждения или закрытия сигнала)
- Метки - специальные поля, расширяющие возможности классификации и фильтрации сигналов
- Пользовательские тэги - дополнительные поля для категоризации сигналов
- Владелец - рабочая группа, которой принадлежит сигнал
Управление сигналами, а именно создание сигнала, связь сигнала с КЕ, обогащение метками и тэгами, а также закрытие сигналов осуществляется в сценариях автоматизации.
Дополнительно, в интерфейсе управления сигналами существует возможность ручного управления сигналом:
- Закрытие открытого сигнала
- Привязка к сигналу конфигурационных единиц
- Добавление или удаление тэгов
Экран управления сигналами
Для работы с новой сущностью Сигналы реализована новая вкладка Сигналы в интерфейсе работы с картами ресурсно-сервисной модели Monq.
При переходе на вкладку Сигналы, пользователю доступны все сигналы, удовлетворяющие условиям фильтрации и для которых у пользователя есть права. По умолчанию сигналы фильтруются в рамках выбранной карты РСМ и связанными с конфигурационными единицами сигналами.
На вкладке Сигналы загруженные результаты по сигналам представлены в виде таблицы, где в качестве полей отображаются свойства сигналов. Информация в таблице автоматически обновляется используя технологию WebSockets.
Таблица сигналов
Загруженные в результате фильтрации сигналы представлены в виде таблицы, где в качестве полей (столбцов) отображается информация о свойствах сигнала.
Пользователям доступна возможность изменять состав и порядок столбцов в таблице, используя форму настройки представления ("шестеренка" в правом верхнем углу).
При клике средней кнопкой мыши по сигналу в таблице - будет открыта новая вкладка с детальной информацией о сигнале.
Критичность сигнала
В качестве основного атрибута сигнала, определяющего его важность является Критичность. Данный атрибут нельзя изменить после создания сигнала.
Модель критичности представлена 6-ю степенями в разной цветовой дифференциации:
- 1 Fatal
- 2 Critical
- 3 Major
- 4 Warning
- 5 Info
- 6 Unknown (устанавливается в случаях, если при создании сигнала атрибут критичности не входит в интервал от 1 до 5)
Статус сигнала
- Статус является обязательным атрибутом сигнала
- Модель статуса состоит из значений
Open
иClosed
- Открытый сигнал можно принудительно закрыть через API или вручную в интерфейсе
- Закрытый сигнал повторно открыть нельзя
Название сигнала
- Название - обязательное свойство сигнала
- Не является уникальным
- Назначается при создании сигнала и остается неизменным
Описание сигнала
- Название - необязательное свойство сигнала
- Не является уникальным
- Назначается при создании сигнала и остается неизменным
Дата создания
- Дата создания устанавливается при создании сигнала автоматически
Дата закрытия
- Дата закрытия устанавливается при закрытии сигнала автоматически
Длительность
Длительность - время жизни сигнала от даты создания до даты закрытия, если сигнал уже закрыт или до текущего времени, если сигнал еще открыт
РГ владелец сигнала
Владелец сигнала - обязательный атрибут, назначаемый при создании сигнала и остается неизменным
Связанные КЕ
- Связанные КЕ - необязательный атрибут сигнала
- К сигналу может быть привязано неограниченное количество конфигурационных единиц
- Конфигурационные единицы можно привязать при создании сигнала или на протяжении всего времени существования сигнала
- Конфигурационные единицы можно привязать только в том случае, если владельцем КЕ и владельцем сигнала является одна Рабочая группа
Связанные события
- Связанные события - необязательный атрибут сигнала
- В таблице сигналов отображается информация о количестве привязанных событий, типе и времени последнего события
- Просмотреть привязанные события можно в карточке сигнала
- Событие может быть привязано как на этапе создания сигнала, так и во время жизни данного сигнала
- События можно привязать только используя API сигналов
- Модель связанного события состоит из:
- Тело события
- Дата привязки события
- Источник события (маршрутный узел)
- Тип события (
Opening
,Confirming
,Closing
)
- Отвязать событие от сигнала нельзя
Связанные метки
- Метки - необязательный атрибут сигнала
- Метки сигналов устанавливаются через методы API Сигналов
- Управление метками через интерфейс пользователя не предусматривается
- В табличном представлении сигналов метки несут только информационных характер
Связанные тэги
- Тэги - необязательный атрибут сигнала
- Тэг - общесистемный объект в рамках всего пространства пользователя, доступный для указания в качестве атрибута сигнала
- Связанные с одним сигналом тэги должны быть уникальными
- Привязать и отвязать существующий, или создать новый тэг для сигнала можно в соответствующем поле таблицы сигналов или в сценарии
Фильтрация и поиск сигналов
На вкладке управления сигналами доступна форма фильтрации сигналов по основным атрибутам.
- Фильтрация по КЕ
- Фильтрация по статусу сигнала
- Фильтрация по критичности сигнала
- Фильтрация сигналов по времени последних изменений
- Фильтрация по длительности сигнала
- Фильтрация по владельцу сигнала
- Фильтрация по тэгам
- Отображение сигналов непривязанных к КЕ
- Поиск сигналов по имени, описанию и идентификатору сигнала
Создание и закрытие Сигналов
Создание сигналов реализуется при помощи сценариев автоматизации и специальных блоков функций, работающих с публичным API Сигналов.
Например, создание сигнала осуществляется при помощи функции CreateSignalExpanded
:
Обязательными параметрами при создании сигнала являются:
- Название сигнала
(string)
- Владелец сигнала
(string)
Необязательными параметрами сигнала при создании могут быть:
Критичность
(integer)
Описание
(string)
Метки
(object)
Связанные КЕ
(массив ID КЕ)
(к Сигналу можно привязать только активные КЕ)Компоненты КЕ (если компонент не указан, Сигнал будет привязан к общему компоненту -
Common
)Теги
(массив моделей тэгов)
Связанные события
(массив моделей событий)
Чтобы закрыть открытый сигнал необходимо воспользоваться функцией фильтрации сигналов FilterSignalExpanded
, чтобы найти необходимый сигнал и получить его идентификатор.
Для непосредственно закрытия сигнала используется соответствующая функция CloseSignal
, в которую передается параметр - идентификатор сигнала.
Полное описание существующих функций по работе с сигналами доступно в разделе документации Автоматизация - Функции
Ручное создание сигнала
Чтобы создать Сигнал вручную, перейдите на экран управления Сигналами и в правом верхнем углу нажмите кнопку Создать - Сигнал.
Заполните значения формы создания:
И нажмите кнопку Создать Сигнал.
После создания Сигнала выберите необходимую конфигурационную единицу в списке КЕ. Если Сигнал создан без привязки к КЕ - настройте соответствующим образом фильтр отображения Сигналов без КЕ.
Массовое закрытие сигналов
Чтобы выполнить закрытие нескольких сигналов, необходимо выделить нужные сигналы и в контекстном меню массовых операций выбрать пункт "Закрыть (кол-во сигналов)".
При попытке закрытия выбранных сигналов, будут закрыты только те, для которых у пользователя есть права на редактирование. В подтверждающем окне будет указано актуальное количество сигналов, которые будут закрыты, с учетом прав.
Детальная информация о сигнале
При выборе какого-либо сигнала в таблице, отображается нижняя панель с детальной информацией о сигнале:
В панели отображается расширенная информация о сигнале:
- Идентификатор сигнала
- Наименование сигнала
- Описание сигнала
- Текущий статус
- Уровень критичности
- Продолжительность
- Связанные конфигурационные единицы
- Название
- Текущий статус
- Информация о здоровье
- Связанные первичные события
- Тип события (
Opening
,Confirmed
,Closing
) - Время события
- Содержимое события
- Тип события (
- Метки сигнала - в JSON-формате
- Связанные действия
- Правило
- Действие
- Метод оповещения
- Текст оповещения
- Информация о вложениях (скриншоты провалившихся сборок автотестов)
- Ссылки на внешние или внутренние ресурсы
- Тэги сигнала
- Информация об инициаторе создания сигнала (сценарий автоматизации/пользователь)
Действия над сигналом
В панели детальной информации о сигнале, пользователям доступны функции управления сигналами:
Управления связанными с сигналом конфигурационными единицами и компонентами
Закрытие сигнала
Закрыть можно только открытый сигнал. Повторно открыть закрытый сигнал нельзя.
Возможность поделиться сигналом (скопировать ссылку на сигнал)
Добавление ссылок к сигналу (например в "Базу знаний")
Управление тэгами для дополнительной классификации