Сигналы
В данном разделе документации содержится информация о сигналах и способах работы с ними.
Сигнал - это сигнал тревоги, имеющий свой жизненный цикл (схему ЖЦ) в рамках выбранного пространства Monq.
Сигнал предоставляет информацию о зарегистрированной проблеме в наблюдаемой информационной системе и в основном предназначен для дедупликации первичных событий и порогов метрик.
В связи с тем, что можно настраивать жизненный цикл сигналов - сигнал можно повторно открыть после его закрытия или перевести в другой, произвольный статус.
Такая возможность предусмотрена в схеме ЖЦ по умолчанию. Если по вашим требованиям повторно открывать закрытые сигналы нельзя - настройте схему ЖЦ сигналов соответствующим образом.
Сигнал обладает следующими основными свойствами:
- id - общесистемный идентификатор сигнала
- Время начала - время создания сигнала
- Время открытия - время перевода сигнала в статус с категорией «Открыт» (время начального или повторного открытия сигнала)
- Время завершения - время закрытия сигнала
- Критичность (приоритет) - уровень важности сигнала
- Ответственный - пользователь системы, ответственный за устранение аварии
- Связанные КЕ - связанные с сигналом конфигурационные единицы
- Связанные первичные события - связанные с сигналом события из внешних источников (события открытия, подтверждения или закрытия сигнала)
- Метки - специальные поля, расширяющие возможности классификации и фильтрации сигналов
- Пользовательские теги - дополнительные поля для категоризации сигналов
- Владелец - рабочая группа, которой принадлежит сигнал
В дополнение к основным свойствам сигнала пользователи системы могут добавить произвольные настраиваемые поля для сигналов, которые также называются атрибутами сигнала.
Управление сигналами, а именно создание сигнала, связь сигнала с КЕ, обогащение метками и тегами, и управление статусами сигналов осуществляется преимущественно в сценариях автоматизации. Но при этом существует возможность и ручного создания сигналов.
Пользователям 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)
- Владелец сигнала
(id рабочей группы)
Необязательными параметрами сигнала при создании могут быть:
-
Критичность
(integer)
-
Описание
(string)
-
Метки
(object)
-
Связанные КЕ
(массив id КЕ)
(к сигналу можно привязать только активные КЕ) -
Компоненты КЕ (если компонент не указан, сигнал будет привязан к общему компоненту -
Common
) -
Теги
(массив моделей тегов)
-
Связанные события
(массив моделей событий)
Чтобы закрыть открытый сигнал необходимо воспользоваться функцией фильтрации сигналов FilterSignalExpanded
, чтобы найти необходимый сигнал и получить его идентификатор.
Для непосредственно закрытия сигнала используется соответствующая функция CloseSignal
, в которую передается параметр - идентификатор сигнала.
Полное описание существующих функций по работе с сигналами доступно в разделе документации Автоматизация - Функции
Ручное создание сигнала
Чтобы создать сигнал вручную, перейдите в Оперативный центр или на Экран сигналов и в правом верхнем углу нажмите Создать - Сигнал.
Заполните значения формы создания:
И нажмите кнопку Создать.
Массовое закрытие сигналов
Чтобы выполнить закрытие нескольких сигналов, необходимо выделить нужные сигналы и в контекстном меню массовых операций выбрать пункт «Закрыть».
При попытке закрытия выбранных сигналов, будут закрыты только те, для которых у пользователя есть права на редактирование. В подтверждающем окне будет указано актуальное количество сигналов, которые будут закрыты, с учетом прав.
Детальная информация о сигнале
При выборе какого-либо сигнала в таблице, отображается нижняя панель с детальной информацией о сигнале:
В панели отображается расширенная информация о сигнале:
- Идентификатор сигнала
- Наименование сигнала
- Описание сигнала
- Текущий статус
- Уровень критичности
- Ответственный
- Продолжительность
- Связанные конфигурационные единицы
- Название
- Текущий статус
- Информация о здоровье
- Связанные первичные события
- Тип события (
Opening
,Confirmed
,Closing
) - Время события
- Содержимое события
- Тип события (
- Метки сигнала в JSON-формате
- Связанные и выполненные бизнес-процессы с возможностью перейти к конкретному экземпляру запуска
- Информация о вложениях (скриншоты провалившихся сборок автотестов)
- Ссылки на внешние или внутренние ресурсы
- Теги сигнала
- Информация об инициаторе создания сигнала (название сценарий автоматизации или имя пользователя)
Действия над сигналом
В панели детальной информации о сигнале, пользователям доступны функции управления сигналами:
-
Управления связанными с сигналом конфигурационными единицами и компонентами
-
Изменение статуса сигнала
-
Возможность поделиться сигналом (скопировать ссылку на сигнал)
-
Добавление ссылок к сигналу (например в «Базу знаний»)
-
Управление тегами для дополнительной классификации
-
Запуск бизнес-процессов относительно сигналов
Экран управления сигналами в главном меню
Отдельный экран управления сигналами предназначен для дежурных инженеров, которые работают непосредственно с авариями и им не важна связь с Ресурсно-сервисной моделью.
Главной особенностью отдельного экрана является возможность создания и сохранения карт сигналов с фильтрацией по различным атрибутам сигналов.
На экране представлены следующие элементы управления:
- Поле выбора временного интервала для отображения сигналов
- Список карт сигналов
- Кнопка создания карты сигналов
- Строка для фильтрации и поиска сигналов
- Кнопка создания сигнала
- Таблица сигналов
- Карточка, выбранного сигнала
Частота обновления таблицы с сигналами по умолчанию составляет 1 минуту.
Карты сигналов
Карты сигналов объединяют в себе настройки фильтрации сигналов и настройки персонализации отображения таблицы сигналов.
По умолчанию доступны 2 системные карты: «Все открытые» и «Все закрытые».
Расшаренные из других РГ сигналы будут отфильтрованы
Пользователи могут создать любое количество карт сигналов под свои потребности.
Упорядочивание происходит по id карты, т.о. каждая вновь созданная карта будет добавляться в конец списка.
Для создания карты сигналов перейдите на экран работы с сигналами через главное меню и выполните следующие действия:
-
Нажмите кнопку «Создать карту»
-
Заполните форму «Создание карты сигналов»
- Задайте название карты
Название карты сигналов должно быть уникально в рамках выбранной Рабочей группы
- Укажите уровень доступа к карте. Если карта сигналов должна быть доступна только вам - «Личный», если всем членам Рабочей группы - «Общий».
- Выберите «Интервал по умолчанию» для отображения сигналов в таблице
- Создайте запрос при помощи конструктора или напишите его вручную (описание формата и синтаксиса)
- При необходимости включите отображение архивных сигналов (без возможности фильтрации по ним)
- Задайте название карты
-
Настройте отображаемые свойства сигналов и их порядок в таблице
-
Нажмите кнопку «Создать»
Новая карта сигналов будет создана и появится в списке доступных карт слева от таблицы сигналов.
Редактирование карты сигналов
Любую созданную карту сигналов можно отредактировать.
Для редактирования карты сигналов нажмите на значок карандаша напротив названия карты сигналов.
В открывшемся диалоговом окне «Редактирование карты сигналов» произведите нужные изменения и нажмите «Сохранить».
Удаление карты сигналов
Любую созданную карту сигналов можно удалить.
Для удаления карты сигналов нажмите на значок карандаша напротив названия карты сигналов и в открывшемся диалоговом окне нажмите значок корзины.
В модальном окне подтвердите удаление и карта сигналов будет удалена.
Конструктор запросов
Конструктор запросов представляет из себя графическую среду создания различных условий, объединяемых логическими операторами.
Он активируется нажатием на кнопку добавления нового запроса или на уже существующий в поисковой строке, а также в окне создания новой карты сигналов.
Для создания запроса доступы следующие операторы и атрибуты сигнала:
Атрибут | Операторы | Допустимые значения |
---|---|---|
Критичность | - Равно одному из - Не равно одному из | - Fatal - Critical - Major - Warning - Info - Unknown |
Статус | - Равно одному из - Не равно одному из | Мультиселект из статусов контекстной РГ и РГ поделившихся сигналами |
Категория статуса | - Равно одному из | Мультиселект из всех категорий статусов в системе |
Длительность | - Больше - Меньше - Больше или равно - Меньше или равно | Число (положительное значение) |
Название | - Равно - Не равно - Содержит - Не содержит | Строковое поле |
Описание | - Равно - Не равно - Содержит - Не содержит | Строковое поле |
Теги | - Содержит все - Содержит любое - Не содержит любое - Пустой (поле для значения отключается) - Не пустой (поле для значения отключается) | Мультиселект из тегов |
Владелец | - Равно одному из - Не равно одному из | Мультиселект из контекстной РГ и РГ поделившихся сигналами |
Ответственный | - Равно одному из - Не равно одному из - Пустой (поле для значения отключается) - Не пустой (поле для значения отключается) | Мультиселект из пользователей контекстной РГ + пользователей РГ поделившихся сигналами |
Дата открытия | - Возможность выбрать шорткат или диапазон дат - В интервале (равно) - Возможность выбрать дату и время - После (Больше) - До (Меньше) | Датапикер/выбор шортката |
Дата закрытия | - Возможность выбрать шорткат - В интервале (равно) - Возможность выбрать дату и время - После (Больше) - До (Меньше) | Датапикер/выбор шортката |
Дата создания | - Возможность выбрать шорткат - В интервале (равно) - Возможность выбрать дату и время - После (Больше) - До (Меньше) | Датапикер/выбор шортката |
Карта PCM | - Равно одному из - Не равно одному из | - Мультиселект из общих карт, если фильтр общий - Мультиселект из общих и личных, если фильтр личный |
Связанные KE | - Сигнал связан со всеми KE из списка (Содержит все) - Сигнал связан с любой KE из списка (Равно одному из) - Сигнал не связан с любой KE из списка (Не равно одному из) - Сигнал связан хотя бы с одной KE (поле для значения отключается) (Не пустое) - Сигнал не связан ни с одной KE (поле для значения отключается) (Пустое) | Мультиселект из общих и личных KE |
Настраиваемые поля | Зависит от типа настраиваемого поля | подробнее |
Поскольку настраиваемых полей в системе может быть много, при добавлении их в качестве параметра в конструкторе запросов, можно воспользоваться строкой поиска атрибута
Созданные запросы формируются в специальные группы «Запрос А», «Запрос B», «Запрос C» и т.д. При помощи этих групп пользователи могут создавать еще более сложные запросы, объединенные логическим «И»
Запрос, созданный при помощи конструктора, можно преобразовать в строковый и еще более гибко его сконфигурировать. Произвести конвертацию обратно из строки в режим конструктора невозможно.
Для редактирования созданного конструктором запроса, необходимо кликнуть по его названию. В открывшемся окне будут отображены текущие настройки. В них можно внести изменения и нажать «Применить».
Режимы поиска сигналов
Поиск с применением только синтаксиса
Этот режим поиска возможен, если в поисковой строке присутствует двоеточие. Оно является оператором обращения к атрибуту.
Для поиска с применением синтаксиса доступны все те же атрибуты (включая настраиваемые поля), которые были описаны выше для конструктора запросов.
Такой запрос покажет все сигналы, с которыми связана хотя бы одна из КЕ с id 805 или 807 И при этом их критичность равна "Fatal".
Поиск с применением только конструктора запросов
В строке запроса может быть как один, так и несколько блочков конструктора запросов.
Примеры:
-
Такой запрос покажет все сигналы, отфильтрованные с помощью блока[Запрос А]
-
Такой запрос покажет все сигналы, отфильтрованные с помощью блоков[Запрос А]
И[Запрос В]
Если требуется поиск через условие ИЛИ, его нужно прописать вручную:
Поиск с применением конструктора запросов + синтаксиса
Варианты применения:
-
После одного или нескольких блочков запроса стоит одно условие, написанное с применением синтаксиса
-
Такой запрос покажет все сигналы, отфильтрованные с помощью блока[Запрос А]
И где критичность равна "Fatal". -
Такой запрос покажет все сигналы, отфильтрованные с помощью блоков[Запрос А]
И[Запрос B]
И где критичность равна "Fatal". -
Такой запрос покажет все сигналы, отфильтрованные с помощью блока[Запрос А]
ИЛИ где критичность сигнала равна "Fatal".
-
-
После одного или нескольких блочков запроса стоит несколько условий, написанных с применением синтаксиса
если условий несколько, применение оператора между блоком и запросами обязательно
Такой запрос покажет все сигналы, отфильтрованные с помощью блока[Запрос А]
И где критичность равна "Fatal" И где в названии есть слово "Сервер".
Обычный поиск по названию сигнала, его описанию или id
Классический текстовый поиск. Его применение возможно если:
-
Строка полностью пустая
Такой запрос покажет все сигналы, где в описании или в названии есть слово "Сервер".
-
В строке только блочки конструктора и запрос не содержит операторов
-
Такой запрос покажет все сигналы, отфильтрованные с помощью блока[Запрос А]
И если в их описании или в названии есть слово "Сервер". -
Такой запрос покажет все сигналы, отфильтрованные с помощью блоков[Запрос А]
И[Запрос B]
И если в их описании или в названии есть слово "Сервер".искомый текст должен находиться справа от блочковТакие запросы приведут к ошибке:
искомый текст не должен содержать двоеточияНаличие в запросе двоеточия активирует режим поиска «конструктор + синтаксис», где ":" это обращение к атрибуту, и выдаст ошибку.
Для поиска текста с двоеточием обращаться нужно напрямую к полю "Name" или "Description" с применением синтаксиса.
Такой запрос покажет все сигналы, отфильтрованные с помощью блока[Запрос А]
И если их название равно строке "Сервер:134".
-
Если выделить нужный фрагмент запроса в строке поиска и нажать Ctrl+C, он будет автоматически преобразован в текстовый запрос и скопирован в буфер обмена.
Удаление запроса
Для удаления блоков конструктора и синтаксиса установите курсор перед удаляемым элементом и нажмите клавишу «Backspace».
Для полной очистки поисковой строки нажмите «X» в ее правой части.
Карточка сигнала
Подробная информация о сигнале доступна при одиночном клике по нему в таблице.
Карточка сигнала состоит из трех вкладок:
-
Основная информация
В карточке сигнала пользователь с правами на редактирование сигналов может изменять свойства сигналов:
- Название
- Описание
- Статус сигнала
- Критичность
- Назначить или изменить ответственного
- Изменить привязку КЕ
- Назначить теги
- Заполнить настроенные поля
- Создать, изменить и удалить метки
Все изменения, кроме привязки КЕ и правки меток, сохраняются на лету без дополнительного подтверждения.
-
События
Связанные первичные события представляют собой события из внешних источников, такие как открытие, подтверждение или закрытие сигнала, и являются необязательным атрибутом. Эти события могут быть привязаны как при создании сигнала, так и в процессе его существования. Привязку можно осуществлять только через сценарии автоматизации или через API-запросы.
Модель связанного события включает:
- Дату привязки события
- Источник события (маршрутный узел)
- Тип события (Создание, подтверждение, закрытие)
- Тело события
-
Вложения
Система позволяет добавлять ссылки на любые полезные ресурсы, как внешние, так и внутренние. Пользователи могут прикреплять ссылки на документацию, базы знаний, внешние сайты или другие связанные материалы.
Архивные сигналы
Для просмотра информации по архивным сигналам необходимо создать отдельную карту сигналов с включенной опцией «Показывать архивные сигналы».
По умолчанию таблица с архивными сигналами свернута и для ее просмотра её нужно развернуть:
⚠️ Информация в карточке архивного сигнала доступна только для чтения.