guide

Intel System Health Inspector

For more on this topic, take the Lab: System Health Inspector

In partnership with

·3 min read

3 min read

Share this doc:

Intel's System Health Inspector (SHI) can be used on bare metal and virtual machine (VM) instances. There are some differences in the report details between bare metal and VM, as bare metal reports provide a greater level of detail.

VM reports include:

Information regarding Power & Perf Policy, TDP, Frequency driver, and Frequency governor in the “Power” section of the report
Limited information on the DIMM Details section
NUMA Node and Speed information in the “Network Interfaces” section
TDP microbenchmarks
A PMU section

Try out the SHI on a bare metal and VM to compare the reports to see notable differences in the report details.

Intel System Health Inspector creates system information and health reports for one or more systems.

Here are some examples of usage:

svr_info [-h] [--version] [--input INPUT] [--output OUTPUT] [--format FORMAT] [--combine] [--all] [--cpu] [--frequency] [--memory] [--storage] [--storage_dir STORAGE_DIR] [--turbo] [--dumpconfig] [--config CONFIG] [--deps DEPS] [--ip IP][--port PORT] [--user USER] [--key KEY] [--targets TARGETS]

Quick Reference Guide for Arguments

Optional Arguments

Shortcut	Output
-h, --help	show this help message and exit
--input INPUT	show program's version number and exit
--version	don't collect new data, parse pre-collected data specify path to one output file or directory of output files (default: None)
--output OUTPUT	optima Specify path to desired output directory directory must exist defaults to current directory (default: None)

Shortcut

-h, --help

Output:

show this help message and exit

--input INPUT

Output:

show program's version number and exit

--version

Output:

don't collect new data, parse pre-collected data
specify path to one output file or directory of output files (default: None)

--output OUTPUT

Output:

optima Specify path to desired output directory
directory must exist
defaults to current directory (default: None)

Report Arguments

Shortcut	Output
-h, --help	show this help message and exit
--combine	combine outputs from multiple targets into one report per format requested (default: False)

Shortcut

-h, --help

Output

show this help message and exit

Shortcut

--combine

Output

combine outputs from multiple targets into one report per format requested (default: False)

Data Collection Arguments

Shortcut	Output
--all	enables all the micro-benchmarks (default: False)
--cpu	measure CPU performance (default: False)
--frequency	measure turbo frequencies test time increases with number of cores (default: False)
--memory	measure memory performance (default: False)
--storage	measure storage performance (default: False)
--storage_dir STORAGE_DIR	optionally specify full path to existing directory on target machine that will be used for storage micro-benchmark
--turbo	measure TDP and all-core turbo frequency (default: False)
--dumpconfig	writes default collection configuration template to stdout and exits (default: False)
--config CONFIG	path to collection configuration template (default: None)
--deps DEPS	path to archive of additional collection dependencies (default: None)

Shortcut

--all

Output:

enables all the micro-benchmarks (default: False)

--cpu

Output:

measure CPU performance (default: False)

--frequency

Output:

measure turbo frequencies test time
increases with number of cores (default: False)

--memory

Output:

measure memory performance (default: False)

--storage

Output:

measure storage performance (default: False)

--storage_dir STORAGE_DIR

Output:

optionally specify full path to existing directory on target machine that will be used for storage micro-benchmark

--turbo

Output:

measure TDP and all-core turbo frequency (default: False)

--dumpconfig

Output:

writes default collection configuration template to stdout and exits (default: False)

--config CONFIG

Output:

path to collection configuration template (default: None)

--deps DEPS

Output:

path to archive of additional collection dependencies (default: None)

Remote Target Arguments

Shortcut	Output
--ip IP	ip address or hostname (default: localhost)
--port PORT	ssh port (default: 22)
--user USER	user on remote target (default: None)
--key KEY	local path to ssh private key file (default: None)
--targets TARGETS	path to target file, one line per target: 'ip_address: ssh_port:user_name:<private_key_path>:<password>: sudo_password' provide either path to private key or password ':'s are required if specified, overrides single target arguments

Shortcut

--ip IP

Output:

ip address or hostname (default: localhost)

--port PORT

Output:

ssh port (default: 22)

--user USER

Output:

user on remote target (default: None)

--key KEY

Output:

local path to ssh private key file (default: None)

--targets TARGETS

Output:

path to target file, one line per target: 'ip_address: ssh_port:user_name:<private_key_path>:<password>: sudo_password'
provide either path to private key or password
':'s are required
if specified, overrides single target arguments

Here are some example uses of these various argument types:

```
$ svr_info --all
```
- Collect all data on local machine.
```
$ svr_info
```
- Collect basic data (no micro-benchmarks).
```
$ svr_info --all --target ./targets
```
- Collect all data on remote machines defined in targets file.
```
 $ svr_info --format all
```
- Collect basic data. Generate all report types.

For more on this topic, take the Lab:

1 Lab

System Health Inspector

In this lab, you will learn the capabilities and uses for System Health Inspector (SHI), how to run SHI to evaluate system performance, and analyze the outputs to gain insights into potential problem areas.

Get Started