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