📗Приложение Г

Мониторинг коммуникационного домена КОСКО УПАТС.

содержит информацию по мониторингу КОСКО УПАТС из рабочего
коммуникационного домена

Мониторинг коммуникационного домена

Осуществляется мониторинг отдельного домена КОСКО УПАТС, текущего состояния объектов и пользователей, разговоров а также сценариев. Имеет возможность сбора необходимых лог-файлов.

Основные предназначения

• отслеживание текущего состояния различных сущностей

• сбор необходимых логов по звонкам и сценариям

• моделирование работы маршрутизации и нормализации

• возможность остановки выполнения служебных сценариев

При работе Мониторинга запросы выполняются от WS роли, на которой авторизован пользователь.

Дефолтный пользователь admin и пароль admin.

Web интерфейс приложения Мониторинг

Аутентификация

Для работы в Web интерфейсе управления КОСКО УПАТС необходимо пройти процедуру аутентификации. Для этого в адресной строке браузера необходимо ввести IP- адрес или URL (fqdn) имя Web-сервера для управления.

Web-сервер КОСКО УПАТС обрабатывает все запросы, которые к нему
приходят вне зависимости от URL назначения. Задача системного
администратора только корректно прописать DNS A-записи без
необходимости настройки КОСКО УПАТС.

Рис. 1. Страница аутентификации

Для прохождения процедуры аутентификации необходимо заполнить поля:

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

Разные Web-серверы настроены на обслуживание различных доменов
КОСКО УПАТС. Привязка осуществляется в конфигурационном файле. По
умолчанию через Web-сервер можно получить доступ только к тем
доменам, которые обслуживаются на текущем Сайте (Сайте, где работает
текущий Web-сервер).

После нажатия на Войти система проверит корректность введенных данных.

• Если все верно, то откроется Главная страница

• Если в учетных данных найдена ошибка, то появится сообщение об ошибке

В случае 3-х ошибок аутентификации в течении 1 минуты IP адрес источника будет заблокирован на 3 минуты. Если в эти 3 минуты

попробовать войти снова, то счетчик времени блокировки сбросится на 3 минуты вне зависимости от корректности введенных значений. Блокировка действует на Web-сервере

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

Главная страница

Здесь представлены доступные пользователю приложения - администрирования и ролевые. Набор приложений определяется ролями доступа пользователя в текущем домене. При нажатии на область блока приложения производится его запуск в текущем окне. При необходимости приложение можно открыть в новом окне/вкладке средствами браузера.

У пользователя одновременно может быть открыто любое количество
приложений. В рамках одной сессии браузера все приложения работают
под одной cookie (RCookie). Смена аутентификации в любом окне может
привести к ошибкам сохранения данных в другом.

Общий вид раздела:

Рис. 2. Главная страница администрирования

Логотип КОСКО УПАТС в верхней части страницы является ссылкой, по которой можно перейти в данное окно из любого раздела системы.

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

Рис. 3. Переключение между доступными доменами

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

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

Если пользователю доступен только один текущий домен, то
возможность переключаться между доменами будет заблокирована.

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

Рабочее окно Монитора

Рис. 4. Общий вид раздела

Запрос к мониторингу формируется из заполнения полей:

1. Объект. Выбирается из списка доступных объектов

2. Метод. Выбирается из списка доступных методов для выбранного объекта. Если у Объекта один метод, то он выбирается автоматически

3. Дополнительные поля для метода. Большинство полей являются опциональными. Если поле обязательное и не заполнено, то система не позволит получить данные и выдаст ошибку. Примеры дополнительных полей ◦ Сайт ◦ Нода ◦ Сервер

Рис. 5. Пример формирования запроса трассировки звонков и сценариев

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

• JSON

• Список

• Таблица

• Формированная таблица

Формат результата в JSON

Результат запроса выводится в виде структурированной JSON структуры

Рис. 6. Пример JSON структуры, возвращаемой в ответ на запрос по объекту Трассировка
звонков и сценариев

Кнопки и в правом верхнем углу позволяют выстроить результат в формированную JSON структуру или в сплошной текст

В структуру JSON возможно вносить изменения (в любом месте Результата можно

кликнуть и внести текст). Кнопка позволяет "восстановить" структуру - убрать комментарии, незначащие символы, исправить кавычки, встроить объекты JavaScript

Формат результата в списке

Результат запроса выводится в виде массива данных

Рис. 7. Пример Списка, формируемого в ответ на запрос по объекту Трассировка звонков и
сценариев

Кнопки и в правом верхнем углу позволяют развернуть и свернуть сформированный список

Формат результата в таблице

Результат запроса выводится в виде таблицы данных

Рис. 8. Пример Таблицы, формируемой в ответ на запрос по объекту Трассировка звонков и
сценариев

