Корневой контекст

Этот контекст является корнем контекстного дерева SberMobile Server. У него есть некоторые основные действия, которые используются для осуществления контроля за  сервером.

Уникальные действия

[?]

Настроить сервер

Это действие используется для просмотра или редактирования опций глобальной конфигурации SberMobile Server. Его единственное отличие от стандартного действия настроить заключается в том, что оно подсказывает пользователю перезагрузить сервер, когда сохранены новые параметры (перезагрузка необходима для применения изменений). Дополнительную информацию о настройке сервера можно найти здесь.

Тип действия:

настроить

Имя действия:

configureServer

Иконка действия:

Права доступа:

Доступно на уровне с правами доступа для Администратора.  

Просмотреть информациюи о сервере

Это действие отображает информацию о среде выполнения SberMobile Server. Оно может оказаться полезным для отладки сервера и разрешения проблем, связанных с производительностью.

Доступно несколько разделов:

  • Статус сервера. Различная информация о рабочем статусе сервера в режиме реального времени, например, о времени запуска или использовании памяти.

  • Среда сервера. Информация о среде выполнения Java и о машинной и операционной системах, на которой запущен контекст.

  • База данных. Информация о базе данных SQL, которая используется в текущей установке SberMobile в качестве конфигурации и хранилища событий.

  • Статистика контекстов. Список всех контекстов и количеств переменных, функций, событий и действий в каждом контексте.

  • Лицензионная информация. Информация о лицензии SberMobile.

  • Активные плагины. Информация о плагинах, которые SberMobile Server использует в настоящий момент.

  • Активные клиентские подключения. Список подключенных в настоящий момент клиентов, включая удаленные адреса и тип/время подключения.

  • Потоки. Список потоков сервера, включая их состояние и трассировку стека. Эту информацию может запросить группа тех. поддержки SberMobile.

  • Статистика пулов потоков. Список активных и законченных задач для каждого пула серверных потоков. Эта информация может оказаться полезной при анализе нагрузки на процессор сервера.

  • Статистика правил обработки событий. Деталированная информация о событиях, обрабатываемых с помощью правил обработки событий: количество отклоненных, хранимых и дедуплицированных событий.

  • Детали очереди событий. Когда очередь событий SberMobile Server не пустует, то здесь указываются детали событий, количество событий в очереди для каждого контекста.

Тип действия:

настроить (режим только для чтения)

Имя действия:

viewServerInfo

Иконка действия:

Права доступа:

Доступно на уровне с правами доступа для Администратора.

Создать ресурсы

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

Имя действия:

createResources

Иконка действия:

Права доступа:

Доступно на уровне с правами доступа для Менеджера.

Удалить ресурсы

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

Имя действия:

deleteResources

Иконка действия:

Права доступа:

Доступны на уровне с правами доступа для Менеджера

Остановить сервер

Это действие позволяет остановить SberMobile Server. Существуют два варианта: немедленное и отложенное выключение. В случае отложенного выключения все активные операторы информируются о времени и причине выключения. Это позволяет им отложит текущие задачи в сторону и сохранить все изменения перед выключением.

Тип действия:

Вызвать функцию

Имя действия:

stop

Иконка действия:

Права доступа:

Доступно на уровне с правами доступа для Администратора.

Перезапустить сервер

Это действие позволяет перезапустить SberMobile Server. Существует два варианта: немедленный или отложенный перезапуск. В случае отложенного перезапуска все активные операторы информируются о времени и причине перезапуска. Это позволяет им отложит текущие задачи в сторону и сохранить все изменения перед перезапуском.

Автоматический перезапуск возможен только в том случае, когда SberMobile Server запущен в сервисном режиме. В других случаях сервер следует остановить и запустить вновь вручную.

Тип действия:

Вызвать функцию

Имя действия:

restart

Иконка действия:

Права доступа:

Доступно на уровне с правами доступа для Администратора.

