Параметры подсистемы передачи файлов
Параметры мониторинга передачи файлов обновляются, как описано ниже. Следующие параметры находятся в подсистеме передачи файлов в конечной точке /Metrics и доступны после запуска передачи файлов.
У старых параметров не было меток, а для получения статуса и сведений требовалось несколько параметров. Для новых параметров существуют конфигурации меток, которые пользователи могут настраивать по мере необходимости и получать все сведения об операции с помощью одного параметра. Каждый параметр имеет настраиваемые метки, которые классифицируют операции на основе их свойств. Например: целевой репозиторий, исходный репозиторий и состояние. Следующие метки доступны для всех конечных точек.
• LABEL_KEY - определяет категорию. Например, target, source, state.
• LABEL_DESCRIPTION - описывает предназначение метки.
• LABEL_VALUE_TYPE - определяет тип допустимого значения. Например, string.
• LABEL_VALUES - указывает допустимые значения для метки.
• CATCH-ALL - указывает резервные значения для нераспознанных входных данных.
|
Старый параметр
|
Новый параметр
|
Описание
|
|---|---|---|
|
• uploadFailedTransfers
• uploadStartedTransfers
• uploadCompletedTransfers
• uploadCancelledTransfers
|
thingworx_file_transfer_upload_total
|
Этот параметр захватывает операции выгрузки файлов.
Во время процесса определения включенными фильтрами будут "Цель" и "Состояние".
|
|
• downloadCompletedTransfers
• downloadCancelledTransfers
• downloadFailedTransfers
• downloadStartedTransfers
|
thingworx_file_transfer_download_total
|
Этот параметр захватывает операции загрузки файла.
Во время процесса определения включенными фильтрами будут "Источник" и "Состояние".
|
|
• acrossRepoStartedTransfers
• acrossRepoCancelledTransfers
• acrossRepoFailedTransfers
• acrossRepoCompletedTransfers
|
thingworx_file_transfer_acrossrepo_total
|
Этот параметр фиксирует передачу файлов между репозиториями.
Во время процесса определения включенными фильтрами будут "Источник", "Цель" и "Состояние".
|
Чтобы сконфигурировать метки, используйте сервис ConfigureMetricsAttributeFiltering в подсистеме платформы.
Например, при выгрузке параметр metricName должен иметь значение thingworx_file_transfer_upload и metricAttributesValueBasedFilterConfig. JSON может иметь следующий вид:
{
"labelConfig": [
{
"LABEL_NAME": "target",
"ALLOWED_VALUES": [
"SystemRepository",
"SupportRepository"
],
"DEFAULT_VALUE": "otherrepository"
}
]
}
"labelConfig": [
{
"LABEL_NAME": "target",
"ALLOWED_VALUES": [
"SystemRepository",
"SupportRepository"
],
"DEFAULT_VALUE": "otherrepository"
}
]
}
Если файлы переносятся из репозиториев, отличных от репозиториев в ALLOWED_VALUES, цель будет иметь значение otherrepository. То же самое поведение можно наблюдать для операций "Загрузить" и "Копировать" с соответствующими метками. Внутри labelConfig можно добавить несколько конфигураций меток, разделенных запятой (,).
Отключение старых параметров
Для новой установки ThingWorx Platform 9.7.x доступны только новые параметры. Пользователям, обновляющим ThingWorx Platform 9.6.x до ThingWorx Platform 9.7.x, будут доступны более старые параметры. PTC настоятельно рекомендует обновленным пользователям использовать новые параметры.
Для новой установки
При использовании установщика старые параметры передачи файлов недоступны в /Metrics и в конечной точке /GetPerformanceMetrics. Доступны только новые параметры передачи файлов.
Для обновления
При использовании установщика доступны старые и новые параметры передачи файлов.
 |
Во время обновления можно отключить старые параметры, изменив список отключенных параметров. Используйте список DisabledMetricsList в файле platform-settings.json, чтобы отключить параметры. Дополнительные сведения см. в разделах Опция отключения параметров и Сведения о конфигурации platform-settings.json.
|
Перенос
После переноса старые параметры передачи файлов будут недоступны. Доступны только новые параметры передачи файлов.
Параметры гистограммы
Следующие параметры гистограммы могут использоваться для определения размера и длительности передачи файлов.
Эти параметры доступны в подсистеме передачи файлов в конечной точке /Metrics только после завершения операции передачи файлов.
|
Параметр
|
Описание
|
|---|---|
|
thingworx_file_transfer_size_bytes
|
Этот параметр показывает общий размер для операции передачи файлов.
Этот параметр имеет метку operation. Доступными значениями могут быть UPLOAD, DOWNLOAD и ACROSSREPO, в зависимости от типа выполняемой операции.
Этот параметр имеет набор контейнеров по умолчанию: <1KB, 10KB, 100KB, 1M, 10M, 100M, 1G, >1G
|
|
thingworx_file_transfer_duration_ms
|
Этот параметр показывает длительность передачи файла.
Этот параметр имеет метку operation. Доступными значениями могут быть UPLOAD, DOWNLOAD и ACROSSREPO, в зависимости от типа выполняемой операции.
Этот параметр имеет набор контейнеров по умолчанию: 100ms, 1s, 10s, 100s, 1000s, >1000s
|
Контейнеры гистограмм являются инкрементными со следующими значениями.
• Для гистограммы времени передачи файлов - если время передачи превышает 100 мс, но меньше или равно 1 секунде, эта передача попадет в контейнер 1s. То же самое верно и для других контейнеров.
• Для гистограммы размера передачи файлов: если размер файла передачи превышает 1 КБ, но меньше или равен 10 КБ, то он попадет в контейнер 10KB. То же самое для других контейнеров.
Чтобы изменить размеры контейнеров по умолчанию, например настроить thingworx_file_transfer_duration_ms на [200 ,2000, 20000, 200000], а thingworx_file_transfer_size_bytes на [2048, 20480, 204800, 2097152, 20971520], обновите следующее:
Для локального развертывания
Обновите файл platform-settings.json следующим образом.
"PlatformSettingsConfig"
{
"MetricsSettings":
{
"HistogramMetricsBucketSizeList":
{
"thingworx_file_transfer_duration_ms":[200 ,2000, 20000, 200000],
"thingworx_file_transfer_size_bytes ":[2048, 20480, 204800, 2097152, 20971520]
}
}
}
{
"MetricsSettings":
{
"HistogramMetricsBucketSizeList":
{
"thingworx_file_transfer_duration_ms":[200 ,2000, 20000, 200000],
"thingworx_file_transfer_size_bytes ":[2048, 20480, 204800, 2097152, 20971520]
}
}
}
Для Docker.
Обновите следующие файлы.
◦ В файл .env добавьте следующее, если оно недоступно.
HISTOGRAM_BUCKET_SIZE_LIST: '
{
"thingworx_file_transfer_duration_ms":[200,2000,20000,200000],
"thingworx_file_transfer_size_bytes ":[2048,20480, 204800,2097152,20971520]
}'
{
"thingworx_file_transfer_duration_ms":[200,2000,20000,200000],
"thingworx_file_transfer_size_bytes ":[2048,20480, 204800,2097152,20971520]
}'
◦ В файл docker-compose добавьте следующее, если оно недоступно.
HISTOGRAM_BUCKET_SIZE_LIST: ${HISTOGRAM_BUCKET_SIZE_LIST}