Таблица строится на базе сформированного списка и может содержать объединяющие ячейки в строках и столбцах.

Формат результата в формированной таблице

Результат запроса выводится в виде таблицы данных без объединяющих ячеек. Позволяет copy/paste данные напрямую в другие приложения, работающие с таблицами (например, MS Excel).

Монитор Коммуникационного домена

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

Трассировка звонков и сценариев

Данный объект предназначен для сбора логов по звонкам и сценариям. Для звонков возможен сбор логов в форматах SVG, PlantUML, zip-архив. Сбор логов осуществляется по любому звонку, последний SIP пакет в котором был менее 10 минут назад. Система автоматически включает в выборку все связанные звонки (правое/левое плечо, переводы и т.д.)

Метод calls

Данные отображаются по всем звонкам (активным и завершенным), в рамках которых за последние 10 минут были SIP пакеты. Это основной метод получения информации по звонкам от системы, вне зависимости от того, был звонок успешным (разговор абонента А с абонентом B состоялся) или неуспешным.

Рис. 9. Метод calls

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

Название Описание
srvidx Идентификатор роли (roleid).
role Тип роли.
node Нода на которой запущена роль.
addr Адрес ноды.
online Доступность ноды для сбора статистики.
calls Плечи звонков обслуживаемые ролью.
calls.callid callid стороны А. Поле часто используется для последующего
сбора логов по звонку.
calls.from uri стороны А

Название Описание
calls.remoteip Адрес стороны Б.
calls.tick Timestamp (в мс) получения запроса.
calls.time Время получения запроса.
calls.to uri стороны Б.
calls.media Данные об использовании медиа.
calls.media.mgc Ключ роли mgc обслуживающей стороны звонка
calls.media.mgc_srvi
dx

Идентификатор роли (roleid) mgc.

calls.media.mgc_node

Нода mgc.

calls.media.mg Ключ используемой роли mg.
calls.media.msid Идентификатор sip-владельца медиа.
calls.media.ctx Номер контекста.

Метод trn

Собирает все SIP пакеты по звонку (все форки и плечи звонка). Основной метод получения лог-файлов по звонкам от системы. Результат может быть выведен в:

• zip-архив

• визуальную диаграмму uml (SVG файл)

• uml файл (plantUml файл)

Рис. 10. Метод trn

Название Описание

Сallid для сбора логов

callid по которому происходит поиск соответствий trn

Список CallID для которых собрать логи

список callid по которому происходит поиск соответствий и сбор
trn-логов всех звонков

Формат ответа • SVG диаграмма – страница содержащая plantuml диаграмма в формате svg

• файл в формате plantuml - текстовый файл формата UML для дальнейшейго построения диаграммы

• zip-архив trn логов - сбор файлов лога, упаковка в zip-архив и загрузка в браузер

На SVG диаграмме при нажатии на время пакета отображается текст SIP-
пакета.

Метод scripts

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

Рис. 11. Метод scripts

Название Описание
Тип сценария Тип сценария по которому необходимо собрать логи. Возможные
значения:

• IVR - сбор логов по IVR сценариям

• SVC - сбор логов по SVC сценариям

Начало (мин. назад)

С какого момента начать сбор логов (количество минут в прошлое
от текущего момента)
Продолжительность

Продолжительность лога для сборки в минутах. Возможные
значения от 1 до 1440

Название Описание

Код сценария (^) Код сценария по которому необходимо собрать логи. Если не указан, то сбор по всем сценариям указанного типа

Моделирование маршрутизации

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

Метод apply

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

Рис. 12. Метод apply

Название Описание

Направление источника

Направление источника звонка. Возможен выбор источника
звонка из 2-х вариантов:

• Внутренний абонент - инициатор звонка является абонентом домена КОСКО УПАТС

• Внешняя линия - звонок пришел в КОСКО УПАТС через Оператора SIP телефонии

КД источника звонка

Коммуникационный домен, из которого инициирован звонок

Номер источника Имя пользователя (логин) или номер источника звонка (абонента А).

• Для Направление источника = Внутренний абонент система определит sipuser, кто инициировал звонок.

• Для Направление источника = Внешняя линия, система возьмет за номер источника, который пришел в INVITE.

Набранный номер Номер, вызываемый абонентом-инициатором звонка (абонентом А)

Код оператора SIP Для Направление источника = Внешняя линия указывается код Оператора SIP телефонии, откуда пришел звонок

Моделирование нормализации номеров внешних линий

Данный объект позволяет моделировать работу правил модификации внешних линий (нормализация CalledNum, CallerNum при звонках через SIP-операторов).

Метод apply

Отображает все правила модификации, которые были применены при звонке. Итоговый результат нормализации идет в последней строке вывода.

Рис. 13. Метод apply

Название Описание

