Rapports
Suite à l'analyse, le Upgrade Compatibility Tool peut exporter un rapport contenant une liste de problèmes pour chaque fichier spécifiant sa gravité, son code d'erreur et sa description de l'erreur. Le Upgrade Compatibility Tool exporte le rapport dans deux formats différents :
- Un fichier JSON.
- Un rapport d’HTML.
Consultez l’exemple d’interface de ligne de commande suivant d’un rapport :
File: /app/code/Custom/CatalogExtension/Controller/Index/Index.php
------------------------------------------------------------------
* [WARNING][1131] Line 10: Extending from class 'Magento\Framework\App\Action\Action' that is @deprecated on version '2.4.4'
* [ERROR][1328] Line 10: Implemented interface 'Magento\Framework\App\Action\HttpGetActionInterface' that is non API on version '2.4.4'
Consultez la rubrique Référence du message d’erreur pour plus d’informations sur les différentes erreurs que ce rapport peut générer.
Ce rapport contient également un résumé détaillé qui indique :
- Version actuelle : version actuellement installée.
- Version cible : version vers laquelle vous souhaitez effectuer la mise à niveau.
- Temps d’exécution : temps nécessaire à l’analyse pour créer le rapport (mm:ss).
- Modules nécessitant une mise à jour : pourcentage de modules contenant des problèmes de compatibilité et nécessitant une mise à jour.
- Fichiers nécessitant une mise à jour : pourcentage de fichiers contenant des problèmes de compatibilité et nécessitant une mise à jour.
- Nombre total d'erreurs critiques : nombre d'erreurs critiques trouvées.
- Nombre total d'erreurs : nombre d'erreurs trouvées.
- Total des avertissements : nombre d’avertissements trouvés.
- Utilisation du pic mémoire : quantité maximale de mémoire atteinte par Upgrade Compatibility Tool lors de l’exécution.
Voir l’exemple d’interface de ligne de commande suivant :
----------------------------- -----------------
Current version 2.4.1
Target version 2.4.4
Execution time 1m:8s
Modules that require update 71.67% (43/60)
Files that require update 18.05% (96/532)
Total critical issues 24
Total errors 159
Total warnings 53
Memory peak usage 902.00 MB
----------------------------- -----------------
Fichier JSON
Vous pouvez obtenir la sortie du fichier JSON lors de l’exécution de Upgrade Compatibility Tool sur une interface de ligne de commande. Le fichier JSON contient exactement les mêmes informations que celles affichées dans la sortie Upgrade Compatibility Tool :
- Liste des problèmes identifiés.
- Résumé de l’analyse.
Pour chaque problème rencontré, le rapport fournit des informations détaillées telles que la gravité et la description du problème.
Pour exporter ce fichier JSON dans un dossier de sortie différent :
bin/uct upgrade:check <dir> --json-output-path[=JSON-OUTPUT-PATH]
Où les arguments sont les suivants :
<dir>: répertoire d’installation Adobe Commerce.[=JSON-OUTPUT-PATH]: répertoire de chemin d’accès pour exporter le fichier de sortieJSON.
var/output/[TIME]-results.json.Rapport HTML
Vous pouvez obtenir le rapport d’HTML lors de l’exécution de l’outil sur une interface de ligne de commande ou via le Site-Wide Analysis Tool. Le rapport HTML contient également :
- Liste des problèmes identifiés.
- Résumé de l’analyse.
Vous pouvez facilement parcourir les problèmes identifiés lors de l’analyse Upgrade Compatibility Tool.
Vous pouvez filtrer les problèmes affichés sur le rapport en fonction du niveau de problème minimum (la valeur par défaut est WARNING).
Une liste déroulante dans le coin supérieur droit permet de sélectionner un autre niveau. La liste des problèmes identifiés est filtrée en conséquence.
Le rapport HTML comprend également quatre graphiques différents :
- Modules par gravité de problème : affiche la distribution de la gravité par modules.
- Fichiers par gravité de problème : affiche la distribution de gravité par fichiers.
- Modules classés par nombre total de problèmes : affiche les 10 modules les plus compromis prenant en compte les avertissements, erreurs et erreurs critiques.
- Modules avec des tailles et des problèmes relatifs : plus un module contient de fichiers, plus son cercle est volumineux. Plus un module a de problèmes, plus son cercle rouge apparaît.
Ces graphiques vous permettent d’identifier les modules les plus compromis et ceux qui nécessitent davantage de travail pour effectuer une mise à niveau.
Les diagrammes de rapport d’HTML sont également mis à jour en conséquence, à l’exception de Modules with relative sizes and issues, qui est généré avec le min-issue-level initialement configuré.
Si vous souhaitez afficher des résultats différents pour le diagramme Modules with relative sizes and issues, vous devez exécuter à nouveau la commande en fournissant une autre valeur pour l’option --min-issue-level.
Pour exporter ce rapport d'HTML dans un dossier de sortie différent :
bin/uct upgrade:check <dir> --html-output-path[=HTML-OUTPUT-PATH]
Où les arguments sont les suivants :
<dir>: répertoire d’installation Adobe Commerce.[=HTML-OUTPUT-PATH]: répertoire de chemin d’accès pour exporter le fichier de sortie.html.
var/output/[TIME]-results.html.