Documentation
Rate This Document
Findability
Accuracy
Completeness
Readability
SubmitClose

report

Command Function

Displays historical reports or analyzes the differences between reports.

Syntax

1
./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.

-r/--report

Report No.

Select historical reports or enter report paths (tool collection reports or reported generating using diff/diff_x86 are supported). Only 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>.

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

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

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.
    • If no historical report is available, run the ./kspect all command to generate the first report, or move the existing reports to the output directory in the tool path. The moved reports must be named in the format of kspect-json-eight-digit number-six-digit number.json, for example, kspect-json-12345678-123456.json.
  • Compare the latest historical report with the x86 report.
    1
    ./kspect report --diff_x86 1,/home/kspect/perfspect/localhost.localdomain3.0.0.json -t 90
    • -t 90 indicates data items whose difference exceeds 90% are marked in red in the comparison report.
    • If there is a value in the brackets and the difference exceeds the threshold, the value is displayed in red. [--] indicates that the threshold cannot be calculated and the value is also displayed in red.
    • [arm] and [x86] indicate the unique Arm and x86 report data, respectively. [common] contains data shared by both. [same] indicates that the compared data is identical in the two reports.
Parent topic: Commands and Parameters