Домен моделирования

Домен по которому необходимо посмотреть правила
нормализации.

Направление источника

Выбор источника звонка из 2 - х вариантов:

• Внутренний абонент - инициатор звонка является абонентом домена КОСКО УПАТС

• Внешняя линия - звонок пришел в КОСКО УПАТС через Оператора SIP телефонии

КД источника Домен, в котором инициирован звонок.

Номер источника Имя пользователя (логин) или номер источника (абонента А).

• Для Направление источника = Внутренний абонент система определит sipuser, кто инициировал звонок.

• Для Направление источника = Внешняя линия, система возьмет за номер источника, который пришел в INVITE.

КД получателя Домен, в который направлен звонок

Номер получателя Номер, вызываемый абонентом А

Идентификатор оператора SIP

Необходимо указать код Оператора SIP телефонии (провайдера),
откуда пришел звонок.

Моделирование нормализации звонков между доменами

Данный объект позволяет моделировать работу правил нормализации Номера А при звонках между абонентами разных доменов.

Метод apply

Отображает все правила модификации, которые были применены при звонке. Итоговый результат нормализации идет в последней строке вывода.

Рис. 14. Метод apply

Название Описание
КД источника
звонка

Домен, в котором инициирован звонок.

Название Описание

SIP логин источника звонка

Имя пользователя (логин) или номер источника (абонента А).

КД получателя Домен, в который направлен звонок

Номер получателя Имя пользователя или номер в КД получателя, на которого будет отправлен вызов

Активные абоненты доменов

Данный объект отображает статистику по ролям с типом States (поддержка состояний объектов и пользователей).

Метод currentload

Отображает учетные записи SIP, которые в данный момент зарегистрированы в запрашиваемом КД. Отображает состояние зарегистрированных учетных записей SIP.

Рис. 15. Метод currentload

Название Описание
Модификатор Режим отображения. Возможные значения:

• active - текущие состояния объектов в домене. По умолчанию

• count - количество резервированных состояний.

Название домена Домен, в котором будет выполнен запрос.

Применяется если вход выполнен в Мастер-Домене, а получить
данные надо по-одному из рабочих КД.

Основные поля в ответе:

username - имя пользователя учетной записи SIP state - текущее состояние учетной записи SIP

Метод details

Отображает информацию по одному пользователю.

Рис. 16. Метод details

Название Описание
Название Домена Домен, в котором будет выполнен запрос
Номер или Логин
абонента

Номер или логин, по которому необходимо получить данные

Активные регистрации SIP устройств

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

Метод active

Отображает учетные записи SIP, которые в данный момент зарегистрированы в запрашиваемом КД.

Рис. 17. Метод active

Название Описание
Название Домена Домен, в котором будет выполнен запрос.

Применяется если произведен вход в Мастер-Домен, а сбросить
регистрацию надо в каком-то дочернем КД.

Либо если вход в КД, а получить данные надо по одному из его
дочерних КД.

Основные поля в ответе:

• username - имя пользователя учетной записи SIP

• addr - IP-адрес SIP-клиента, если SIP-клиент за NAT, то отображается локальный внутренний адрес.

• expires - время до момента перерегистрации

• path.domain - IP-адрес SG

• path.port - порт назначения, который использует SG для приема пакетов

• path.proto - внутренний транспортный протокол между SG и B2BUA, всегда = TCP

• path.user - внутренний идентификатор учетной записи SIP

• port - исходящий порт, с которого SIP-клиент отправляет пакеты

• proto - транспортный протокол, используемый между SIP-клиентом и SG

Метод unregistered

Позволяет отобразить все незарегистрированные учетные записи по КД.

Если в запросе не указан desttd, то domain = домен,в котором делается запрос. Если desttd указан, то значение подставляется в поле domain

Рис. 18. Метод unregistered

Название Описание
Название Домена Домен, в котором будет выполнен запрос. Применяется если вход в
Мастер-Домен, а сбросить регистрацию надо в каком-то дочернем КД.

Основные поля в ответе:

• sipusers: username - имя пользователя учетной записи, которая в данный момент не зарегистрирована в КД.

Метод count

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

Рис. 19. Метод count

Название Описание
Название Домена Домен, в котором будет выполнен запрос. Применяется если вход в
Мастер-Домен, а сбросить регистрацию надо в каком-то дочернем КД.

Основные поля в ответе:

• total - общее количество зарегистрированных учетных записей SIP

• domains - распределение регистраций по доменам

Метод delete

Позволяет удалить все регистрации конкретной учетной записи SIP user@domain или определенные регистрации пользователя udp:192.168..:**** у user@domain

Если в запросе не указан desttd, то domain = домен,в котором делается запрос. Если desttd указан, то значение подставляется в поле domain

Рис. 20. Метод delete

Название Описание