Начать режим обслуживания

Это действие заставляет сервер войти в режим обслуживания.

Тип действия:

Вызвать функцию

Имя действия:

startMaintenanceMode

Права доступа:

Доступно на уровне с правами доступа для Администратора.

Закончить режим обслуживания

Это действие заставляет сервер выйти из режима обслуживания.

Тип действия:

Вызвать функцию

Имя действия:

stopMaintenanceMode

Права доступа:

Доступно на уровне с правами доступа для Администратора.

Удаленное обновление

Это действие вызов функции используется для удаленного обновления SberMobile Server. Более подробно об этом см. Удаленное обновление.

Тип действия:

Вызвать функцию

Имя действия:

upgrade

Права доступа:

Доступно на уровне с правами доступа для Администратора.

Сменить пароль

Это действие вызов функции используется для смены пароля авторизованного в текущий момент пользователя.  

Тип действия:

вызвать функцию

Имя действия:

changePassword

Права доступа:

Доступно на уровне с правами доступа для Оператора.

Поиск

Это действие используется для получения доступа к диалогу универсального поиска.

Имя действия:

search

Иконка действия:

Права доступа:

Доступно на уровне прав доступа Нет прав.

Показать историю переменной

Это действие вызывает функцию и используется для доступа и просмотра обновленной истории определенной переменной. Она предлагает пользователю задать следующие опции:  

  • Контекст, в котором определена переменная;

  • Имя переменной;

  • Дата начала - для отслеживания обновления истории с определенной даты.

Это действие выводит историю изменений переменной в форме таблицы. Каждое поле формата отслеживаемой переменной отображается в отдельном поле итоговой таблицы. Если значение переменной содержит несколько рядов, отображаются данные лишь первого ряда.

Тип действия:

вызвать функцию

Имя действия:

variableHistory

Иконка действия:

Права доступа:

Доступно на уровне с правами доступа для Администратора.

Показать историю события

Это действие вызов функции используется для выбора и просмотра определенных событий из истории событий. Оно предлагает пользователю задать выбор события и критерии его отображения:  

  • Маска контекстов, из которой следует выбирать события;

  • Имя события;

  • Выражение фильтрации событий;

  • Дата начала - для выбора лишь тех событий, которые происходили после определенной даты.

Ниже представлен пример вывода (выбор событий входа в систему пользователя, Контекстная маска = пользователи, Имя события = login, Выражение фильтра = ""):

Тип действия:

Вызвать функцию

Имя действия:

eventHistory

Иконка действия:

Права доступа:

Доступно на уровне с правами доступа для Администратора.

Стереть историю события

Это действие вызов функции используется для удаления определенных событий из истории событий. Оно предлагает пользователю задать критерий выбора события:

  • Маска контекстов, из которой следует удалить события;  

  • Имя события;

  • Начальная дата - для удаления лишь тех событий, которые возникли после определенной даты (факультативно);

  • Конечная дата - для удаления лишь тех событий, которые произошли до определенной даты (факультативно).

Тип действия:

Вызвать функцию

Имя действия:

deleteEvents

Права доступа:

Доступно на уровне с правами доступа для Администратора.

Показать статистику канала

Это действие вызов функции используется для просмотра статистики для определенного статистического канала. Он предлагает пользователю задать свойства канала:

  • Маска контекстов, где определен канал;

  • Имя канала;

  • Ключ пакета данных статистики;

  • Период группировки (час, день и т.д.);

  • Типы агрегирования (среднее, максимальное и др.)

Это действие выводит статистику канала в форме таблицы.

Тип действия:

Вызвать функцию

Имя действия:

viewStatistics

Иконка действия:

Права доступа:

Доступно на уровне с правами доступа для Администратора.

Просмотр необработанной статистики канала

Это действие вызов функции используется для просмотра необработанной статистики определенного статистического канала. Оно помогает пользователю определить свойства канала:

  • Маска контекстов, где определяется канал;

  • Имя канала.

