Mesures du sous-système de gestion des transferts de fichiers
Les mesures de surveillance des transferts de fichiers sont mises à jour comme décrit ci-dessous. Les mesures suivantes se trouvent dans le sous-système de gestion des transferts de fichiers sous le point de terminaison /Metrics. Elles sont disponibles après le démarrage d'un transfert de fichiers.
Les anciennes mesures ne possédaient pas d'étiquettes, ce qui signifie que plusieurs mesures étaient nécessaires pour connaître le statut et les détails. Les nouvelles mesures présentent des configurations d'étiquette que vous pouvez définir en fonction de vos besoins pour obtenir tous les détails des opérations au moyen d'une seule et unique mesure. Chaque mesure possède des étiquettes configurables, qui catégorisent les opérations en fonction de leurs propriétés. Par exemple : référentiel cible, référentiel source et état. Les étiquettes suivantes sont disponibles pour tous les points de terminaison.
• LABEL_KEY : définit la catégorie. Exemple : target, source, state.
• LABEL_DESCRIPTION : décrit la finalité de l'étiquette.
• LABEL_VALUE_TYPE : définit le type de valeur autorisée. Par exemple, string.
• LABEL_VALUES : spécifie les valeurs valides de l'étiquette.
• CATCH-ALL : définit les valeurs de secours pour les entrées non reconnues.
|
Anciennes mesures
|
Nouvelles mesures
|
Description
|
|---|---|---|
|
• uploadFailedTransfers
• uploadStartedTransfers
• uploadCompletedTransfers
• uploadCancelledTransfers
|
thingworx_file_transfer_upload_total
|
Cette mesure capture les opérations de chargement de fichier.
Au moment de la définition, les filtres d'inclusion seront définis sur Target et State.
|
|
• downloadCompletedTransfers
• downloadCancelledTransfers
• downloadFailedTransfers
• downloadStartedTransfers
|
thingworx_file_transfer_download_total
|
Cette mesure capture les opérations de téléchargement de fichiers.
Au moment de la définition, les filtres d'inclusion seront définis sur Source et State.
|
|
• acrossRepoStartedTransfers
• acrossRepoCancelledTransfers
• acrossRepoFailedTransfers
• acrossRepoCompletedTransfers
|
thingworx_file_transfer_acrossrepo_total
|
Cette mesure capture les transferts de fichiers entre référentiels.
Au moment de la définition, les filtres d'inclusion seront définis sur Source, Target et State.
|
|
Aucune
|
thingworx_file_transfer_acrossedge_total
|
Cette mesure capture les transferts de fichiers entre périphériques Edge.
Au moment de la définition, le filtre d'inclusion sera défini sur State.
|
Pour configurer les étiquettes, utilisez le service ConfigureMetricsAttributeFiltering dans le sous-système de plateforme.
Par exemple, lors du chargement, metricName doit être thingworx_file_transfer_upload et metricAttributesValueBasedFilterConfig. Le JSON peut se présenter sous la forme suivante :
{
"labelConfig": [
{
"LABEL_NAME": "target",
"ALLOWED_VALUES": [
"SystemRepository",
"SupportRepository"
],
"DEFAULT_VALUE": "otherrepository"
}
]
}
Ici, si les fichiers sont transférés depuis des référentiels autres que ceux de ALLOWED_VALUES, la valeur de la cible sera otherrepository. Le même comportement peut être observé pour les opérations Télécharger et Copier avec leurs étiquettes. Plusieurs configurations d'étiquette peuvent être ajoutées à dans labelConfig, séparées par une virgule (,).
Désactivation des anciennes mesures
Sur une nouvelle installation de ThingWorx Platform 9.7.x, seules les nouvelles mesures sont disponibles. A la suite d'une mise à niveau de ThingWorx Platform 9.6.x vers ThingWorx Platform 9.7.x, les anciennes mesures resterons disponibles. Après une mise à niveau, PTC recommande vivement d'utiliser les nouvelles mesures.
Pour une nouvelle installation
Lors de l'utilisation du programme d'installation, les anciennes mesures de transfert de fichiers ne sont pas disponibles au niveau du point de terminaison /Metrics et /GetPerformanceMetrics. Seules les nouvelles mesures de transfert de fichiers sont disponibles.
Pour la mise à niveau
Lors de l'utilisation du programme d'installation, les anciennes et nouvelles mesures de transfert de fichiers sont disponibles.
 |