Название Домена Домен, в котором будет выполнен запрос. Применяется если произведен вход в Мастер-Домен, а сбросить регистрацию надо в каком-то дочернем КД.

SIP Login (^) Имя пользователя учетной записи SIP, у которой необходимо сбросить регистрацию Контакты Указывается в формате proto:IP:Port если надо сбросить определенную регистрацию (-ии) у пользователя. Возможно указать несколько через запятую. Пример udp:192.168..:50**,tcp:192.168..:50**

Активные подписи на состояния (BLF)

Данный объект отображает статистику по ролям SUBSCR (подписки на состояния SIP- регистраций, например, для BLF)

Метод currentload

Отображает текущую загрузку объекта.

Рис. 21. Метод currentload

Название Описание
Модификатор Режим отображения. Возможные значения:

• active - текущие подписки на состояния в домене. По умолчанию

• count - количество активных подписок

Название домена Домен, в котором будет выполнен запрос. Применяется если вход
выполнен в Мастер-Домене, а получить данные надо по одному из
рабочих КД.

Применяется если вход выполнен в Мастер-Домене, а получить
данные надо по одному из рабочих КД.

Основные поля в ответе:

• username - имя пользователя учетной записи SIP, на кого оформлена подписка

• expires - таймер обновления подписки

• key - кто запросил подписку в формате

<sip:username@domain_name:50**>;callid= ..... @host;addr=host

Активные сценарии

Данный объект отображает активные сценарии. Также доступен механизм остановки любого доступного сценария.

Метод active

Отображает текущие активные сценарии.

Рис. 22. Метод active

Основные поля в ответе:

• node - нода на которой был запущен скрипт

• result - результат выполнения запроса

• scripts - параметры сценариев: ◦ instc_scrpid - экземпляр владельца pid процесса ◦ instc_id - идентификатор сценария при его запуске ◦ type - тип сценария ◦ code - код сценария ◦ domain - домен в котором запущен сценарий ◦ ownerpid - владелец pid процесса (супервизор) ◦ starttime - время старта сценария

Метод delete

Прекращает работу сценария.

Рис. 23. Метод delete

Название Описание
Нода Имя ноды, где выполняется сценарий (node name)
Тип сценария Тип сценария для удаления. Возможные варианты:

• SVC

• ICR

Идентификатор Идентификатор сценария (Script ID)

Основные поля в ответе:

• pid - идентификатор процесса

• id - идентификатор сценария

Использование лицензий

Отображает информацию о лицензиях

Метод currentload

Отображает текущую загрузку объекта

Рис. 24. Метод currentload

Название Описание
Модификатор • active - статус серверов.

Название домена Имя КД по-которому вывести данные

Название Описание

Показывать используемые лицензии?

Показыать количество использованных лицензий в домене.
Возможные значения:

• Нет

• Да

Показывать исп. лицензии в поддоменах

Показыать количество использованных лицензий в поддоменах.
Возможные значения:

• Нет

• Да

Отображать КД Фильтр по неактивным или незагруженным доменам

Состояние очередей

Данный объект отображает информацию по абонентам, операторам и общей информации в очереди.

Доступен роли: Монитор КД

Метод abons

Отображает информацию по абонентам в очереди, которые ожидают соединения с оператором.

Название Описание
Код очереди Код очереди иди ID записи очереди

Целевые показатели в ответе:

• call_id - идентификатор звонка, который присутствует на всем пути обработки звонка разными ролевыми нодами (sg,b2bua,esg,conf,ivr)

• number - номер

• position - текущая позиция

• qdt - дата-время размещения в ожидании

• qtimersec - текущее время ожидания

Пример ответа

Метод info

Отображает общую информацию по абонентам в очереди, которые ожидают соединения с оператором.

Структура запроса:

Название Описание
Код очереди Код очереди иди ID записи очереди

Целевые показатели в ответе:

• abons - количество абонентов, которые ждут соединения с оператором

• maxqdt - дата-время размещения в ожидании

• maxqtimersec - максимум времени ожидания в очереди

"call_id": "r**-s**-A**6**-**-*************************************************",
"id": "************-0***-11**-*************************",
"number": "209",

"call_id": "r**-s**-AN****-0*-**********@192.168.*.***", "id":
"************-01**-11**-*********************",
"number": "20*",

Пример ответа

Метод states

Отображает информацию по операторам.

Структура запроса:

Название Описание
Код очереди Код очереди иди ID записи очереди

Целевые показатели в ответе:

• sipuser - логин учетной записи SIP

• sipusernumber - телефонный номер учетной записи SIP

• state - BLF-состояние ◦ registered - зарегистрирован и свободен ◦ early - звонит устройство. ◦ busy - в диалоге с абонентом.

"maxqtimersec": *

Пример ответа