Это действие выводит статистику каналов в табличной форме.

Тип действия:

Вызвать функцию

Имя действия:

viewRawStatistics

Иконка действия:

Права доступа:

Доступно на уровне с правами доступа для Администратора.

Очистить канал статистики

Это действие вызов функции используется для удаления всех данных, собранных определенным стаистическим каналом. Оно помогает пользователю определить свойства канала:

  • Маску контекстов, где определяется канал;

  • Имя канала.

Это действие выводит статистику каналов в табличной форме.

Тип действия:

Вызвать функцию

Имя действия:

deleteStatistics

Права доступа:

Доступно на уровне с правами доступа для Администратора.

Заполнить статистику по истории переменной

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

Действие применимо для возобновления статистики, если файл статистики поврежден или отсутствует по какой-либо причине.

Вся статистика, собранная в канале, будет утеряна после выполнения этого действия.

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

Если необработанная история доступна только для определенного периода, тогда канал будет содержать статистику для этого периода.

Действие помогает пользователю определить свойства канала:

  • Маску контекстов, где определяется канал;

  • Имя канала.

Тип действия:

Вызвать функцию

Имя дествия:

fillStatisticsFromHistory

Права доступа:

Доступно на уровне с правами доступа для Администратора.

Сгенерировать дамп потоков

Это действие используется, чтобы сгенерировать дамп потоков. Дамп потоков - это текстовый файл со списом всех потоков Java, которые в данный момент активизированы в виртуальной машине Java.

Тип действия:

Вызвать функцию

Имя действия:

generateThreadDump

Права доступа:

Доступно на уровне с правами доступа для Менеджера.

Сгенерировать дамп памяти

Это действие используется, чтобы сгенерировать дамп памяти. Дамп памяти - это файл в двоичном формате, который содержит детали распределения памяти внутри JVM сервера.

Тип действия:

Вызвать функцию

Имя действия:

generateHeapDump

Права доступа:

Доступно на уровне с правами доступа для Менеджера.

Показать статистику контекстов

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

Тип действия:

Вызвать функцию

Имя действия:

viewContextsInfo

Права доступа:

Доступно на уровне с правами доступа для Менеджера.

Импорт

Используется для импортирования общих данных в систему при помощи скрипта.

Порядок действий:

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

  • [Не обязательно] Задать опции импорта, если есть опции, доступные для формата выбранного файла.

  • На этом этапе данные считываются из файла и преобразовываются в таблицу данных.

  • На этом этапе запускается скрипт импорта, импортируемая Таблица данных передается в его входных параметрах. Скрипт должен последовательно обработать записи данных таблицы и выполнить необходимые изменения в системе (например, создать/изменить ресурсы).  

Имя действия:

import

Иконка действия:

Неинтерактивный режим:

не поддерживается

Права доступа:

Доступно на уровне с правами доступа для Администратора.

Выполнить приложение

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

Тип действия:

Вызвать функцию

Имя действия:

execute

Права доступа

Доступно на уровне с правами доступа для Администратора.

Группа действия:

Дополнительные действия

Запустить очистку памяти

Действие используется для запуска цикла полной очистки динамической памяти виртуальной машины Java с работающим SberMobile Server. Используйте это действие до проверки Использования памяти, параметра % максимально допустимого использования переменной Статус сервера, чтобы узнать реальное потребление памяти сервера.

Выполнение данного действия заставит JVM заморозить все активности до окончания процесса очистки (так называемый "stop the world"). Это приведет к простою SberMobile Server и всех приложений, работающих на нем. Обычно простой длится несколько секунд, но в случае большого размера кучи JVM время простоя может увеличиться до нескольких минут.

Более подробно см. в разделе Использование памяти.

Тип действия:

Вызвать функцию

Имя действия:

runGarbageCollection

Права доступа

