Tous les autres noms de produits ou appellations sont des marques déposées ou des noms commerciaux appartenant à leurs propriétaires respectifs.

Transcription

1 4D Debug log analyzer Par Josh FLETCHER, Ingénieur support technique, 4D Inc. Note technique 4D FR Version 1 - Date 1 mars 2010 Résumé Cette note technique LogAnalyser et sa base fournissent un outil efficace d'analyse du fichier de Log de 4D. Ce document met en avant l'analyse statistique des méthodes-projet, des méthodes-formulaire et des méthodes-objet. Une base exemple et un fichier de Log accompagnent notre explication 4D Notes techniques Copyright D SAS - Tous droits réservés Tous les efforts ont été faits pour que le contenu de cette note technique présente le maximum de fiabilité possible. Néanmoins, les différents éléments composant cette note technique, et le cas échéant, le code, sont fournis sans garantie d'aucune sorte. L'auteur et 4D S.A. déclinent donc toute responsabilité quant à l'utilisation qui pourrait être faite de ces éléments, tant à l'égard de leurs utilisateurs que des tiers. Les informations contenues dans ce document peuvent faire l'objet de modifications sans préavis et ne sauraient en aucune manière engager 4D SA. La fourniture du logiciel décrit dans ce document est régie par un octroi de licence dont les termes sont précisés par ailleurs dans la licence électronique figurant sur le support du Logiciel et de la Documentation afférente. Le logiciel et sa documentation ne peuvent être utilisés, copiés ou reproduits sur quelque support que ce soit et de quelque manière que ce soit, que conformément aux termes de cette licence. Aucune partie de ce document ne peut être reproduite ou recopiée de quelque manière que ce soit, électronique ou mécanique, y compris par photocopie, enregistrement, archivage ou tout autre procédé de stockage, de traitement et de récupération d'informations, pour d'autres buts que l'usage personnel de l'acheteur, et ce exclusivement aux conditions contractuelles, sans la permission explicite de 4D SA. 4D, 4D Calc, 4D Draw, 4D Write, 4D Insider, 4ème Dimension, 4D Server, 4D Compiler ainsi que les logos 4e Dimension, sont des marques enregistrées de 4D SA. Windows,Windows NT, Vista, Win 32s et Microsoft sont des marques enregistrées de Microsoft Corporation. Apple, Macintosh, Power Macintosh, LaserWriter, ImageWriter, QuickTime sont des marques enregistrées ou des noms commerciaux de Apple Computer,Inc. Mac2Win Software Copyright est un produit de Altura Software,Inc. 4D Write contient des éléments de "MacLink Plus file translation", un produit de DataViz, Inc,55 Corporate drive,trumbull,ct,usa. XTND Copyright D SA. Tous droits réservés. XTND Technology Copyright Claris Corporation.. Tous droits réservés ACROBAT Copyright , Secret Commercial Adobe Systems Inc.Tous droits réservés. ACROBAT est une marque enregistrée d'adobe Systems Inc. Tous les autres noms de produits ou appellations sont des marques déposées ou des noms commerciaux appartenant à leurs propriétaires respectifs. 1 / 7

2 4D Debug log analyzer Résumé Cette note technique LogAnalyser et sa base fournissent un outil efficace d'analyse du fichier de Log de 4D. Ce document met en avant l'analyse statistique des méthodes-projet, des méthodes-formulaire et des méthodes-objet. Une base exemple et un fichier de Log accompagnent notre explication. Introduction Cette base de données permet une analyse efficace du fichier de Log de 4D (4DDL pour 4D Debug Log). Pour plus d'information sur les caractéristiques du 4DDL rendez-vous à la commande FIXER PARAMETRE BASE (documentation en ligne). Voir aussi une ancienne note sur le sujet "The 4DDebugLog.txt file". (Ndt : note jointe sous le nom "AncienneNoteUS4DDebugLog"). 4DDL peut se révéler précieux pour déboguer un crash ou un blocage ; en effet toutes les dernières opérations avant l'incident sont consignées. Pourtant notre base de données n'a pas été créée pour répondre à ce contexte classique. Le 4DDL se montre également utile car il consigne : Les méthodes projet ; Les méthodes formulaire ; Les méthodes objet ; Les méthodes des plugins ; Les appels aux commandes 4D. De plus, concernant les méthodes projet, formulaire et objet, le début et la fin de chaque méthode sont consignés, ce qui rend possible de mesurer le temps d'exécution de ces commandes. La base de données Exemple a été conçue pour recueillir toutes ces informations de Log et produire un rapport statistique avec : Le nombre d'appels à chaque méthode ; Temps d'exécution moyen pour chaque méthode ; Le temps d'exécution le plus long pour chaque méthode. Tout ce travail pourrait être lu dans un tableur mais le volume de données contenu par 4DDL grossissant rapidement peut dépasser les limites d'une application comme Microsoft Excel 2003 qui ne prend pas en charge plus d'environ lignes par feuille. Pour information, le fichier 4DDL fourni avec cette note technique représente approximativement dix minutes de Log soit 1,6 million de lignes. C'est pourquoi intégrer ces résultats dans une base de données est plus facile à gérer. Utilisation Ouvrez la base avec 4D, qui passe par défaut en mode structure. En effet l'application reste un outil pour les développeurs et n'est pas destinée aux utilisateurs finaux. Si vous voulez explorer les tables vous le ferez en Mode Développement, en utilisant la liste des tables. 2 / 7

