Подсистема "Использование"
Сервисы подсистемы "Использование" предоставляют статистику выполнения. Используя сервисы в этой подсистеме, можно получить следующую информацию.
• Время, требуемое для полного выполнения (минимум, максимум и среднее время)
• Число выполнений сервиса
• Сервисы JavaScript и подписки, прекращенные из-за превышения времени ожидания. См. ниже раздел Статистика выполнения сценария, прерванного из-за времени ожидания.
Статистика (в миллисекундах) записывается со времени последнего перезапуска сервера, но может сохраняться, если включить опцию Включить сохраняемость статистики. При помощи сервиса WriteStatisticsReport CSV-файл, который содержит эту статистику, может быть записан в папку ThingworxStorage.
 |
Статистика предоставляется только для завершенных сервисов. Если выполнение сервиса завершилось неудачно, он не будет включен в статистику.
|
|
Параметр
|
По умолчанию
|
Описание
|
||
|---|---|---|---|---|
|
Включить статистику
|
false
|
Если включено, платформа собирает статистические данные. Если отключено, сервисы не возвращают статистику.
|
||
|
Включить агрегирование наименований сущностей
|
true
|
Если для нескольких сущностей используется один и тот же сервис, отображается объединенная статистика для этих сервисов.
|
||
|
Показать процентили
|
false
|
Отображает дополнительную статистику для процентилей в таблице конфигурации.
|
||
|
Включить сохраняемость статистики
|
false
|
Если включено, то при перезапуске сервера вся статистика времени выполнения сохраняется. Данные сохраняются после перезапусков платформы.
|
Сервисы UtilizationStatistics
|
Сервис
|
Описание
|
||
|---|---|---|---|
|
GetAuthenticationStatistics
|
Возвращает данные по числу выполнявшихся аутентификаций для любого заданного типа аутентификации и результату их завершения - успешно или неуспешно. Типы аутентификации содержат следующие аутентификаторы: форма для входа в систему, базовый аутентификатор HTTP, ключ приложения, SSO и пользовательские аутентификаторы.
|
||
|
GetEntityServiceStatistics
|
Возвращает для каждой сущности минимальное, максимальное, среднее и общее число выполнений сервисов.
|
||
|
GetEntityStatistics
|
Возвращает комбинацию статистических данных в сервисах GetEntityServiceStatistics и GetEntitySubscriptionStatistics.
|
||
|
GetEntitySubscriptionStatistics
|
Возвращает статистику по времени (минимальное, максимальное, среднее и общее время) выполнения подписок на события для сущностей.
|
||
|
GetPropertyVTQCount
|
Возвращает число свойств, указанных в критериях запроса. Дополнительные сведения см. в разделе Использование сервиса GetPropertyVTQCount.
|
||
|
GetQueryStatistics
|
Возвращает статистику запроса. Дополнительные сведения см. в разделе Статистика запросов.
|
||
|
GetStatistics
|
Возвращает всю статистику в сервисах GetEntityServiceStatistics, GetEntitySubscriptionStatistics и GetAuthenticationStatistics. Включает минимальное время, максимальное время, среднее время и подсчет выполнений для каждого выполненного сервиса.
|
||
|
ResetAuthenticationStatistics
|
Сбрасывает статистику аутентификации.
|
||
|
ResetEntityServiceStatistics
|
Сбрасывает статистику сервиса для сущности.
|
||
|
ResetEntityStatistics
|
Сбрасывает статистику сущности.
|
||
|
ResetQueryStatistics
|
Сбрасывает статистику запроса. Дополнительные сведения см. в разделе Статистика запросов.
|
||
|
ResetStatistics
|
Сбрасывает всю статистику.
|
||
|
ResetEntitySubscriptionStatistics
|
Сбрасывает статистику подписки для сущности.
|
||
|
WriteAuthenticationStatisticsReport
|
Записывает файл CSV с уникальным наименованием в следующее расположение: ThingworxStorage/reports/UtilizationStatistics
|
||
|
WriteEntityServiceStatisticsReport
|
Записывает файл CSV с уникальным наименованием в следующее расположение: ThingworxStorage/reports/UtilizationStatistics
|
||
|
WriteEntityStatisticsReport
|
Записывает файл CSV с уникальным наименованием в следующее расположение: ThingworxStorage/reports/UtilizationStatistics
|
||
|
WriteEntitySubscriptionStatisticsReport
|
Записывает файл CSV с уникальным наименованием в следующее расположение: ThingworxStorage/reports/UtilizationStatistics
|
||
|
WriteQueryStatisticsReport
|
Записывает статистику запроса. Дополнительные сведения см. в разделе Статистика запросов.
|
||
|
WriteStatisticsReport
|
Записывает файл CSV с уникальным наименованием в следующее расположение: ThingworxStorage/reports/UtilizationStatistics
|
Шаблон именования для статистики
Шаблон именования имеет следующую структуру:
• Вся статистика собирается с префиксом twx.stats.
• Статистика аутентификации собирается в папке twx.stats.authentication.
• Статистика сущности собирается в папке twx.stats.entity.
• Статистика сервисов сущности собирается в папке twx.stats.entity.<наименование_сущности>.services.<наименование_сервиса>.
• Статистика подписок сущностей собирается под следующими именами: twx.stats.entity.<наименование_сущности>.subscriptions.<наименование_подписки>.
• Статистические данные запроса собираются в twx.stats.query.
Типы данных параметра "именование" для сервисов включают в себя следующие.
• Префиксы - добавляются в начало наименования сервиса, для которого нужно получить возвращенную статистику. Например, чтобы просмотреть статистику только для аутентификации, укажите префикс twx.stats.authentication для сервиса GetStatistics или используйте сервис с удобным наименованием GetAuthententicationStatistics без параметров.
• Регулярные выражения - могут использоваться для наименований сущностей и сервисов. Может потребоваться просмотреть все сущности, соответствующие шаблону регулярного выражения, если опция агрегации выключена. Можно также использовать регулярное выражение для отображения ряда сервисов, которые начинаются со слова Get. Используемый шаблон регулярного выражения должен соответствовать шаблону Java Regex, описанному в следующем документе: https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.
Статистика выполнения сценария, прерванного из-за времени ожидания
Платформа ThingWorx прекращает выполнение длинных сценариев и записывает действие в журнал платформы. ThingWorx Platform также собирает статистику при завершении любого сценария из-за превышения времени ожидания. Статистика записывается, когда время выполнения превышает настроенное значение времени ожидания сценария. Платформа собирает статистику для сервисов и подписок, написанных на JavaScript.
|
|
По умолчанию в платформе ThingWorx задана настройка тайм-аута сценария 30 секунд. Если сценарий выполняется дольше, платформа прерывает его выполнение. Администратор ThingWorx может настраивать тайм-аут сценария в разделе Basic Settings файла конфигурации platform-settings.json. См. также Сведения о конфигурации platform-settings.json.
|
Статистика включается в результаты для следующих сервисов подсистемы использования:
• GetStatistics
• GetEntityStatistics
• GetEntityServiceStatistics
• GetEntitySubscriptionStatistics
• WriteStatisticsReport
• WriteEntityStatisticsReport
• WriteEntityServiceStatisticsReport
• WriteEntitySubscriptionStatisticsReport
Статистика времени ожидания доступна для сервисов с использованием следующего шаблона именования:
twx.stats.entity.<entity-name>.services.<service-name>.timedout
Аналогично можно получить статистику времени ожидания для подписок, используя следующий шаблон именования:
twx.stats.entity.<entity-name>.subscriptions.<subscription-name>.timedout
Эти статистические данные для timedout отслеживают статистику возникновения и временной длительности, когда истекает время ожидания указанных сценариев.