Доступно на уровне с правами доступа для Администратора.

Группа действия:

Дополнительные действия

Показать статистику базы данных

Это действие отображает ряд событий и свойств во всех таблицах базы данных SberMobile Server . Ряд событий/свойств сгруппированы согласно таблицам БД, пути контекста и именам события/свойства.

Тип действия:

Редактировать свойства

Имя действия:

viewDatabaseStatistics

Права доступа:

Доступно на уровне с правами доступа для Администратора

Группа действия:

Дополнительные действия

Открыть в браузере

Это действие позволяет пользователю открыть определенный URL-адрес в клиентском браузере по умолчанию.

Имя действия:

browse

Неинтерактивный режим:

не поддерживается

Права доступа:

Доступно на уровне с правами доступа для Наблюдателя

Параметры выполнения:

  • URL. Может быть определено как поле Строка url таблицы ввода действия.

Сравнить

Это действие позволяет пользователю сравнивать две строки в графическом модуле поиска различий (Diff Viewer).

Имя действия:

compare

Неинтерактивный режим

не поддерживается

Права доступа:

Доступно на уровне с правами доступа для Наблюдателя

Параметры выполнения

  • Левый заголовок. Заголовок левого поля diff viewer.

  • Левое значение. Значение, которое отображается в левом поле diff viewer.

  • Правый заголовок. Заголовок правого поля diff viewer.

  • Правое значение. Значение, которое отображается в правом поле diff viewer.

Прекратить клиентское соединение

Это действие используется для принудительной деаутентификации и отключения одной или более клиентских сессий, независимо от их типа (дектоп, web, API, с т.д.)

Тип действия:

Вызвать функцию

Имя действия:

terminateClientConnection

Права доступа:

Доступно на уровне с правами доступа для Администратора

Группа действия:

Дополнительные действия

Общие действия

[?]

Редактировать права доступа к контексту, Просмотр событий

Состояния и иконки контекста

У данного контекста нет состояний. Он обычно представлен иконкой . В SberMobile IIoT Platform Client иконка, представляющая контекст, зависит от состояния подключения. См. дополнительную информацию здесь.

Дополнительная информация

Информация о контексте

Тип контекста: корневой

Имя контекста: "" (пустая строка)

Описание контекста: "" (пустая строка)

Путь контекста: "" (пустая строка)

Контекстная маска: "" (пустая строка)

Права доступа к контексту

[?]

Уровень

Описание

Отсутствует

Вход в систему пользователей.

Саморегистрация пользователей.

Наблюдатель

Выполнение запросов SberMobile в текстовом виде.

Оператор

Изменение пароля пользователя.

Менеджер

Создание ресурсов.

Инженер

Запросы на проверку и обработку входящей почты.

Администратор

Просмотр информации о сервере.

Остановка и перезапуск сервера.

Выполнение запросов в текстовом формате.

Выполнение внешних приложений.

Доступ к истории и статистике переменных/событий.

Просмотр статистики базы данных.

Отправка E-mail и SMS сообщений.

Общие переменные (свойства)

[?]

Версия сервера

Возвращает версию SberMobile Server.

Имя переменной:

version

Записи:

1

Права доступа:

Доступно для чтения на уровне с правами доступа для Наблюдателя.  

Формат записи:

Имя поля

Тип поля

Примечания

version

Строка

Строка версии сервера.

Статус сервера

Возвращает информацию о времени работы SberMobile Server.

Имя переменной:

status

Записи:

1

Права доступа:

Доступно для чтения на уровне с правами доступа для Наблюдателя.  

Формат записи:

Имя поля

Тип поля

Примечания

name

String

Описание экземпляра сервера.

version

String

Версия сервера.

buildNumber

String

Номер сборки версии сервера.

installationDate

Date

Дата инсталляции.

startTime

Date

Временная метка запуска сервера.

startupDuration

Long

Время, требуещееся для запуска сервера.

