报告

NOTE
Upgrade Compatibility Tool仅适用于Adobe Commerce实例。

作为分析的结果,Upgrade Compatibility Tool可以导出一个报告,其中包含每个文件的问题列表,并指定其严重性、错误代码和错误说明。 Upgrade Compatibility Tool将报告导出为两种不同的格式:

请参阅以下报告的命令行界面示例:

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'

查看错误消息引用主题,了解有关此报告可以产生的不同错误的更多信息。

此报表还包括一个详细的摘要,其中显示:

  • 当前版本:当前安装的版本。
  • 目标版本:要升级到的版本。
  • 执行时间:分析生成报告所用的时间(mm:ss)。
  • 需要更新的模块:包含兼容性问题且需要更新的模块的百分比。
  • 需要更新的文件:包含兼容性问题且需要更新的文件的百分比。
  • 严重错误总数:找到的严重错误数。
  • 错误总数:找到的错误数。
  • 警告总数:找到的警告数。
  • 内存峰值使用率: Upgrade Compatibility Tool在执行期间已达到最大内存量。

请参阅以下命令行界面示例:

 ----------------------------- -----------------
  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
 ----------------------------- -----------------

JSON文件

在命令行界面上运行Upgrade Compatibility Tool时,可以获取JSON文件输出。 JSON文件包含的信息与Upgrade Compatibility Tool输出中显示的完全相同:

  • 已识别问题的列表。
  • 分析摘要。

对于每个遇到的问题,报告都会提供详细信息,例如问题的严重性和描述。

要将此JSON文件导出到其他输出文件夹,请执行以下操作:

bin/uct upgrade:check <dir> --json-output-path[=JSON-OUTPUT-PATH]

其中参数如下:

  • <dir>: Adobe Commerce安装目录。
  • [=JSON-OUTPUT-PATH]:用于导出JSON输出文件的路径目录。
NOTE
输出文件夹的默认路径为var/output/[TIME]-results.json

HTML报表

在命令行界面上或通过Site-Wide Analysis Tool运行工具时,可以获取HTML报告。 HTML报表还包含:

  • 已识别问题的列表。
  • 分析摘要。

HTML报告 — 摘要

在Upgrade Compatibility Tool分析过程中,您可以轻松地浏览已识别的问题。

您可以根据最低问题级别(默认值为WARNING)筛选报表上显示的问题。

右上角有一个下拉列表,允许您选择其他级别。 已识别的问题列表将相应地被过滤。

HTML报告 — 下拉列表使用情况

NOTE
较低问题级别的问题会被剔除,但您会收到通知,这样您就始终能够了解每个模块识别的问题。

HTML报表还包括四个不同的图表:

  • 按问题严重性显示的模块:按模块显示严重性分布。
  • 按问题严重性列出的文件:按文件显示严重性分布。
  • 按问题总数排序的模块:显示危害最大的10个模块,其中考虑警告、错误和严重错误。
  • 具有相对大小和问题的模块:模块包含的文件越多,其圆圈越大。 模块出现的问题越多,其圆圈显示的红色就越多。

利用这些图表,可识别最容易损坏的模块以及需要更多工作才能执行升级的模块。

HTML报告 — 图表

HTML报表图也会相应地更新,但Modules with relative sizes and issues除外,它是使用最初设置的min-issue-level生成的。

如果要查看Modules with relative sizes and issues图的不同结果,必须重新运行该命令,为--min-issue-level选项提供另一个值。

HTML报告 — 气泡图图表

要将此HTML报表导出到其他输出文件夹,请执行以下操作:

bin/uct upgrade:check <dir> --html-output-path[=HTML-OUTPUT-PATH]

其中参数如下:

  • <dir>: Adobe Commerce安装目录。
  • [=HTML-OUTPUT-PATH]:用于导出.html输出文件的路径目录。
NOTE
输出文件夹的默认路径为var/output/[TIME]-results.html
recommendation-more-help
83a60e0e-8849-4685-a8cd-c129ecd795ea