report

Command Function

Displays historical reports or analyzes the differences between reports.

Syntax

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

Parameter Description

**Table 1** Parameters of the **report** command
Parameter	Option	Description
-h/--help	-	Obtains help information and displays historical reports. NOTE: Historical report are saved in the Tool_installation_path/output/kspect-Subcommand-YYYYMMDD-HHMMSS directory. The file name is kspect-json-Subcommand-YYYYMMDD-HHMMSS.json. If a report has been collected but is not contained in the historical reports, move the report to the output directory in the tool installation path and name the report in the format of kspect-json-YYYYMMDD-HHMMSS.json, for example, kspect-json-20260101-121314.json.
-r/--report	Report No.	Select historical reports or enter report paths (tool collection reports or reported generating using diff/diff_x86 are supported). A maximum of the latest 10 reports are displayed.
-d/--diff	0 N N,M <INPUT_PATH> <INPUT_PATH_A>,<INPUT_PATH_B>	Select the two reports that you want to compare. 0: generates a report and compares it with the previous report. N: generates a new report and compares it with historical report <N>. N,M: compares historical report <N> with historical report <M>. <INPUT_PATH>: generates a new report and compares it with the specified report. <INPUT_PATH_A>,<INPUT_PATH_B>: compares reports <A> and <B>. NOTE: When comparing the full report and a subcommand report, only the module content that exists in both reports is compared. The report generated after comparison is saved in the folder named Tool_installation_path/output/kspect-diff-[before]-[after]-YYYYMMDD-HHMMSS. The generated file is named in the format of kspect-diff-[before]-[after]-YYYYMMDD-HHMMSS.json. For identical modules, only one module name is displayed. The Network IRQ Table, NPU-smi Topology Table, Ascend DMI Table, Ascend Bandwidth Table, and Hardware Interrupt Info Table information cannot be compared.
--diff_x86	<X86_PATH> N,<X86_PATH> <INPUT_PATH>,<X86_PATH>	Select the report to be compared with the x86 report. x86 reports generated using perfspect report --all are supported (the PerfSpect tool is available at https://github.com/intel/PerfSpect). The format is as follows: <X86_PATH>: generates a report and compares it with the input x86 report. N,<X86_PATH>: compares historical report <N> with the x86 report. <INPUT_PATH>,<X86_PATH>: compares the input collection report with the input x86 report. NOTE: When comparing the full report and a subcommand report, only the module content that exists in both reports is compared. A report generated after comparison is saved in Tool_installation_path/output/kspect-diff-Subcommand-x86-YYYYMMDD-HHMMSS directory. The file name is kspect-diff-Subcommand-x86-YYYYMMDD-HHMMSS.json. The Network IRQ Table, NPU-smi Topology Table, Ascend DMI Table, Ascend Bandwidth Table, and Hardware Interrupt Info Table information cannot be compared.
-t/--threshold	Non-negative number	Specifies the threshold for comparison. Data that exceeds the threshold is marked. The default threshold is 20% (no percent sign is required). Only --diff/--diff_x86 is supported.
--diff_base	<BASE_PATH> N,<BASE_PATH> <INPUT_PATH>,<BASE_PATH>	Compares the collection report with the baseline data. The format is as follows: <BASE_PATH>: Generates a new report and compares it with the baseline report. N,<BASE_PATH>: Compares the historical report <N> with the baseline report. <INPUT_PATH>,<BASE_PATH>: Compares the input collection report with the baseline report. NOTE: The baseline report template is stored in Tool_installation_path/documents/base.xlsx. Each column contains the path, baseline value, customized collection name, impact, and modification method.

Example

Display historical reports.
1

./kspect -l 0 report -h
The -h option displays the latest 10 reports. You can run the ./kspect report -r Report_SN command to view the report with the specified serial number.

Figure 1 Report records

Compare the system report with the full report.

./kspect report -d 1,2

For the system report, run the ./kspect system -o command to collect information, which includes only host information. If a -- is not displayed in red in the report, the related data is either unavailable or cannot be collected.

Figure 2 Comparison between the system report and the full report

**Table 2** Report description
Item	Sub-item	Description
Note		Describes the [before] and [after] reports and the comparison rules. The comparison result shows the System module data that exists in both reports.
System	Host	Compares host information. A -- in red in the diff column indicates that the two data records are different.
	Product	Compares product information. The [before] report (system report) does not contain product information. Therefore, no diff data exists.
	Baseboard	Compares mainboard information. The [before] report (system report) does not contain mainboard information. Therefore, no diff data exists.
JSON File		The generated report is saved in the Tool_installation_path/output/kspect-diff-system-all-YYYYMMDD-HHMMSS directory and the file name is kspect-diff-system-all-YYYYMMDD-HHMMSS.json.

Compare the latest historical report with the x86 report.

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

In the comparison report, [common] indicates that the configuration item exists in both reports, and [same] indicates the identical data.
In the comparison report, [arm] indicates data exclusive to Arm, and [x86] indicates data exclusive to x86.

Figure 3 Storage comparison report

**Table 3** Storage report description
Item	Sub-item	Description
Note		Describes the [arm] and [x86] reports and the comparison rules. Only information that exists in both the Arm and x86 architectures is compared. Data exclusive to either Arm or x86 is not compared.
Storage	Disk Table	Compares drive information. Entries with values in square brackets whose differences exceed 60% are displayed in red. A red [--] indicates that the threshold cannot be calculated, but the values differ. A -- indicates that the information does not exist or is missing.

Compare the latest historical report with the baseline report.

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

In the comparison report, [current] indicates that the collected report data. If its value is --, the data is not collected.
[base] indicates the baseline report content. Differences between the collected and baseline content are marked in the Diff column, and the impact and suggested modifications are displayed.

**Table 4** Part of report description
Item	Sub-item	Description
Note		Path to the [current] and [base] reports.
UB	UBSE Info	The name column indicates the customized collection name in the baseline report. The current column indicates the data collected in the current report. -- indicates that the data is not collected. The base column indicates the baseline value in the baseline report. The diff column indicates the comparison result between the collected value and the baseline value. The impact column indicates the customized impact content in the baseline report, and if no value is entered, -- is displayed.

Parent topic: Commands and Parameters