uptime

Long

Оперативное время сервера.

maxMemory

Long

Максимальный разрешенный размер памяти (heap) виртеальной машины Java (JVM). Контролируется параметром -Xmx.

totalMemory

Long

Текущий размер аллоцированной памяти (heap) JVM.

freeMemory

Long

Свободная часть аллоцированной памяти (heap) JVM.

memoryUsage

Double

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

cpuLoad

Double

Загрузка процессора виртуальной машиной Java.

cpuLoadSystem

Double

Общая загрузка процессора CPU load.

eventQueueLength

Integer

Длина очереди событий контекста сервера.

eventsScheduled

Long

Общее число запланированных событий.

eventsProcessed

Long

Общее число обрабатываемых событий.

diskUtilization

Data Table

Информация об использовании диска.

Статистика базы данных

Возвращает обзор статистики базы данных SberMobile Server.

Имя переменной:

database

Записи:

1

Права доступа:

Доступно для чтения на уровне с правами доступа для Наблюдателя.

Формат записи:

Имя поля

Тип поля

Примечания

queries

Long

Количество выполненных запросов с момент запуска сервера.

transactions

Long

Количество выполненных транзакций с момент запуска сервера.

loaded

Long

Количество вызванных из базы данных объектов с момент запуска сервера.

updated

Long

Количество обновленных в базе данных объектов с момент запуска сервера.

inserted

Long

Количество внесенных в базу данных объектов с момента запуска сервера.

deleted

Long

Количество удаленных из базы данных объектов с момента запуска сервера.

maxQueryTime

Long

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

Статистика таблиц базы данных

Возвращает подробную статистику таблиц базы данных SberMobile Server.

Имя переменной:

tables

Записи:

0... не ограничено

Права доступа:

Доступно для чтения на уровне с правами доступа для Наблюдателя.

Формат записи:

Имя поля

Тип поля

Примечания

table

String

Имя таблицы.

loaded

Long

Количество вызванных из таблицы объектов с момента запуска сервера.

updated

Long

Количество обновленных в таблице объектов с момента запуска сервера.

inserted

Long

Количество внесенных в таблицу объектов с момента запуска сервера.

deleted

Long

Количество удаленных из таблицы объектов с момента запуска сервера.

Статистика кластера базы данных

Возвращает подробную статистику кластера базы данных SberMobile Server.

Имя переменной:

databaseCluster

Записи:

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

Итоговое количество определений функции в контексте.

eventCount

Integer

Итоговое количество определений события в контексте.

actionCount

Integer

Итоговое количество определений события в контексте.

variablesRead

Long

Количество выполненных операций чтения переменных с момента запуска сервера.

variablesWritten

Long

Количество выполненных операций записи переменных с момента запуска сервера.

functionsCalled

Long

Количество выполненных операций вызова функции с момента запуска сервера.

eventsFired

Long

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

eventHandleOffers

Long

Количество предложений обработчикам событий на обработку данного события.

eventHandleExecutions

Long

Количество обработок данного события обработчиком событий.

eventListenerCount

Long

Количество слушателей данного события.

eventQueuesLength

Long

Очередь внутренних событий контекста для данного события.

memory

Long

Примерный объем динамической памяти, удерживаемый данным контекстом.

Статистика устройств

Возвращает краткую статистическую информацию об устройствах SberMobile Server.

Имя переменной:

deviceStatistics

Записи:

1

Права доступа:

Доступно для чтения на уровне с правами доступа для Наблюдателя.

Формат записи:

Имя поля

Тип поля

Примечания

variablesRead

Long

Количество операций чтения переменной, выполненных с момента запуска сервера.

variablesWritten

Long

Количество операций записи переменной, выполненных с момента запуска сервера.

functionsCalled

Long

Количество операция вызова функций, выполненных с момента запуска сервера.

eventsFired

Long

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

Лицензионная информация