Au moment de la mise à niveau, vous pouvez désactiver les anciennes mesures en modifiant la liste des mesures désactivées. Utilisez DisabledMetricsList dans le fichier platform-settings.json pour désactiver les mesures. Pour plus d'informations, consultez la rubrique Option de désactivation des mesures et Détails de la configuration du fichier platform-settings.json.
|
Migration
Après la migration, les anciennes mesures de transfert de fichiers ne sont plus disponibles. Seules les nouvelles mesures de transfert de fichiers sont disponibles.
Métriques d'histogramme
Les mesures d'histogramme suivantes peuvent être utilisées pour connaître la taille et la durée des transferts de fichiers.
Ces mesures ne sont disponibles dans le sous-système de gestion des transferts de fichiers sous le point de terminaison /Metrics qu'après la fin de l'opération de transfert de fichiers.
|
Mesure
|
Description
|
|---|---|
|
thingworx_file_transfer_size_bytes
|
Cette mesure indique la taille totale du fichier transféré.
Elle porte l'étiquette operation. Les valeurs peuvent être UPLOAD, DOWNLOAD, ACROSSREPO ou ACROSSEDGE selon le type d'opération effectuée.
Cette mesure présente l'ensemble de compartiments par défaut suivants : < 1 Ko, 10 Ko, 100 Ko, 1 Mo, 10 Mo, 100 Mo, 1 G, > 1 Go
|
|
thingworx_file_transfer_duration_ms
|
Cette mesure indique la durée du transfert du fichier.
Elle porte l'étiquette operation. Les valeurs peuvent être UPLOAD, DOWNLOAD, ACROSSREPO ou ACROSSEDGE selon le type d'opération effectuée.
Cette mesure présente l'ensemble de compartiments par défaut suivant : 100 ms, 1 s, 10 s, 100 s, 1 000 s, > 1 000 s.
|
Les compartiments d'histogramme sont incrémentiels de la manière suivante :
• Pour l'histogramme du temps de transfert de fichiers : si le transfert prend plus de 100 ms et est inférieur ou égal à 1 s, il sera inclus dans le compartiment 1 s et les autres compartiments correspondants.
• Pour l'histogramme de taille de transfert de fichiers : si la taille du fichier transféré est supérieure à 1 Ko et inférieure ou égale à 10 Ko, le transfert sera inclus dans le compartiment 10 Ko et les autres compartiments correspondants.
Pour modifier les tailles de compartiment par défaut, par exemple pour personnaliser thingworx_file_transfer_duration_ms avec les valeurs [200 ,2000, 20000, 200000] et thingworx_file_transfer_size_bytes avec les valeurs [2048, 20480, 204800, 2097152, 20971520], mettez à jour les éléments suivants :
Pour un environnement sur site
Mettez à jour le fichier platform-settings.json comme suit.
"PlatformSettingsConfig"
{
"MetricsSettings":
{
"HistogramMetricsBucketSizeList":
{
"thingworx_file_transfer_duration_ms":[200 ,2000, 20000, 200000],
"thingworx_file_transfer_size_bytes ":[2048, 20480, 204800, 2097152, 20971520]
}
}
}
Pour Docker
Mettez à jour les fichiers suivants.
◦ Dans le fichier .env, ajoutez les éléments suivants, s'ils ne sont pas disponibles.
HISTOGRAM_BUCKET_SIZE_LIST: '
{
"thingworx_file_transfer_duration_ms":[200,2000,20000,200000],
"thingworx_file_transfer_size_bytes ":[2048,20480, 204800,2097152,20971520]
}'
◦ Dans le fichier docker-compose, ajoutez les éléments suivants, s'ils ne sont pas disponibles.
HISTOGRAM_BUCKET_SIZE_LIST: ${HISTOGRAM_BUCKET_SIZE_LIST}