Корневой контекст
Этот контекст является корнем дерева контекстов SberMobile Server. Он содержит несколько основных действий, которые используются для управления сервером.
Уникальные действия
[ ? ]
Настроить сервер
Это действие используется для просмотра или редактирования параметров глобальной конфигурации SberMobile Server. Единственное его отличие от стандартного действия Configure заключается в том, что оно предлагает пользователю перезагрузить сервер после сохранения новых настроек (для применения изменений необходима перезагрузка). Дополнительную информацию о конфигурации сервера можно найти здесь.
Тип действия:
Название действия:
configureServer
Значок действия:
Разрешения:
Доступно на уровне прав администратора
Показать информацию о сервере
Это действие показывает информацию о среде выполнения SberMobile Server. Это может быть полезно для отладки и устранения неполадок на сервере, а также для решения некоторых проблем с производительностью.
Имеется несколько секций:
Статус сервера. Различные сведения о рабочем состоянии сервера в реальном времени, например время запуска или использование памяти.
Переменные окружения. Информация об окружении Java Runtime и машине/операционной системе, на которой она работает.
База данных. Информация о базе данных SQL, используемой в текущей установке SberMobile в качестве хранилища конфигурации и событий.
Статистика контекстов. Список всех контекстов и количество переменных, функций, событий и действий в каждом контексте.
Статистика выражений. Статистика, показывающая количество разобранных или вычисленных выражений, пойманных или сгенерированных ошибок, разобранных ссылок, а также количество вызовов каждой функции.
Статистика устройств. Обзор количества прочитанных и записанных переменных, а также подсчет вызовов функций и событий, связанных с устройством.
Информация о лицензии. Информация о лицензии SberMobile.
Активные плагины. Информация о плагинах, которые в данный момент использует SberMobile Server.
Установленные модули. В таблице указаны установленные модули, их идентификаторы и версии.
Активные клиентские подключения. Список подключенных в данный момент клиентов с указанием удаленного адреса и типа/времени подключения.
Статус кластера. Возвращает информацию о состоянии узлов кластера обхода отказа.
Все потоки. Список потоков сервера вместе с их состоянием и трассировкой стека. Эта информация может быть запрошена службой поддержки SberMobile.
Статистика пула потоков. Список активных и завершенных задач для каждого пула потоков сервера. Эта информация может быть полезна для анализа загрузки процессора сервера.
Статистика тем. Обзор количества живых потоков и общего количества начатых потоков.
Статистика правил обработки событий. Подробная информация о событиях, обработанных по правилам обработки событий: количество подавленных, сохраненных и де-дублированных событий.
Детали очереди событий. Если очередь событий SberMobile Server не пуста, здесь отображается информация о событиях: количество событий в очереди для каждого контекста.
Производительность. Статистика, связанная с управлением памятью.
Тип действия:
Configure (режим только для чтения)
Название действия:
viewServerInfo
Значок действия:
Разрешения:
Доступно на уровне прав администратора
Создать / обновить ресурсы
Это действие используется для создания ресурсов предварительной сборки (оповещений, отчетов, виджетов и т. д.), которые включаются в дистрибутив SberMobile. Подробнее см. в разделе Управление предварительно созданными ресурсами.
Название действия:
createResources
Значок действия:
Разрешения:
Доступно на уровне прав менеджера
Удалить ресурсы
Это действие используется для удаления предварительно созданных ресурсов (оповещений, отчетов, виджетов и т. д.), которые включены в дистрибутив SberMobile. Подробнее см. в разделе Управление ресурсами предварительной сборки.
Название действия:
deleteResources
Значок действия:
Разрешения:
Доступно на уровне прав менеджера
Остановить сервер
Это действие позволяет остановить SberMobile Server. Есть два варианта: немедленное и отложенное отключение. В случае отложенного отключения все активные операторы получают информацию о времени и причине отключения. Это поможет им отложить текущие задания и сохранить все изменения до отключения.
Тип действия:
Название действия:
stop
Значок действия:
Разрешения:
Доступно на уровне прав администратора
Перезапустить сервер
Это действие позволяет перезапустить SberMobile Server. Есть два варианта: немедленный и отложенный перезапуск. В случае отложенного перезапуска все активные операторы получают информацию о времени и причине перезапуска. Это поможет им отложить текущие задания и сохранить все изменения до перезапуска.
Автоматический перезапуск возможен только в том случае, если SberMobile Server работает в режиме сервиса. В остальных случаях сервер необходимо остановить и запустить вручную.
Тип действия:
Название действия:
restart
Значок действия:
Разрешения:
Доступно на уровне прав администратора
Начать режим обслуживания
Это действие заставляет сервер перейти в режим обслуживания.
Тип действия:
Название действия:
startMaintenanceMode
Разрешения:
Доступно на уровне прав администратора
Закончить режим обслуживания
Это действие заставляет сервер выйти из режима обслуживания.
Тип действия:
Название действия:
stopMaintenanceMode
Разрешения:
Доступно на уровне прав администратора
Удаленное обновление
Это действие Call Function используется для удаленного обновления SberMobile Server. Дополнительные сведения см. в разделе Удаленное обновление.
Тип действия:
Название действия:
upgrade
Разрешения:
Доступно на уровне прав администратора
Сменить пароль
Это действие Call Function используется для изменения пароля текущего аутентифицированного пользователя.
Тип действия:
Название действия:
changePassword
Разрешения:
Доступно на уровне прав оператора
Поиск
Это действие используется для доступа к диалогу унифицированного поиска.
Название действия:
search
Значок действия:
Разрешения:
Доступно на уровне разрешения Нет прав
Показать историю переменной
Это действие Call Function используется для доступа и просмотра истории обновлений определенной переменной. Оно предлагает пользователю указать следующие параметры:
Контекст, в котором определяется переменная;
Название переменной;
С даты - отслеживание истории обновлений в обратном направлении только до определенной даты.
Это действие выводит историю обновления переменных в виде таблицы. Каждое поле формата отслеживаемой переменной отображается в отдельном поле результирующей таблицы. Если значение переменной содержит несколько строк, то отображаются данные только первой строки.
Тип действия:
Название действия:
variableHistory
Значок действия:
Разрешения:
Доступно на уровне прав администратора
Показать историю события
Это действие Call Function используется для выбора и просмотра определенных событий из истории событий. Оно предлагает пользователю указать критерии выбора и представления событий:
Маска контекстов для выбора событий;
Название мероприятия;
Выражение для фильтрации событий;
Дата начала, чтобы выбрать только события, произошедшие после определенной даты.
Тип действия:
Название действия:
eventHistory
Значок действия:
Разрешения:
Доступно на уровне прав администратора
Стереть историю события
Это действие Call Function используется для удаления определенных событий из истории событий. Оно предлагает пользователю указать критерии выбора событий:
Маска контекстов, из которых нужно удалять события;
Название мероприятия;
Дата начала, чтобы удалить только события, произошедшие после определенной даты (необязательно);
Дата окончания, чтобы удалить только события, произошедшие до определенной даты (необязательно).
Тип действия:
Название действия:
deleteEvents
Разрешения:
Доступно на уровне прав администратора
Показать статистику канала
Это действие Call Function используется для просмотра статистики по определенному статистическому каналу. Оно предлагает пользователю указать свойства канала:
Маска контекстов, в которых определен канал;
Название канала;
Ключ статистического набора данных;
Период группировки (час, день и т.д.);
Типы агрегирования (среднее, максимальное и т. д.)
Это действие выводит статистику канала в табличной форме.
Тип действия:
Название действия:
viewStatistics
Значок действия:
Разрешения:
Доступно на уровне прав администратора
Показать необработанную статистику канала
Это действие Call Function используется для просмотра необработанной (полной) статистики для определенного статистического канала. При этом пользователю предлагается указать свойства канала:
Маска контекстов, в которых определен канал;
Название канала.
Это действие выводит статистику канала в табличной форме.
Тип действия:
Название действия:
viewRawStatistics
Значок действия:
Разрешения:
Доступно на уровне прав администратора
Очистить канал статистики
Это действие Call Function используется для удаления всех данных, собранных определенным статистическим каналом. Оно предлагает пользователю указать свойства канала:
Маска контекстов, в которых определен канал;
Название канала.
Это действие выводит статистику канала в виде таблицы.
Тип действия:
Название действия:
deleteStatistics
Разрешения:
Доступно на уровне прав администратора
Заполненить статистику по истории переменной
Это действие Call Function используется для повторной инициализации статистического канала, загружая все "сырые" исторические значения переменной и помещая их в канал вместе с их историческими временными метками.
Действие полезно для восстановления статистики, если файл статистики поврежден или отсутствует по какой-либо причине.
После выполнения этого действия вся накопленная в канале статистика будет потеряна.
Это действие будет работать только в том случае, если для переменной, на которой основан статистический канал, включено хранение истории необработанных значений. Если история необработанных значений недоступна, это действие просто очистит статистический канал.
Если доступна необработанная история только за определенный период, канал будет содержать статистику за тот же период.
Действие предлагает пользователю указать свойства канала:
Маска контекстов, в которых определен канал;
Название канала.
Тип действия:
Название действия:
fillStatisticsFromHistory
Разрешения:
Доступно на уровне прав администратора
Сгенерировать дамп потоков
Это действие используется для создания дампа потоков. Дамп потока - это текстовый файл со списком всех потоков Java, которые в данный момент активны в виртуальной машине Java сервера.
Тип действия:
Название действия:
generateThreadDump
Разрешения:
Доступно на уровне прав менеджера
Сгенерировать дамп памяти
Это действие используется для создания дампа памяти. Дамп памяти - это двоичный файл, содержащий подробную информацию о памяти, выделенной в виртуальной машине Java сервера.
Тип действия:
Название действия:
generateHeapDump
Разрешения:
Доступно на уровне прав менеджера
Показать статистику контекстов
Это действие отображает подробную статистику по контекстам сервера, включая информацию о размере сохраняемой памяти для каждого контекста.
Тип действия:
Название действия:
viewContextsInfo
Разрешения:
Доступно на уровне прав менеджера
Импорт
Используется для импорта общих данных в систему с помощью скрипта.
Поток действий:
Выберите скрипт, который будет использоваться для обработки импортированных данных.
Выберите файл для импорта.
[Необязательно] Укажите параметры импорта, если доступны какие-либо параметры для формата выбранного файла.
На этом этапе данные считываются из файла и преобразуются в таблицу данных.
Просмотрите данные, которые необходимо импортировать.
В этот момент запускается скрипт импорта, на вход которого передается импортированная таблица данных. Сценарий должен обработать данные таблицы запись за записью и внести необходимые изменения в систему (например, создать/изменить ресурсы).
Название действия:
import
Значок действия:
Неинтерактивный режим:
Не поддерживается
Разрешения:
Доступно на уровне прав администратора
Выполнить внешнее приложение
Это действие используется для запуска внешнего приложения путем вызова функции execute данного контекста. Оно может быть использовано, например, для запуска какой-либо программы в ответ на поднятую тревогу (подробнее см. раздел Выполнение неинтерактивных действий при тревоге ).
Эта функция не может выполнять команды оболочки операционной системы. Чтобы выполнить некоторые команды оболочки, поместите их в исполняемый сценарий и выполните этот сценарий.
Тип действия:
Название действия:
execute
Разрешения
Доступно на уровне прав администратора
Группа действий:
Дополнительные действия
Запустить Garbage Collection
Это действие используется для инициирования полного цикла сборки мусора виртуальной машины Java, на которой работает SberMobile Server. Используйте это действие перед проверкой параметра Использование памяти, % от Максимально разрешённого переменной Статус Сервера, чтобы выяснить реальное потребление памяти сервером.
Выполнение этого действия заставит JVM приостановить все действия до окончания процесса сборки мусора (это называется "остановить мир"). Это приведет к простою SberMobile Server и всех запущенных в нем приложений. Продолжительность такого простоя обычно составляет несколько секунд, но может достигать нескольких минут в случае больших размеров кучи JVM.
Дополнительные сведения см. в разделе " Работа с использованием памяти ".
Тип действия:
Название действия:
runGarbageCollection
Разрешения
Доступно на уровне прав администратора
Группа действий:
Дополнительные действия
Просмотр статистики базы данных
Это действие показывает количество событий и свойств во всех таблицах базы данных SberMobile Server. Количество событий/свойств группируется по таблицам базы данных, пути к контексту и имени события/свойства.
Тип действия:
Название действия:
viewDatabaseStatistics
Разрешения:
Доступно на уровне прав администратора
Группа действий:
Дополнительные действия
Открыть в браузере
Это действие позволяет пользователю открыть определенный URL-адрес в браузере клиента по умолчанию.
Название действия:
browse
Неинтерактивный режим:
Не поддерживается
Разрешения:
Доступно на уровне прав обозревателя
Параметры выполнения :
URL. Может быть указан как поле String
url
таблицы ввода действия.
Сравнить
Это действие позволяет пользователю сравнить две строки в графическом средстве просмотра различий.
Название действия:
compare
Неинтерактивный режим:
Не поддерживается
Разрешения:
Доступно на уровне прав обозревателя
Параметры выполнения :
Левое название. Заголовок левого поля программы просмотра.
Левое значение. Значение, которое будет отображаться в левом поле программы просмотра.
Right Title. Заголовок правого поля дифпросмотра.
Правое значение. Значение, которое будет отображаться в правом поле программы просмотра.
Прервать клиентское соединение
Это действие используется для принудительной деаутентификации и отключения одного или нескольких клиентских сеансов, независимо от их типа (десктоп, веб, API и т. д.).
Тип действия:
Название действия:
terminateClientConnection
Разрешения
Доступно на уровне прав администратора
Группа действий:
Дополнительные действия
Общие действия
[ ? ]
Редактирование контекстных разрешений, мониторинг связанных событий
Контекстные состояния и значки
У этого контекста нет состояний. Обычно он представлен значком
Расширенная информация
Контекстная информация
Тип контекста: корень
Контекстное имя: "" (Пустая строка)
Контекстное описание: "" (Пустая строка)
Контекстный путь: "" (Пустая строка)
Контекстная маска: "" (пустая строка)
Контекстные разрешения
[ ? ]
Уровень
Описание
Нет
Вход пользователей в систему.
Самостоятельная регистрация пользователей.
Обозреватель
Выполнение текстовых запросов SberMobile.
Оператор
Самостоятельная смена пароля пользователя.
Менеджер
Создание объединенных ресурсов.
Инженер
Запросы на проверку и обработку входящей почты.
Администратор
Просмотр информации о сервере.
Остановка и перезапуск сервера.
Выполнение обычных текстовых запросов.
Выполнение внешних приложений.
Доступ к истории переменных/событий и статистике.
Просмотр статистики базы данных.
Отправка сообщений электронной почты и SMS.
Публичные переменные (свойства)
[ ? ]
Версия сервера
Возвращает версию SberMobile Server.
Имя переменной:
version
Записи:
1
Разрешения:
Доступно для чтения на уровне прав обозревателя
Формат записи:
Имя поля | Тип поля | Примечания |
version | String | Строка версии сервера. |
Состояние сервера
Возвращает информацию о SberMobile Server во время выполнения.
Имя переменной:
status
Записи:
1
Разрешения:
Доступно для чтения на уровне прав обозревателя
Формат записи:
Имя поля | Тип поля | Примечания |
name | String | Описание экземпляра сервера. |
version | String | Версия сервера. |
buildNumber | String | Номер сборки версии сервера. |
installationDate | Date | Date установки. |
startTime | Дата | Временная метка запуска сервера. |
startupDuration | Long | Время, необходимое серверу для запуска. |
uptime | Long | Время работы сервера. |
maxMemory | Long | Максимально допустимый размер кучи виртуальной машины Java (JVM). Контролируется параметром -Xmx. |
totalMemory | Long | Текущий размер памяти, выделенной под кучу JVM. |
freeMemory | Long | Освобождение памяти в текущей выделенной куче JVM. |
memoryUsage | Double | Используемый в данный момент процент от максимального размера кучи JVM. Показывает реальное использование памяти сервера, если проверить его сразу после выполнения действия Run Garbage Collection. |
cpuLoad | Double | Нагрузка на процессор, вызванная виртуальной машиной Java. |
cpuLoadSystem | Двойной | Общая загрузка процессора. |
diskUtilization | Data table | Информация об использовании диска. |
Конфигурация Статистика хранения
Статистический обзор операций с таблицами данных в SberMobile Server.
Имя переменной:
storageStatisticsConfiguration
Записи:
1
Разрешения:
Доступно для чтения на уровне прав обозревателя
Формат записи:
Имя поля | Тип поля | Примечания |
tablesSaved | Long | Количество операций сохранения, выполненных над таблицами данных. |
tablesLoaded | Long | Количество операций загрузки, выполненных для таблиц данных. |
tablesDeleted | Long | Количество операций удаления, выполненных над таблицами данных. |
tablesMoved | Long | Количество операций перемещения, выполненных над таблицами данных. |
Статистика хранения событий
Обзор статистики событий в SberMobile Server.
Имя переменной:
storageStatisticsEvents
Записи:
1
Разрешения:
Доступно для чтения на уровне прав обозревателя
Формат записи:
Имя поля | Тип поля | Примечания |
eventsSaved | Long | Количество сохраненных событий. |
eventsLoaded | Long | Количество загруженных событий. |
eventsUpdated | Long | Количество обновленных событий. |
eventsDeleted | Long | Количество удаленных событий. |
eventsExpired | Long | Количество событий, срок действия которых истек. |
eventsMoved | Long | Количество перенесенных событий. |
Статистика хранения двоичных данных
Статистический обзор операций над блоками двоичных данных в SberMobile Server.
Имя переменной:
storageStatisticsBinaryData
Записи:
1
Разрешения:
Доступно для чтения на уровне прав обозревателя
Формат записи:
Имя поля | Тип поля | Примечания |
blocksSavedAndUpdated | Long | Количество операций сохранения и обновления, выполненных над блоками двоичных данных. |
blocksLoaded | Long | Количество операций загрузки, выполненных для блоков двоичных данных. |
blocksDeleted | Long | Количество операций удаления, выполненных над блоками двоичных данных. |
Статистика реляционных баз данных
Возвращает статистический обзор реляционной базы данных SberMobile Server.
Имя переменной:
relationalDatabase
Записи:
1
Разрешения:
Доступно для чтения на уровне прав обозревателя
Формат записи:
Имя поля | Тип поля | Примечания |
queries | Long | Количество запросов, выполненных с момента запуска сервера. |
transactions | Long | Количество транзакций, выполненных с момента запуска сервера. |
loaded | Long | Количество объектов, извлеченных из базы данных с момента запуска сервера. |
updated | Long | Количество объектов, обновленных в базе данных с момента запуска сервера. |
inserted | Long | Количество объектов, вставленных в базу данных с момента запуска сервера. |
deleted | Long | Количество объектов, удаленных из базы данных с момента запуска сервера. |
maxQueryTime | Long | Максимальное время выполнения всех запросов к базе данных, выполненных с момента запуска сервера. |
Статистика таблиц реляционных баз данных
Возвращает подробную статистику таблиц реляционной базы данных SberMobile Server.
Имя переменной:
realtionalDatabaseTables
Записи:
0...неограниченно
Разрешения:
Доступно для чтения на уровне прав обозревателя
Формат записи:
Имя Поля | Тип поля | Примечания |
table | String | Название таблицы. |
loaded | Long | Количество объектов, извлеченных из таблицы с момента запуска сервера. |
updated | Long | Количество объектов, обновленных в таблице с момента запуска сервера. |
inserted | Long | Количество объектов, вставленных в таблицу с момента запуска сервера. |
deleted | Long | Количество объектов, удаленных из таблицы с момента запуска сервера. |
Статистика подключений к реляционным базам данных
Возвращает статистический обзор соединений с реляционными базами данных SberMobile Server.
Имя переменной:
relationalDatabaseConnections
Записи:
1
Разрешения:
Доступно для чтения на уровне прав обозревателя
Формат записи:
Имя поля | Тип поля | Примечания |
connections | Long | Количество соединений в пуле соединений. |
idleConnections | Long | Количество незанятых соединений в пуле соединений. |
busyConnections | Long | Количество занятых соединений в пуле соединений. |
unclosedConnections | Long | Количество незакрытых соединений в пуле соединений. |
Статистика кластеров реляционных баз данных
Возвращает подробную статистику кластера реляционных баз данных SberMobile Server.
Имя переменной:
relationalDatabaseCluster
Записи:
0...неограниченно
Разрешения:
Доступно для чтения на уровне прав обозревателя
Формат записи:
Имя поля | Тип поля | Примечания |
node | String | Имя узла кластера базы данных. |
location | String | Расположение (URL) узла кластера баз данных. |
alive | Boolean | Показывает, доступна ли база данных для подключений. |
active | Boolean | Показывает, используется ли база данных в кластере в данный момент. |
synchronizationDuration | Long | Продолжительность текущей синхронизации базы данных кластера или NULL, если синхронизация в данный момент не выполняется. |
Контекстная статистика
Возвращает статистическую информацию SberMobile Server о контекстах, переменных, функциях, событиях и действиях.
Имя переменной:
sysinfo
Записи:
0...неограниченно
Разрешения:
Доступно для чтения на уровне прав обозревателя
Формат записи:
Имя поля | Тип поля | Примечания |
context | Integer | Имя и описание контекста SberMobile Server. |
variableCount | Integer | Общее количество определений переменных в контексте. |
functionCount | Integer | Общее количество определений функций в контексте. |
eventCountco | Integer | Общее количество определений событий в контексте. |
actionCount | Integer | Общее количество определений действий в контексте. |
variablesRead | Long | Количество операций чтения переменных, выполненных с момента запуска сервера. |
variablesWritten | Long | Количество операций записи переменных, выполненных с момента запуска сервера. |
functionsCalled | Long | Количество операций вызова функций, выполненных с момента запуска сервера. |
eventsFired | Long | Количество событий, произошедших с момента запуска сервера. |
eventHandleOffers | Long | Количество раз, когда обработчики событий были предложены для обработки этого события. |
eventHandleExecutions | Long | Количество раз, когда обработчики событий обработали это событие. |
eventListenerCount | Long | Количество слушателей этого события. |
eventQueuesLength | Long | Внутренняя очередь событий контекста для этого события. |
memory | Long | Приблизительный объем пространства в куче, сохраняемый этим контекстом. |
Статистика выражений
Указывает некоторую информацию, связанную с обработкой выражений.
Имя переменной:
expressionStatistic
Записи:
1
Разрешения:
Доступно для чтения на уровне прав обозревателя
Формат записи:
Имя поля | Тип поля | Примечания |
parsed | Long | Разбор выражений. |
evaluated | Long | Оценка выражений. |
errGenerated | Long | Сгенерированные ошибки. |
errCaught | Long | Пойманные ошибки. |
refProcessed | Long | Ссылки обработаны. |
funcCalled | Data table | Таблица с полями, показывающая, сколько раз была вызвана каждая функция:
|
Статистика устройства
Возвращает краткую статистическую информацию об устройствах SberMobile Server.
Имя переменной:
deviceStatistics
Записи:
1
Разрешения:
Доступно для чтения на уровне прав обозревателя
Формат записи:
Имя Поля | Тип поля | Примечания |
variablesRead | Long | Количество операций чтения переменных, выполненных с момента запуска сервера. |
variablesWritten | Long | Количество операций записи переменных, выполненных с момента запуска сервера. |
functionsCalled | Long | Количество операций вызова функций, выполненных с момента запуска сервера. |
eventsFired | Long | Количество событий, произошедших с момента запуска сервера. |
Информация о лицензии
Возвращает информацию об активной лицензии SberMobile Server.
Имя переменной:
license
Записи:
1
Разрешения:
Доступно для чтения на уровне прав обозревателя
Формат записи:
Имя поля | Тип поля | Примечания |
issueDate | Данные | Дата выдачи лицензии. |
holder | String | Владелец лицензии. |
version | String | Шаблон версии сервера. |
trialPeriod | Integer | Пробный период (дней), или NULL для не пробной лицензии. |
trialRemaining | Integer | Оставшийся пробный период (дней), или NULL для лицензии без пробного периода. |
maxDevices | Integer | Максимальное количество устройств, разрешенных лицензией. |
curDevices | Integer | Текущее количество зарегистрированных устройств. |
activationKey | String | Ключ активации сервера. |
pluginGroups | Data table | Группы плагинов включены в лицензию:
|
Активные плагины
Возвращает информацию об активных плагинахSberMobile Server.
Имя переменной:
plugins
Записи:
0...неограниченно
Разрешения:
Доступно для чтения на уровне прав обозревателя
Формат записи:
Имя поля | Тип поля | Примечания |
id | String | ID плагина. |
type | String | Тип плагина. |
name | String | Описание плагина. |
Установленные модули
Список модулей, установленных в системе, и некоторая идентификационная информация.
Имя переменной:
modules
Записи:
0...неограниченно
Разрешения:
Доступно для чтения на уровне прав обозревателя
Формат записи:
Имя поля | Тип поля | Примечания |
id | String | ID модуля. |
description | String | Описание модуля |
image | Блок данных | Изображение модуля. |
versions | Data table | Информация о версиях модулей. |
Активные клиентские подключения
Возвращает информацию об активных клиентских соединениях.
Имя переменной:
связи
Записи:
0...неограниченно
Разрешения:
Доступно для чтения на уровне прав обозревателя
Формат записи:
Имя поля | Тип поля | Примечания |
user | String | Имя пользователя, прошедшего аутентификацию. |
login | String | Логин аутентифицированного пользователя. Может отличаться от имени пользователя, если используется внешняя аутентификация. |
type | String | Тип соединения (клиент, Web, Web-сервис и т. д.) |
date | Date | Время, когда было установлено соединение. |
address | String | IP-адрес клиента. |
eventsQueued | Long | Текущее количество необработанных событий в очереди событий текущего клиентского сеанса. |
eventsDiscarded | Long | Количество событий, отброшенных во время текущей клиентской сессии из-за переполнения очереди. |
contextLocks | Data table | Список активных контекстных блокировок. |
Имя пользователя текущей сессии
Возвращает имя пользователя текущей сессии.
Имя переменной:
username
Записи:
1
Разрешения:
Доступно для чтения на уровне прав обозревателя
Формат записи:
Имя поля | Тип поля | Примечания |
value | String | Имя пользователя, прошедшего аутентификацию. |
Вход в текущую сессию
Возвращает логин текущей сессии.
Имя переменной:
login
Записи:
1
Разрешения:
Доступно для чтения на уровне прав обозревателя
Формат записи:
Имя поля | Тип поля | Примечания |
value | String | Логин аутентифицированного пользователя. Может отличаться от имени пользователя, если используется внешняя аутентификация. |
Тип соединения текущей сессии
Возвращает текущий тип подключения к сессии.
Имя переменной:
type
Записи:
1
Разрешения:
Доступно для чтения на уровне прав обозревателя
Формат записи:
Имя поля | Тип поля | Примечания |
value | String | Тип соединения (клиент, веб-интерфейс, веб-служба и т. д.) |
Статус кластера
Возвращает информацию о состоянии узлов отказоустойчивого кластера.
Имя переменной:
cluster
Записи:
0...неограниченно
Разрешения:
Доступно для чтения на уровне прав обозревателя
Формат записи:
Имя поля | Тип поля | Примечания |
id | String | Идентификатор узла кластера. |
role | Integer | Роль узла кластера. |
time | Long | Время, прошедшее с момента подтверждения состояния узла в режиме реального времени. |
Потоки
Возвращает полный список потоков сервера.
Имя переменной:
threads
Записи:
0...неограниченно
Разрешения:
Доступно для чтения на уровне прав администратора
Формат записи:
Имя поля | Тип поля | Примечания |
id | Long | Уникальный идентификатор нити. |
name | String | Название нити. |
group | String | Имя группы нитей. |
priority | Integer | Приоритет нити. |
state | String | Состояние нити. |
daemon | Boolean | Истина, если поток является потоком демона. |
interrupted | Boolean | True, если поток был прерван. |
cpu | Double | Средняя загрузка процессора в последнюю секунду работы сервера. Измеряется в процентах от общей загрузки процессора сервера. Потоки, которые в данный момент заблокированы, имеют нулевую загрузку процессора, а новые потоки отображаются с NULL-загрузкой. |
stack | Data table | Отслеживание стека нитей со следующими полями:
|
Статистика пулов потоков
Возвращает статистическую информацию о пулах потоков сервера. Это позволяет диагностировать состояние и производительность различных пулов потоков сервера, включая, но не ограничиваясь ими:
Исполнители синхронизации, т.е. потоки, выполняющие задачи синхронизации устройств
Таймеры синхронизации, инициирующие синхронизацию новых устройств по расписанию
Исполнители контекстных операций, обеспечивающие одновременный запуск/выключение сервера, а также параллельное выполнение задач, поднимаемых контекстами
Процессоры команд клиента - потоки, отвечающие за обработку запросов, полученных от экземпляров SberMobile IIoT Platform Client и через API сервера.
Отправители команд, которые передают команды протокола SberMobile в сетевые сокеты
Асинхронные обработчики обновлений, которые обрабатывают события и обновления значений, полученные по протоколу SberMobile
Пользовательские пулы потоков, используемые такими модулями, как Alerts, Trackers и т. д.
Имя переменной:
pools
Записи:
0...неограниченно
Разрешения:
Доступно для чтения на уровне прав администратора
Формат записи:
Имя поля | Тип поля | Примечания |
poolName | String | Название бассейна. |
activeCount | Integer | Количество активных задач. |
completedCount | Long | Количество выполненных заданий. |
totalCount | Long | Общее количество заданий. |
coreSize | Integer | Размер ядра бассейна. |
largestSize | Integer | Наибольший (пиковый) размер пула. |
maximumSize | Integer | Максимально допустимый размер бассейна. |
queueLength | Integer | Длина очереди задач. |
Статистика потоков
Возвращает общую статистику по потокам сервера.
Имя переменной:
threadStatistics
Записи:
1
Разрешения:
Доступно для чтения на уровне прав администратора
Формат записи:
Имя поля | Тип поля | Примечания |
live | Integer | Количество работающих в данный момент потоков. |
maximumLive | Integer | Максимальное количество одновременно работающих потоков с момента запуска сервера. |
totalStarted | Integer | Общее количество потоков, запущенных с момента запуска сервера. |
Серверная среда
Возвращает информацию о виртуальной машине Java, на которой запущен SberMobile Server, и о сервере/ПК, на котором он запущен.
Имя переменной:
environment
Записи:
0...неограниченно
Разрешения:
Доступно для чтения на уровне прав обозревателя
Формат записи:
Имя поля | Тип поля | Примечания |
property | String | Название недвижимости. |
value | String | Стоимость имущества. |
Детали обработки событий
Возвращает общую информацию и статистику по обработке событий на сервере.
Имя переменной:
eventProcessingDetails
Записи:
0...неограниченно
Разрешения:
Доступно для чтения на уровне прав администратора
Формат записи:
Имя поля | Тип поля | Примечания |
eventQueueLength | Integer | Длина очереди диспетчера событий контекста сервера. |
eventsScheduled | Long | Общее количество запланированных событий. |
eventsProcessed | Long | Общее количество обработанных событий. |
Статистика правил обработки событий
Возвращает статистическую информацию, собранную правилами обработки событий. Обратите внимание, что статистика правил обработки событий сбрасывается при перезагрузке сервера.
Имя переменной:
eventRuleStatistics
Записи:
0...неограниченно
Разрешения:
Доступно для чтения на уровне прав администратора
Формат записи:
Имя поля | Тип поля | Примечания |
context | String | Контекстный путь. |
event | String | Название мероприятия. |
filtered | Long | Количество событий, которые были подавлены этим правилом. |
stored | Long | Количество событий, которые прошли правила и были сохранены в базе данных сервера. |
Подробности очереди событий
Возвращает статистическую информацию об очереди событий. Обратите внимание, что если в очереди нет событий, то в этой переменной не будет записей.
Имя переменной:
EventQueueStatistics
Записи:
0...неограниченно
Разрешения:
Доступно для чтения на уровне прав администратора
Формат записи:
Имя поля | Тип поля | Примечания |
context | String | Контекстный путь. |
eventCount | Long | Количество необработанных событий, которые присутствуют в очереди для данного контекста. |
Статистика событий
Возвращает количество событий, сгруппированных по таблице базы данных SberMobile Server, пути к контексту и имени события.
Имя переменной:
eventStatistics
Записи:
0...неограниченно
Разрешения:
Доступно для чтения на уровне прав администратора
Формат записи:
Имя поля | Тип поля | Примечания |
table | String | Имя таблицы базы данных. |
context | String | Контекстный путь. |
event | String | Название мероприятия. |
count | Long | Количество событий указанного типа, произошедших в указанном контексте. Обратите внимание, что все события определенного типа, произошедшие в одном контексте, всегда хранятся в одной таблице. |
Статистика переменных
Возвращает, сколько значений переменных хранится в базе данных для каждого контекста SberMobile Server.
Имя переменной:
variableStatistics
Записи:
0...неограниченно
Разрешения:
Доступно для чтения на уровне прав администратора
Формат записи:
Имя поля | Тип поля | Примечания |
context | String | Контекстный путь. |
count | Long | Количество значений контекстной переменной, которые в данный момент хранятся в базе данных. Обратите внимание, что значения переменных по умолчанию не сохраняются в базе данных, и поэтому сразу после установки сервера их количество может быть очень низким. |
Очистка памяти
Возвращает информацию о состоянии подсистемы управления памятью, которая контролирует непостоянный кэш значений переменных и других больших структур в памяти. Операция Memory Clearing отслеживает потребление памяти кучи JVM, частично или полностью очищая кэш при необходимости. Режим Low Memory Mode активируется в попытке предотвратить ошибки Out Of Memory, когда выделенной памяти недостаточно для выполнения операций, требующих много памяти.
Имя переменной:
memoryClearing
Записи:
0...неограниченно
Разрешения:
Доступно для чтения на уровне прав администратора
Формат записи:
Имя поля | Тип поля | Примечания |
lowMemoryMode | Boolean | Указывает, что активен режим Low Memory Mode, и только определенные функции сервера будут доступны до тех пор, пока использование памяти не станет ниже максимального порога. |
lastLowMemoryModeDuration | Long | Количество миллисекунд, прошедших во время последней активации режима Low Memory Mode. |
currentCacheEntryCount | Integer | Текущее количество записей в кэше. |
maximumCacheEntryCount | Integer | Наибольшее количество наблюдаемых записей в кэше. |
estimatedCacheSize | Long | Предполагаемый размер кэша, выраженный в байтах. |
lastCleaningDuration | Long | Количество миллисекунд, прошедших во время последней операции очистки памяти. |
lastCleaningStart | Date | Временная метка, указывающая, когда операция очистки памяти была активирована в последний раз. |
clearingRunsCount | Integer | Количество раз, когда операция очистки памяти была активирована с момента запуска сервера. |
lastCleanedMemorySize | Long | Количество байтов, очищенных из кэша во время последней операции очистки памяти. |
lastCleanedEntityCount | Integer | Общее количество сущностей, удаленных из кэша во время последней операции очистки памяти. |
Публичные функции
[ ? ]
Зарегистрируйте новую учетную запись пользователя
Регистрирует новую учетную запись пользователя.
Название функции:
register
Разрешения:
Доступно на уровне разрешения None
Входные записи:
1
Формат входа :
Имя
Тип
Описание
имя
String
Имя пользователя учетной записи.
пароль
String
Пароль учетной записи.
passwordre
String
Повторите пароль учетной записи для подтверждения.
initializationPassword
Boolean
Если значение True, то после первого успешного входа в систему пользователю будет необходимо сменить пароль.
разрешения
String
Уровень разрешений для нового пользователя. Используется только в том случае, если регистрация выполняется администратором.
adminPermissions
String
Если выбрано это значение, SberMobile будет пытаться использовать метод внешней аутентификации во время последовательности аутентификации и авторизации.
globalPermissions
String
Уровень разрешения, который пользователь будет иметь для глобальных ресурсов, не принадлежащих ни одному пользователю.
useExternalAuthentication
Boolean
Указывает, что пользователь должен быть аутентифицирован с помощью плагина внешней аутентификации.
externalUser
String
Необязательно, указывает внешнего пользователя, с которым должна быть связана эта учетная запись.
Выходные записи:
0
Формат вывода :
Нет
Вход в систему
Пройдите аутентификацию/авторизацию и продолжите сеанс с правами доступа определенного пользователя.
Название функции:
login
Разрешения:
Доступно на уровне разрешения None
Входные записи:
1
Формат входа :
Имя
Тип
Описание
имя пользователя
String
Имя пользователя для аутентификации.
пароль
String
Пароль учетной записи пользователя.
код
String
Код аутентификации (необязательно).
государство
String
Состояние аутентификации (необязательно).
поставщик
String
Поставщик аутентификации (необязательно).
countAttempts
Boolean
Определяет, включен ли подсчет попыток входа в систему (необязательно).
Выходные записи:
0
Формат вывода :
Нет
Выход из системы
Выйдите из системы, чтобы продолжить сеанс с правами пользователя None.
Название функции:
logout
Разрешения:
Доступно на уровне разрешения None
Входные записи:
0
Формат входа :
Нет
Выходные записи:
0
Формат вывода :
нет
Если вы вызовете эту функцию в виджете внутри веб-окружения, то не сможете увидеть никаких изменений до обновления страницы. Но вместо этого можно использовать операцию Logout корневой панели виджета.
Изменить пароль
Изменение пароля текущей аутентифицированной учетной записи пользователя.
Название функции:
changePassword
Разрешения:
Доступно на уровне прав оператора
Входные записи:
1
Формат входа :
Имя
Тип
Описание
oldPassword
String
Старый пароль для учетной записи.
newPassword
String
Новый пароль.
repeatPassword
String
Должен совпадать с новым паролем.
Выходные записи:
0
Формат вывода :
Нет
Выполнить запрос
Выполняет пользовательский запрос с правами текущего пользователя.
Название функции:
executeQuery
Разрешения:
Доступно на уровне прав обозревателя
Входные записи:
1
Формат входа :
Имя
Тип
Описание
запрос
String
Текст запроса.
Выходные записи:
0...неограниченно
Формат вывода :
Динамический
Выполнить прямой запрос к СУБД
Выполняет собственный запрос к базе данных SberMobile Server. Более подробную информацию можно найти в контекстных ссылках "Запросы".
Название функции:
executeNativeQuery
Разрешения:
Доступно на уровне прав администратора
Входные записи:
1
Формат входа :
Имя
Тип
Описание
запрос
String
Текст запроса.
обновление
Boolean
Флаг, указывающий на то, что запрос является запросом на обновление (DELETE, INSERT, UPDATE и т. д.).
Выходные записи:
0...неограниченно
Формат вывода :
Динамический
Перезапустить сервер
Перезапускает SberMobile Server.
Название функции:
restart
Разрешения:
Доступно на уровне прав администратора
Входные записи:
1
Формат входа :
Имя
Тип
Описание
мгновенно
Boolean
Позволяет выбрать между немедленным и отложенным перезапуском.
задержка
Long
Задержка перед запланированным перезапуском.
причина
String
Причина запланированного перезапуска.
Выходные записи:
0
Формат вывода :
нет
Остановить сервер
Остановите SberMobile Server.
Название функции:
stop
Разрешения:
Доступно на уровне прав администратора
Входные записи:
1
Формат входа :
Имя
Тип
Описание
мгновенно
Boolean
Позволяет выбрать между немедленным и отложенным выключением.
задержка
Long
Задержка перед запланированным отключением.
причина
String
Причина планового отключения.
Выходные записи:
0
Формат вывода :
нет
Начать режим обслуживания
Это действие заставляет сервер перейти в режим обслуживания.
Название функции:
startMaintenanceMode
Разрешения:
Доступно на уровне прав администратора
Входные записи:
0
Формат входа :
Нет
Выходные записи:
0
Формат вывода :
нет
Остановка режим обслуживания
Это действие заставляет сервер выйти из режима обслуживания.
Название функции:
stopMaintenanceMode
Разрешения:
Доступно на уровне прав администратора
Входные записи:
0
Формат входа :
Нет
Выходные записи:
0
Формат вывода :
нет
Задать переменную сессии
Устанавливает значение переменной сессии. Переменная доступна до тех пор, пока открыта текущая сессия пользователя.
Название функции:
sessionSet
Разрешения:
Доступно на уровне прав оператора
Входные записи:
1
Формат входа :
Имя
Тип
Описание
sessionVariable
String
Имя переменной сеанса.
sessionValue
Data table данных
Переменное значение.
Выходные записи:
0...неограниченно
Формат вывода :
нет
Получить переменную сессии
Получает значение упомянутой переменной сессии.
Название функции:
sessionGet
Разрешения:
Доступно на уровне прав оператора
Входные записи:
1
Формат входа :
Имя
Тип
Описание
sessionVariable
String
Имя переменной сеанса.
Выходные записи:
0...неограниченно
Формат вывода :
Динамический
Публичные события
[ ? ]
Общие события: info (Информация)
Контекст Добавлен
Возникает при добавлении нового контекста любого типа в дерево контекстов сервера. Это событие может происходить несколько раз для одного и того же контекста, например, при каждом запуске сервера.
Название события
contextAdded
Разрешения:
Доступно на уровне прав администратора
Срок действия:
Непостоянный
Записи:
1
Формат записи:
Имя поля | Тип поля | Примечания |
context | String | Путь контекста. |
Контекст удален
Возникает, когда контекст любого типа удаляется из дерева контекстов сервера. Это событие может происходить несколько раз для одного и того же контекста, например, при каждом выключении сервера.
Название события
contextRemoved
Разрешения:
Доступно на уровне прав администратора
Срок действия:
Непостоянный
Записи:
1
Формат записи:
Имя поля | Тип поля | Примечания |
context | String | Путь контекста. |
Контекст создан
Возникает при создании нового контекста ресурса (например, оповещения, виджета или устройства ). В отличие от события contextAdded, это событие срабатывает только один раз для каждого ресурса при его первоначальном создании. Оно не будет повторяться при запуске сервера.
Название события
contextCreated
Разрешения:
Доступно на уровне прав администратора
Срок действия:
Непостоянный
Записи:
1
Формат записи:
Имя поля | Тип поля | Примечания |
context | String | Путь контекста. |
Контекст уничтожен
Возникает при окончательном уничтожении контекста ресурса (например, оповещения, виджета или устройства ). В отличие от события contextRemoved, это событие срабатывает только один раз при удалении ресурса. Оно не срабатывает во время отключения сервера.
Название события
contextDestroyed
Разрешения:
Доступно на уровне прав администратора
Срок действия:
Непостоянный
Записи:
1
Формат записи:
Имя поля | Тип поля | Примечания |
context | String | Путь контекста. |
Добавлена сущность контекста
Возникает при добавлении нового определения сущности (переменной, функции, события, действия) в любой контекст сервера.
Название события
contextEntityAdded
Разрешения:
Доступно на уровне прав администратора
Срок действия:
Непостоянный
Записи:
1
Формат записи:
Имя поля | Тип поля | Примечания |
context | String | Путь к контексту, в который была добавлена сущность. |
entity | String | Название организации. |
entityType | Integer | Тип субъекта:
|
Контекстная сущность удалена
Возникает, когда определение сущности (переменная, функция, событие, действие) удаляется из любого контекста сервера.
Название события
contextEntityRemoved
Разрешения:
Доступно на уровне прав администратора
Срок действия:
Непостоянный
Записи:
1
Формат записи:
Имя поля | Тип поля | Примечания |
context | String | Путь к контексту, из которого была удалена сущность. |
entity | String | Название организации. |
entityType | Integer | Тип субъекта:
|
Обратная связь
Сервер генерирует это событие, чтобы сообщить о своей активности, связанной с текущим зарегистрированным пользователем.
Название события
feedback
Разрешения:
Доступно на уровне прав обозревателя
Срок действия:
Непостоянный
Записи:
1
Формат записи:
Имя поля | Тип поля | Примечания |
message | String | Сообщение сервера. |
Запуск сервера
Сервер генерирует это событие, чтобы сообщить о завершении запуска.
Название события
serverStarted
Разрешения:
Доступно на уровне прав обозревателя
Срок действия:
Непостоянный
Записи:
1
Формат записи:
Имя поля | Тип поля | Примечания |
startupDuration | Long | Продолжительность запуска в миллисекундах. |
Переменная сессии обновлена
Возникает при обновлении переменной сессии.
Название события
sessionVariableUpdated
Разрешения:
Доступно на уровне прав обозревателя
Срок действия:
Непостоянный
Записи:
1
Формат записи:
Имя поля | Тип поля | Примечания |
sessionVariable | String | Имя обновленной переменной сеанса. |
sessionOldValue | Data table | Старое значение переменной сессии. |
sessionNewValue | Data table | Новое значение переменной сессии. |