Возвращает информацию об активной лицензии SberMobile Server.

Имя переменной:

license

Записи:

1

Права доступа:

Доступно для чтения на уровне с правами доступа для Наблюдателя.  

Формат записи:

Имя поля

Тип поля

Примечания

issueDate

Data

Дата выдачи лицензии.

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

Описание плагина.

Активные клиентские подключения

Возвращает информацию об активных подключениях клиента.

Имя переменной:

connections

Записи:

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

Строка

Вход авторизованного пользователя. Может отличаться от имени пользователя при использовании внешней аутентификации.

Текущий тип соединения сессии

Возвращает текущий тип соединения сессии.

Имя переменной:

type

Записи:

1

Права доступа:

Доступно для чтения на уровне с правами доступа для Наблюдателя

Формат записи:

Имя поля

Тип поля

Примечания

value

String

Тип соединения (Клиент, Веб-клиент, Веб-сервис и т.д.)

Статус кластера

Возвращает информацию о статусе узла отказоустойчивого кластера.

Имя переменной:

cluster

Записи:

0... не ограничено

Права доступа:

Доступно для чтения на уровне с правами доступа для Наблюдателя

Формат записи:

Имя поля

Тип поля

Примечания

id

String

Идентификатор узла кластера.

role

Integer

Роль узла кластера.

time

Long

Истекшее время с момента подтверждения текущего статуса узла.

Потоки

Возвращает полный список потоков сервера.

Имя переменной:

threads

Записи:

0...не ограничено

Права доступа:

Доступно для чтения на уровне с правами доступа Администратор

Формат записи:

Имя поля

Тип поля

Примечания

id

Long

Уникальный ID потока.

name

String

Имя потока.

group

String

Имя группы потока.

priority

Integer

Приоритет потока.

state

String

Состояния потока.

daemon

Boolean

True, если поток является потоком демона.

interrupted

Boolean

True, если поток был прерван.

cpu

Double

Средняя нагрузка на ЦП потока в последнюю секунду работы сервера. Измеряется в процентах от общей нагрузки на ЦП сервера.

Заблокированные потоки имеют нулевую нагрузкеу на ЦП, новые потоки отображаются с нагрузкой NULL.

stack

Data Table

Трек стека потока со следующими полями:  

  • имя класса

  • имя метода

  • имя файла

  • номер строки

Статистика пула потоков

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

  • Исполнителями синхронизации, то есть потоками, выполняющими задания синхронизации устройства

  • Таймерами синхронизации, инициирующими новые синхронизации устройств согласно расписанию

  • Исполнителями операций контекста, которые позволяют производить одновременно включение/выключение сервера, а также параллельно выполнять задания, требуемые контекстами

  • Процессорами команд клиентов, чьи потоки отвечают за обработку запросов, полученных от экземпляров SberMobile IIoT Platform Client посредством API сервера

  • Отправителями команд, которые посылают команды по протоколу SberMobile в сокеты сети

  • Асинхронными обработчиками обновлений, которые обрабатывают события и обновления значений, полученных с помощью протокола SberMobile

  • Пользовательскими пулами потоков, которые используются такими модулями, как Тревоги, Трекеры и т.д.

Имя переменной:

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

Общее количество потоков, запущенных с момента запуска сервера.

Среда сервера

Возвращает информацию о JVM, запускающей SberMobile Server, и о сервере/компьютере, который запущен.

Имя переменной:

environment

Записи:

0...не ограничено

Права доступа:

Доступно для чтения на уровне с правами доступа для Наблюдателя

Формат записи:

Имя поля

Тип поля

Примечания

property

String

Имя свойства.

value

String

Значение свойства.

Статистика правил обработки событий

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

Имя переменной:

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

Количество значений переменной контекста, который в настоящий момент хранятся в БД.

Обратите внимание, что значения переменной, выбранные по умолчанию, не сохраняются в БД, и, т.о., количество может быть очень низким сразу после инсталляции сервера.

