Documentation
Rate This Document
Findability
Accuracy
Completeness
Readability
SubmitClose

Kunpeng Health Inspector Functions

The Kunpeng Health Inspector can collect hardware information such as CPU, memory, NIC, and PCIe data in a lightweight manner, generate health reports and tuning suggestions, and help detect performance deterioration caused by hardware faults or configuration errors.

Prerequisites

  • You have installed the tool. See Installing a Compressed Package (.tar.gz).
  • The tool is contained in an independent package (devkit-kspect-x.x.x-Linux-aarch64.tar.gz). Extract the package and switch to the tool directory.

Command Function

The Kunpeng Health Inspector is a lightweight and precise tool for collecting static Kunpeng hardware information. It swiftly collects data on server hardware, such as CPUs, memory, network, storage, PCIe, virtual machines (VMs), sensors, software, and module dependencies, and offers performance tuning suggestions based on the collected data.

  • These functions are available on Kunpeng hardware and are supported on physical machines, virtual machines (VMs), and containers. If certain data is not supported, a message is displayed. Hardware information obtained from VMs and containers may be inconsistent with that from physical machines.
  • The tool can run on openEuler, CentOS, Debian, and Ubuntu. The OS version must be the same as that supported by the DevKit. For a non-openEuler OS, some fields may be missing when server hardware information is collected.
  • OSs with kernel versions 4.19, 5.10, 6.6, and 5.15 are supported.

Syntax

1
./kspect [-h] [-L {0,1,2,3,4}] [-l {0,1}] [--remote] [-s] [-c COMMAND] {system,os,bios,software,cpu,numa,memory,network,storage,pcie,ascend,bmc,config,cluster,server_config,all,report} ...

Example

1
./kspect -l 0 -h

Command output:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
NAME
    Kunpeng Health Inspector

USAGE
    kspect [-h] [-L {0,1,2,3,4}] [-l {0,1}] [--remote] [-s] [-c COMMAND] {system,os,bios,software,cpu,numa,memory,network,storage,pcie,ascend,bmc,config,cluster,server_config,all,report} ...

POSITIONAL ARGUMENTS
    {system,os,bios,software,cpu,numa,memory,network,storage,pcie,ascend,bmc,config,cluster,server_config,all,report}
    Select health check items.

    system
    Displays all system information, including the server, vendor, and mainboard information.

    os
    Displays the OS name, system version, kernel version, and boot parameters.

    bios
    Displays BIOS information, including the boot type, cache mode, and PCIe rate.
                        Note: This feature requires the permission to run ipmitool. Alternatively, configure the BMC information (user name and password) to obtain the complete system information.

    software
    Displays software information, including GCC, glibc, Binutils, Python, KVM, and Docker.

    cpu
    Displays CPU information, including the CPU model and list.

    numa
    Displays NUMA information, including CPUs, memory, PCIe, networks, and NVMe.

    memory
    Displays memory information, including common memory information and DIMM information.

    network
    Displays network information, including NIC and IRQ information.

    storage
    Displays storage information, including drives and partitions.

    pcie
    Displays PCIe information, including the PCIe driver and IRQ information.

    ascend
    Displays Ascend NPU information, including npu-smi and ascend-dmi.

    bmc
    Displays information obtained using the BMC. This function requires the permission to run ipmitool. Alternatively, configure the BMC information (BMC IP address, user name, and password) to obtain the information. If you do not enter the BMC information, SEL logs will not be collected.

    config
    Checks and displays the dependency between modules.

    cluster
    Collects the remote cluster data and sends back reports. If you want to use Ansible for the collection, see the "KSPECT Remote Collection Guide - Using Ansible" document.

    server_config
    Encrypts the authentication credentials in the cluster collection configuration file in interactive mode.

    all
    Displays full system information.
    Note: Collecting all information relies on the BMC information (IP address, user name, and password). If you do not provide the BMC information, the IPMItool will be used for the collection, and the report will lack the information about the modules that strongly depend on the BMC.

    report
    Displays historical reports or analyze the differences between reports.

OPTIONS
    -h, --help
    Views the help information and exits.

    -L {0,1,2,3,4}, --log-level {0,1,2,3,4}
    Log level, which is 0(debug) | 1(info) | 2(warning) | 3(error) | 4(notset). The default is 4(notset).

    -l {0,1}, --language {0,1}
    Printing language, which is 0(en) | 1(zh). The default is 1(zh).
    Note: If the current environment does not support the selected language, 0(en) is used.

    --remote
    Indicates whether to collect remote node information.
    Note: The tool will be transferred to the /tmp directory on the remote node. After the collection is complete, the tool is deleted. To use the tool on the remote node, you need to obtain the SSH login information of the remote node, including the IP address and port (xx.xx.xx.xx:Port, with the porting defaulting to 22), username, and password.

    -s, --skip-bmc
    Skips BMC collection.

    -c COMMAND, --bmc-command COMMAND
    Runs the user-defined BMC information collection command.
Parent topic: Kunpeng Health Inspector