Métricas del subsistema de transferencia de ficheros
Las métricas de supervisión de la transferencia de ficheros se actualizan tal y como se describe a continuación. Las siguientes métricas se encuentran en el subsistema de transferencia de ficheros en el extremo /Metrics y están disponibles después de iniciar la transferencia de ficheros.
Las métricas más antiguas no tenían rótulos, por lo que, a su vez, se necesitaban múltiples métricas para conocer el estado y los detalles. Las nuevas métricas tienen configuraciones de rótulo que los usuarios pueden configurar según sea necesario y todos los detalles se pueden obtener de la operación mediante una métrica. Cada métrica tiene rótulos configurables, que categorizan las operaciones en función de sus propiedades. Por ejemplo: almacén de destino, almacén de origen y estado. Los siguientes rótulos están disponibles para todos los extremos.
• LABEL_KEY: permite definir la categoría. Por ejemplo, target, source, state.
• LABEL_DESCRIPTION: permite describir el propósito del rótulo.
• LABEL_VALUE_TYPE: permite definir el tipo de valor permitido. Por ejemplo, string.
• LABEL_VALUES: permite especificar los valores válidos para el rótulo.
• CATCH-ALL : permite proporcionar los valores de reserva para las entradas no reconocidas.
|
Métricas antiguas
|
Nuevas métricas
|
Descripción
|
|---|---|---|
|
• uploadFailedTransfers
• uploadStartedTransfers
• uploadCompletedTransfers
• uploadCancelledTransfers
|
thingworx_file_transfer_upload_total
|
Con esta métrica se capturan las operaciones de carga de ficheros.
En el momento de la definición, los filtros incluidos serán Target y State.
|
|
• downloadCompletedTransfers
• downloadCancelledTransfers
• downloadFailedTransfers
• downloadStartedTransfers
|
thingworx_file_transfer_download_total
|
Con esta métrica se capturan las operaciones de descarga de ficheros.
En el momento de la definición, los filtros incluidos serán Source y State.
|
|
• acrossRepoStartedTransfers
• acrossRepoCancelledTransfers
• acrossRepoFailedTransfers
• acrossRepoCompletedTransfers
|
thingworx_file_transfer_acrossrepo_total
|
Con esta métrica se captura la transferencia de ficheros entre repositorios.
En el momento de la definición, los filtros incluidos serán Source, Target y State.
|
Para configurar los rótulos, utilice el servicio ConfigureMetricsAttributeFiltering en el subsistema de plataforma.
Por ejemplo, al cargar, metricName debe ser thingworx_file_transfer_upload y metricAttributesValueBasedFilterConfig. El JSON puede ser el siguiente:
{
"labelConfig": [
{
"LABEL_NAME": "target",
"ALLOWED_VALUES": [
"SystemRepository",
"SupportRepository"
],
"DEFAULT_VALUE": "otherrepository"
}
]
}
"labelConfig": [
{
"LABEL_NAME": "target",
"ALLOWED_VALUES": [
"SystemRepository",
"SupportRepository"
],
"DEFAULT_VALUE": "otherrepository"
}
]
}
Aquí, si los ficheros se transfieren desde repositorios distintos de los repositorios de ALLOWED_VALUES, el destino tendrá otherrepository como valor. El mismo comportamiento se puede observar para la operación Descargar y copiar con sus rótulos. Se pueden añadir varias configuraciones de rótulo dentro de labelConfig, separadas por comas (,).
Desactivación de métricas antiguas
Para la nueva instalación de ThingWorx Platform 9.7.x, solo están disponibles las nuevas métricas. Para los usuarios que actualizan ThingWorx Platform 9.6.x a ThingWorx Platform 9.7.x, las métricas anteriores estarán disponibles. PTC recomienda encarecidamente que los usuarios actualizados utilicen las nuevas métricas.
Para una instalación nueva
Al utilizar el instalador, las métricas antiguas de transferencia de ficheros no están disponibles en el extremo /Metrics ni en el extremo /GetPerformanceMetrics. Solo están disponibles las nuevas métricas de transferencia de ficheros.
Para una actualización
Al utilizar el instalador, están disponibles las métricas de transferencia de ficheros antiguas y nuevas.
 |
En el momento de la actualización, se pueden desactivar las métricas antiguas cambiando la lista de métricas de desactivación. Utilice DisabledMetricsList en el fichero platform-settings.json para desactivar las métricas. Para obtener más información, consulte Opción para desactivar métricas y Detalles de configuración de platform-settings.json.
|
Migración
Después de la migración, las métricas antiguas de transferencia de ficheros no están disponibles. Solo están disponibles las nuevas métricas de transferencia de ficheros.
Métricas de histograma
Las siguientes métricas de histograma se pueden utilizar para conocer el tamaño y la duración de la transferencia de ficheros.
Estas métricas están disponibles en el subsistema de transferencia de ficheros en el extremo /Metrics solo después de que se complete la operación de transferencia de ficheros.
|
Métrica
|
Descripción
|
|---|---|
|
thingworx_file_transfer_size_bytes
|
Con esta métrica se mostrará el tamaño total del fichero que se está transfiriendo.
Esta métrica tiene el rótulo operation. Los valores pueden ser UPLOAD, DOWNLOAD y ACROSSREPO en función del tipo de operación realizada.
Esta métrica tiene el conjunto por defecto de buckets: <1 KB, 10 KB, 100 KB, 1 M, 10 M, 100 M, 1 G, >1G
|
|
thingworx_file_transfer_duration_ms
|
Esta métrica mostrará la duración del archivo que se está transfiriendo.
Esta métrica tiene el rótulo operation. Los valores pueden ser UPLOAD, DOWNLOAD y ACROSSREPO en función del tipo de operación realizada.
Esta métrica tiene el conjunto por defecto de buckets: 100 ms, 1 s, 10 s, 100 s, 1000 s, >1000 s
|
Los buckets de histogramas son incrementales de la siguiente manera:
• Para el histograma de tiempo de transferencia de ficheros: si la transferencia tarda más de 100 ms y es menor o igual a 1 s, se incluirá en el bucket de 1 s y otros buckets correspondientes.
• Para el histograma de tamaño de transferencia de ficheros: si la transferencia tiene un tamaño de archivo de más de 1 KB y menor o igual que 10 KB, se incluirá en un bucket de 10 KB y todos los demás buckets correspondientes.
Para cambiar los tamaños por defecto de los buckets, por ejemplo, para personalizar thingworx_file_transfer_duration_ms en [200 ,2000, 20000, 200000] y thingworx_file_transfer_size_bytes en [2048, 20480, 204800, 2097152, 20971520], actualice lo siguiente:
Para el entorno local
Actualice el fichero platform-settings.json tal como se indica a continuación.
"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]
}
}
}
Para Docker
Actualice los siguientes ficheros.
◦ En el fichero .env, añada lo siguiente, si no está disponible.
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]
}'
◦ En el fichero docker-compose, añada lo siguiente, si no está disponible.
HISTOGRAM_BUCKET_SIZE_LIST: ${HISTOGRAM_BUCKET_SIZE_LIST}