Sous-système d'utilisation
Les services du sous-système d'utilisation fournissent des statistiques d'exécution. Les informations suivantes peuvent être obtenues en utilisant les services de ce sous-système :
• Le temps nécessaire à l'exécution d'un service (temps minimum, maximum et moyen)
• Le nombre d'exécutions d'un service
• Les services et abonnements JavaScript qui se sont terminés en raison d'un délai d'expiration. Consultez la section
Statistiques relatives à l'exécution de scripts terminée en raison d'un délai d'expiration ci-dessous.
Les statistiques sont enregistrées (en millisecondes) à partir de l'heure à laquelle le serveur a été redémarré pour la dernière fois. Elles peuvent cependant être conservées en activant l'option Activer la persistance des statistiques. A l'aide du service WriteStatisticsReport, un fichier CSV contenant ces statistiques peut être créé dans le dossier ThingworxStorage.
 |
Les statistiques ne sont fournies que pour les services dont l'exécution est terminée. Si l'exécution n'est pas arrivée à son terme, le service ne sera pas inclus dans les statistiques.
|
|
Paramètre
|
Par défaut
|
Description
|
||
|---|---|---|---|---|
|
Activer les statistiques
|
false
|
Lorsque ce paramètre est activé, la plateforme collecte des statistiques. S'il est désactivé, aucune statistique liée aux services n'est consignée.
|
||
|
Activer l'agrégation du nom d'entité
|
true
|
Si plusieurs entités utilisent le même service, les statistiques agrégées des services sont affichées.
|
||
|
Afficher les centiles
|
false
|
Affiche des statistiques supplémentaires pour les centiles dans la table de configuration.
|
||
|
Activer la persistance des statistiques
|
false
|
Lorsque ce paramètre est activé et le serveur redémarré, toutes les statistiques d'exécution sont conservées. Les données sont conservées après le redémarrage de la plateforme.
|
Services UtilizationStatistics
|
Service
|
Description
|
||
|---|---|---|---|
|
GetAuthenticationStatistics
|
Renvoie des données concernant le nombre d'authentifications pour un type d'authentification donné ainsi que leur résultat (réussite ou échec). Les types d'authentification incluent le formulaire de connexion, l'authentification HTTP de base, la clé d'application, l'authentification unique et les authentificateurs personnalisés.
|
||
|
GetEntityServiceStatistics
|
Renvoie le nombre minimum, maximum et moyen d'exécutions de services pour chaque entité.
|
||
|
GetEntityStatistics
|
Renvoie un ensemble de statistiques des services GetEntityServiceStatistics et GetEntitySubscriptionStatistics.
|
||
|
GetEntitySubscriptionStatistics
|
Renvoie les statistiques de temps (minimum, maximum, moyen et total) d'exécution des abonnements sur des événements pour les entités.
|
||
|
GetStatistics
|
Renvoie toutes les statistiques des services GetEntityServiceStatistics, GetEntitySubscriptionStatistics et GetAuthenticationStatistics. Inclut le temps minimum, maximum et moyen, ainsi que le nombre pour chaque service exécuté.
|
||
|
ResetAuthenticationStatistics
|
Réinitialise les statistiques d'authentification.
|
||
|
ResetEntityServiceStatistics
|
Réinitialise les statistiques des services d'entité.
|
||
|
ResetEntityStatistics
|
Réinitialise les statistiques des entités.
|
||
|
ResetStatistics
|
Réinitialise toutes les statistiques.
|
||
|
ResetEntitySubscriptionStatistics
|
Réinitialise les statistiques d'abonnement pour une entité.
|
||
|
WriteAuthenticationStatisticsReport
|
Génère un fichier CSV unique à l'emplacement suivant : ThingworxStorage/reports/UtilizationStatistics
|
||
|
WriteEntityServiceStatisticsReport
|
Génère un fichier CSV unique à l'emplacement suivant : ThingworxStorage/reports/UtilizationStatistics
|
||
|
WriteEntityStatisticsReport
|
Génère un fichier CSV unique à l'emplacement suivant : ThingworxStorage/reports/UtilizationStatistics
|
||
|
WriteEntitySubscriptionStatisticsReport
|
Génère un fichier CSV unique à l'emplacement suivant : ThingworxStorage/reports/UtilizationStatistics
|
||
|
WriteStatisticsReport
|
Génère un fichier CSV unique à l'emplacement suivant : ThingworxStorage/reports/UtilizationStatistics
|
Modèle de désignation des statistiques
Le modèle de désignation est le suivant :
• Toutes les statistiques sont collectées sous le préfixe twx.stats.
• Les statistiques d'authentification sont collectées sous le préfixe twx.stats.authentication.
• Les statistiques d'entité sont collectées sous le préfixe twx.stats.entity.
• Les statistiques des services d'entité sont collectées sous le préfixe twx.stats.entity.<nom de l'entité>.services.<nom du service>.
• Les statistiques des abonnements d'entité sont collectées sous le préfixe twx.stats.entity.<nom de l'entité>.subscriptions.<source de l'événement d'abonnement>.<type d'abonnement>.<nom de la propriété>.
Les types de données des paramètres de désignation des services incluent les éléments suivants :
• Préfixes : ajoutez un préfixe au début du service pour lequel vous souhaitez obtenir des statistiques. Par exemple, pour afficher uniquement les statistiques d'authentification, indiquez le préfixe twx.stats.authentication au service GetStatistics ou utilisez le service simplifié GetAuthententicationStatistics sans paramètres.
• Expressions régulières : utilisables pour les services et les noms d'entité. Vous pouvez choisir d'afficher toutes les entités qui respectent le modèle d'expression régulière si l'option d'agrégation est désactivée. Vous pouvez également utiliser une expression régulière afin d'afficher certains services qui commencent par le mot Get. Le modèle d'expression régulière utilisé respecte le modèle Java, décrit à l'adresse
https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.
Statistiques relatives à l'exécution de scripts terminée en raison d'un délai d'expiration
ThingWorx Platform arrête les scripts longs et consigne l'action dans le journal de la plateforme. A compter de la version 8.5.0, ThingWorx Platform collecte également des statistiques sur l'arrêt de scripts provoqué par un délai d'expiration. Les statistiques sont enregistrées lorsque le temps d'exécution dépasse le délai d'expiration défini pour le script. La plateforme collecte les statistiques relatives aux services et aux abonnements écrits dans JavaScript.
|
|
Par défaut, le délai d'expiration d'un script sur la plateforme ThingWorx est de 30 secondes. Dès lors qu'un script s'exécute plus longtemps que cela, la plateforme met fin à l'exécution. Un administrateur ThingWorx peut configurer le délai d'expiration des scripts dans la section des paramètres de base du fichier de configuration platform-settings.json. Consultez également la section
Détails de la configuration du fichier platform-settings.json.
|
Les statistiques sont incluses dans les résultats à partir des services suivants du sous-système d'utilisation :
• GetStatistics
• GetEntityStatistics
• GetEntityServiceStatistics
• GetEntitySubscriptionStatistics
• WriteStatisticsReport
• WriteEntityStatisticsReport
• WriteEntityServiceStatisticsReport
• WriteEntitySubscriptionStatisticsReport
Les statistiques d'expiration des services sont indiquées selon le modèle de dénomination suivant :
twx.stats.entity.<entity-name>.services.<service-name>.timedout
De la même façon, les statistiques d'expiration des abonnements sont indiquées selon le modèle de dénomination suivant :
twx.stats.entity.<entity-name>.subscriptions.<subscription-name>.timedout
Grâce à ces statistiques timedout, il est possible de suivre le nombre de fois qu'un script a expiré ainsi que sa durée d'exécution.