report子命令

命令功能

显示历史报告或分析两份报告间的差异。

命令格式

      
           ./kspect report [-h] [-r REPORT] [-d DIFF [-t THRESHOLD]] [--diff_x86 DIFF_X86 [-t THRESHOLD]]

参数说明

表1 report子命令参数
参数	参数选项	参数说明
-h/--help	-	获取帮助信息，显示报告的历史记录。说明：历史报告存放目录为“工具安装路径/output/kspect-子命令-YYYYMMDD-HHMMSS”，生成的文件以“kspect-json-子命令-YYYYMMDD-HHMMSS.json”格式命名。如果有已采集但未显示在历史报告中的报告，请将其移至工具安装路径下的output目录中，并以“kspect-json-YYYYMMDD-HHMMSS.json”格式命名，例如：kspect-json-20260101-121314.json。
-r/--report	报告序号	在历史记录中选择需展示的报告或输入报告路径（支持工具采集报告和使用diff/diff_x86后生成的对比报告），历史记录最多仅显示时间最近的10个报告。
-d/--diff	0 N N,M <INPUT_PATH> <INPUT_PATH_A>,<INPUT_PATH_B>	选择需对比的两份报告，使用格式如下： 0：生成新报告，并和上一个报告比较。 N：生成新报告，与历史报告<N>比较。 N,M：比较历史报告<N>和报告<M>。 <INPUT_PATH>：生成新报告并与指定报告比较。 <INPUT_PATH_A>,<INPUT_PATH_B>：比较报告<A>和报告<B>。说明：在对比全量报告与子命令报告时，仅会比较两份报告中都存在的模块内容。对比后生成的报告文件夹为“工具安装路径/output/kspect-diff-[before]-[after]-YYYYMMDD-HHMMSS”，生成的文件以“kspect-diff-[before]-[after]-YYYYMMDD-HHMMSS.json”格式命名，若模块相同将仅显示一个模块名。不支持对比Network IRQ Table、NPU-smi Topology Table、Ascend DMI Table、Ascend Bandwidth Table和Hardware Interrupt Info Table信息。
--diff_x86	<X86_PATH> N,<X86_PATH> <INPUT_PATH>,<X86_PATH>	选择需要和x86报告对比的报告，当前支持perfspect report --all生成的x86报告（perfspect获取地址：https://github.com/intel/PerfSpect），使用格式如下： <X86_PATH>：生成新报告并与输入的x86报告对比。 N,<X86_PATH>：比较历史报告号<N>和x86报告。 <INPUT_PATH>,<X86_PATH>：比较输入的采集报告和输入的x86报告。说明：在对比全量报告与子命令报告时，仅会比较两份报告中都存在的模块内容。对比后生成的报告文件夹为“工具安装路径/output/kspect-diff-子命令-x86-YYYYMMDD-HHMMSS”，生成的文件以“kspect-diff-子命令-x86-YYYYMMDD-HHMMSS.json”格式命名。不支持对比Network IRQ Table、NPU-smi Topology Table、Ascend DMI Table、Ascend Bandwidth Table和Hardware Interrupt Info Table信息。
-t/--threshold	非负数值	指定对比的阈值百分比，超过此阈值的数据会被标记，系统默认为20%（输入时无需添加“%”），只支持--diff/--diff_x86。
--diff_base	<BASE_PATH> N,<BASE_PATH> <INPUT_PATH>,<BASE_PATH>	对比采集报告与基线数据，使用格式如下： <BASE_PATH>：生成新报告并与基线报告对比。 N,<BASE_PATH>：选择历史报告<N>与基线报告对比。 <INPUT_PATH>,<BASE_PATH>：选择输入的采集报告与基线报告对比。说明：基线报告模板路径为“工具安装路径/documents/base.xlsx”，每列依次为路径、基线值、自定义采集名、影响和修改方法。

使用示例

查看存在的历史报告。
1

./kspect report -h
使用-h参数可查看生成时间最近的10个报告记录，使用“./kspect report -r 报告序号”可查看对应序号的报告。

图1 报告记录

对比system报告和全量报告。

./kspect report -d 1,2

system报告使用命令“./kspect system -o”采集，仅采集主机信息。报告中未标红的“--”表示无此数据或无法采集。

图2 system和全量报告对比

表2 报告说明
类别	子类别	说明
Note		对于[before]、[after]报告以及对比规则的具体说明。此处仅对比展示两份报告都存在System模块数据。
System	Host	主机信息对比。diff列标红“--”表示两个数据不同。
	Product	产品信息对比。此处[before]报告（即system报告）未采集产品信息，故不存在diff数据。
	Baseboard	主板信息对比。此处[before]报告（即system报告）未采集主板信息，故不存在diff数据。
JSON文件生成说明		生成的报告保存在“工具安装路径/output/kspect-diff-system-all-YYYYMMDD-HHMMSS”下，文件名称为kspect-diff-system-all-YYYYMMDD-HHMMSS.json。

使用最近的历史报告和x86报告进行对比。

        
             ./kspect report --diff_x86 1,/home/kspect/perfspect/localhost.localdomain3.0.1.json -t 60

对比报告中[common]表示两份报告中均有的配置项，[same]表示两份报告的该数据相同。
对比报告中[arm]为ARM报告独有数据，[x86]为x86报告独有数据。

图3 存储部分对比报告

表3 存储部分报告说明
类别	子类别	说明
Note		对于[arm]和[x86]报告以及对比规则的具体说明。仅对比ARM和x86共同存在的信息，ARM和x86独有数据不进行对比。
Storage	Disk Table	硬盘信息对比，中括号内有数值且差值超过60%的信息标红显示，标红“[--]”表示无法计算阈值但值不同，“--”表示不存在该信息或信息缺失。

使用最近的历史报告和基线报告对比。

        
             ./kspect report --diff_base 1,/home/base.xlsx

对比报告中[cuurent]表示采集报告数据，若值为“--”表示未采集到该数据。
[base]表示基线报告中填写的基线内容，若采集内容与基线内容不一致将在diff列标明，同时显示不一致项的影响和修改方法。

表4 部分报告说明
类别	子类别	说明
Note		[current]和[base]报告的路径。
UB	UBSE Info	name列为基线报告中自定义的采集名，current列为当前报告采集的数据，“--”表示未采集到该数据，base列为基线报告中填写的基线值，diff列表明采集值和基线值的对比结果，impact列为基线报告中自定义填写的影响内容，未填写时显示“--”。

父主题： 命令及参数说明