3 Attention : la base est conçue pour travailler des fichiers de Log générés par 4D en mode interprété. Les fichiers générés par des applications en mode compilé ne seront pas convenablement pris en charge. Il y a deux tâches de base à réaliser : Importer 4DDL ; Générer un résumé du fichier 4DDL importé. Import du fichier 4DDL L'opération consiste à importer le 4DDL et analyser les données du fichier. Chaque session 4DDL est sauvegardée dans la Table [Debug_Logs] qui a un lien 1 vers N avec la Table [Log_Lines]. Exécutez la méthode DBL_M_Import ou sélectionnez «Importer un fichier 4DDL» du menu Fichier si vous êtes en mode application. Là vous serez invité(e) à désigner le dossier contenant les fichiers des Logs. Note : Au moment de consigner dans le fichier, 4D v11 SQL segmente automatiquement son Log en fichiers de 10 mégaoctets ; la base de cette note technique se charge de tout importer automatiquement en respectant le bon ordre. L'application considère qu'un dossier correspond à une seule session de débogage. Si vous décidiez de mettre plusieurs sessions dans le même dossier, l'auteur de cette note technique ignore tout du comportement qu'adopterait l'application. Un marqueur en tête de chaque segment permet de contrôler la cohérence de tous les segments. En cas de désaccord la base s'en plaindra et vous laissera abandonner l'opération. Aprés sélection du dossier de Log vous pouvez voir la liste des segments : 3 / 7

4 Cet écran est seulement informatif et vous ne pouvez pas en modifier la liste. Remarquez qu'en bas de cet écran vous pouvez ajouter des notes relatives à la session d'import. Je recommande de mettre des indications qui permettront d'identifier la session 4DDL une fois l'import terminé. Quand vous vous sentez prêt(e), cliquez OK. PRENEZ GARDE : L'opération d'import peut être significativement longue ; une barre de progression vous donne une idée de la durée. Pour les données de l'exemple (une session qui a généré 1,6 million de lignes pour une session de 80 méga) l'import vous fera patienter plusieurs minutes. Chaque ligne sera importée brute et sauvegardée dans le champ [Log_Lines]Data. De plus, les données du fichier sont réparties (dénormalisées) dans les différents champs de cette même table. Voici ces champs : ID identifiant unique incrémenté pour chaque ligne de log ; DL_ID La clé étrangère pour faire référence à une session d'import ; Data la ligne importée, à l'état brut ; MS_Stamp Chaque ligne dans le 4DDL comporte un marqueur horaire (timestamp) qui est stocké ici ; PID Le numéro du process qui a appelé la commande ; UPID Le numéro universel du process qui a appelé la commande (Universal process ID). UPID est un numéro incrémenté à chaque fois que la base de données crée un nouveau process. Il permet de différencier plusieurs instances d'un même process ; Stack_Level 4DDL contient le niveau d'empilement de certaines commandes. L'information est stockée ici mais n'est pas encore utilisée ; 4 / 7