Общие функции

[?]

Зарегистрировать новою пользовательскую учетную запись

Регистрирует новую учетную запись пользователя.

Ия функции:

register

Права доступа:

Доступно на уровне с правами доступа Нет прав

Записи ввода:

1

Формат ввода:

Имя

Тип

Описание

username

String

Имя учетной записи.

password

String

Пароль учетной записи.

passwordre

String

Пароль учетной записи.

Права доступа

String

Уровень с правами доступа для нового пользователя. Используется только в том случае, если регистрация была выполнена администратором.

Записи вывода:

0

Формат вывода:

нет

Вход

Передает информацию об аутентификации/авторизации и продолжает сессию с правами доступа для определенного пользователя.

Имя функции:

login

Права доступа:

Доступно на уровне с правами доступа Нет прав

Записи ввода:

1

Формат ввода:

Имя

Тип

Описание

username

String

Имя пользователя для авторизации.

password

String

Пароль учетной записи пользователя.

code

String

Код авторизации (факультативно).

state

String

Статус авторизации (факультативно).

provider

String

Провайдер авторизации (факультативно).

countAttempts

Boolean

Определяет, включен ли подсчет попыток входа (факультативно).

Записи вывода:

0

Формат вывода:

нет

Выход

Выход из системы с продолжением сессии с правами доступа Нет прав.

Имя функции:

logout

Права доступа:

Доступно на уровне с правами доступа Нет прав.

Записи ввода:

0

Формат ввода:

нет

Записи вывода:

0

Формат вывода:

нет

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

Изменить пароль

Изменяет пароль для авторизованного в настоящий момент пользователя учетной записи.

Имя функции:

changePassword

Права доступа:

Доступно на уровне с правами доступа для Оператора.

Записи ввода:

1

Формат ввода:

Имя

Тип

Описание

oldPassword

String

Старый пароль для учетной записи.

newPassword

String

Новый пароль.

repeatPassword

String

Должно соответствовать новому паролю.

Записи вывода:

0

Формат вывода:

нет

Выполнить запрос

Выполняет пользовательский запрос с правами доступа текущего пользователя.  

Имя функции:

executeQuery

Права доступа:

Доступно на уровне с правами доступа для Наблюдателя.

Записи ввода:

1

Формат ввода:

Имя

Тип

Описание

query

String

Текст запроса.

Записи вывода:

0...не ограничено

Формат вывода:

динамический

Выполнить прямой запрос к субд

Выполняет прямой запрос в БД SberMobile Server. Дополнительную информацию см. здесь.

Имя функции:

executeNativeQuery

Права доступа:

Доступно на уровне с правами доступа для Администратора.

Записи ввода:

1

Формат ввода:

Имя

Тип

Описание

query

String

Текст запроса.

update

Boolean

Флажок, указывающий, что это запрос на обновление (DELETE, INSERT, UPDATE и пр.).

Записи вывода:

0...не ограничено

Формат вывода:

динамический

Перезапустить сервер

Перезапускает SberMobile Server.

Имя функции:

restart

Права доступа:

Доступно на уровне с правами доступа для Администратора

Записи ввода:

1

Формат ввода:

Имя

Тип

Описание

instantly

Boolean

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

delay

Long

Задержка перед запуском по расписанию.

reason

String

Причина для перезапуска по расписанию.

Записи вывода:

0

Формат вывода:

нет

Остановить сервер

Останавливает SberMobile Server.

Имя функции:

stop

Права доступа:

Доступно на уровне с правами доступа для Администратора

Записи ввода:

1

Формат ввода:

Имя

Тип

Описание

instantly

Boolean

Позволяет выбирать между немедленным и отложенным выключением.

delay

Long

Задержка перед выключением по расписанию.

reason

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

Формат записи:

Field Name

Тип поля

Примечания

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

Новое значение переменной сессии.