5 Command La commande qui a été exécutée ; Execution_Time Pour les commandes qui ont un début et une fin dans le fichier de log. Le temps d'exécution est calculé et enregistré ici ; IsStart Pour les commandes qui ont un début et une fin, le «début» est indiqué dans ce champ (pour le différencier de la «fin» et aussi des autres commandes qui n'ont pas de début et de fin) ; Cmd_Type Le Type de la commande exécutée : méthode-projet, méthode-formulaire, méthodeobjet, méthode de plugin ou une commande 4D. Le process d'import ayant terminé sa tâche, il calcule le temps d'exécution. Le travail est fait dès l'import car cela est plutôt lent. (Vous ne voudrez pas avoir à le faire plus d'une fois, par exemple à chaque fois que vous faites un rapport) Note : La précision de 4DDL est d'une milliseconde. Beaucoup de commandes exécutent le travail en moins d'une milliseconde et c'est pour cela que vous constaterez beaucoup de zéros dans la colonne Execution_time. Ne vous méprenez pas : 0 est une valeur de temps valide. Pour les commandes qui ne donnent pas de temps d'exécution, la valeur inscrite est -1. Générer un résumé du fichier 4DDL importé Ce travail génère un rapport pour une session 4DDL Exécutez la méthode DBL_M_LogSummary ou, en mode Menus créés, sélectionnez Fichier "debuglogg summary". Là vous serez invité à sélectionner un fichier 4DDL. C'est là que les Notes se révéleront bien pratiques car elles seront le seul moyen d'identification du fichier avec un ID, une date, une heure et l'horodatage en millisecondes. Le rapport révèle le Top 20 de ces données : Méthodes-projet par nombre d'utilisations Commandes 4D par nombre d'utilisations Méthodes plugin par nombre d'utilisations Méthodes-formulaire par nombre d'utilisations Méthodes-objet par nombre d'utilisations Méthodes-projet par temps moyen d'exécution Méthode-formulaire par temps moyen d'exécution Méthode-objet par temps moyen d'exécution Méthode-projet par le plus long temps d'exécution Méthode-formulaire par le plus long temps d'exécution Méthode-objet par le plus long temps d'exécution Note : S'il y a moins de 20 occurrences d'un type de méthode, la liste sera raccourcie (vous ne verrez pas une série de blancs). Si vous en voulez plus de 20, changez la limite dans la méthode DBL_P_LogSummary. Le total est passé en paramètre à chaque sous-routine. 5 / 7

6 Le fichier généré est un fichier texte dont les colonnes sont séparées par des tabulations. Vous pouvez l'ouvrir plus tard dans un tableur pour l'affiner. À la fin du rapport le dossier contenant le fichier est affiché. Les fichiers du rapport sont dans le dossier "Log" de la base de données. Ils sont nommés ainsi de façon unique : LogSummary_<4DDL record ID>_<date_US>_Heuree>.txt Par exemple LogSummary_47_ _16_12_56.txt API Il existe plusieurs commandes utiles pour générer différents rapports. Voici dans un premier temps les préfixes : DBL_ - Préfixe de toutes les méthodes spécifiques à cette application. DBL_D_ - le code qui affiche des dialogues DBL_DATA_ - code qui modifie les données. DBL_IMPORT_ - code en relation avec l'import du fichier de log DBL_M_ - méthodes liées aux menus DBL_P_ - méthodes process (vérifier traduction) DBL_RPT_ - code en relation avec la création de rapport IAS_ - Shell code générique du shell de l'application Les commandes utiles : DBL_DATA_DenormalizeData Vous pouvez appeler cette méthode quand bon vous semble pour re-dé-normaliser les données. Assurez-vous d'avoir une sélection dans la table [Log_Lines]! DBL_DATA_CalcExecTimes Cette méthode peut être appelée pour recalculer le temps d'exécution de toute méthode appropriée. DBL_M_Import A exécuter pour créer une session d'import. DBL_M_LogSummary Exécutez cette méthode pour générer un résumé de session 4DDL (comme décrit plus haut) DBL_RPT_GetAverageExecutions Exécutez cette commande pour générer un tableau des temps moyens d'exécution d'une commande dans une session 4DDL. DBL_RPT_GetCallCounts 6 / 7

7 Exécutez cette commande pour générer un tableau du nombre d'exécution de chaque commande dans une session 4DDL. DBL_RPT_GetWorstExecutions Exécutez cette commande pour générer un tableau des plus longs temps d'exécution de chaque commande d'une session 4DDL. DBL_P_LogSummary Modifiez cette méthode pour changer le sommaire du rapport. IAS_ Toute méthode avec ce préfixe est générique et peut être réutilisable dans toute autre base de données. Conclusion Cette Note technique détaille comment faire du fichier de log 4DDL un outil d'analyse que le développeur mettra à profit pour en tirer partie pour ses propres applications. 7 / 7