Add SMART self-test results to zpool status -c

[tonyhutter]

Description

Add in SMART self-test results to zpool status|iostat -c. This works for both SAS and SATA drives.

$ zpool status -c smart_test
  pool: mypool
 state: ONLINE
  scan: none requested
config:

	NAME           STATE     READ WRITE CKSUM         test_type             test_status  test_progress  test_ended
	mypool         ONLINE       0     0     0
	  /tmp/file1   ONLINE       0     0     0  background_short                 aborted              -           -
	  /tmp/file2   ONLINE       0     0     0  extended_offline               completed           100%       9d10h
	  /tmp/file3   ONLINE       0     0     0     short_offline               completed           100%           -
	  /tmp/file4   ONLINE       0     0     0  extended_offline               completed           100%           -
	  /tmp/file5   ONLINE       0     0     0   background_long               completed              -     1347d4h
	  /tmp/file6   ONLINE       0     0     0  background_short                 aborted              -           -
	  /tmp/file7   ONLINE       0     0     0   background_long                 running            90%           -
	  /tmp/file8   ONLINE       0     0     0  extended_offline  completed:read_failure            90%          4h
	  /tmp/file9   ONLINE       0     0     0   background_long                 running            90%           -
	  /tmp/file10  ONLINE       0     0     0   background_long                 running            90%           -

smart_test:	Show SMART self-test results summary.
test_type:	Show SMART self-test type (short, long... ).
test_status:	Show SMART self-test status.
test_progress:	Show SMART self-test percentage done.
test_ended:	Show when the last SMART self-test ended (if supported).

Motivation and Context

We plan to run SMART self-tests on all drives that are showing SMART or ZFS errors, but are not yet faulted. This will allow us to easily see the test results.

How Has This Been Tested?

Tested using 12 different samples of smartctl output from SAS and SATA drives at various stages of self-test.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Performance enhancement (non-breaking change which improves efficiency)
• Code cleanup (non-breaking change which makes code smaller or more readable)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation (a change to man pages or other documentation)

Checklist:

• My code follows the ZFS on Linux code style requirements.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• All new and existing tests passed.
• All commit messages are properly formatted and contain Signed-off-by.
• Change has been approved by a ZFS on Linux member.

[behlendorf]

This looks good to be, but I'm not quite sure what happened with the bots. @tonyhutter would you mind rebasing this on master so we can another full test run to see if the zimport issue is reproducible.

[tonyhutter]

Thanks. I'm planning to rebase after #7183 is checked in since it will conflict.

[bunder2015]

I've been thinking about this. If we set type in the awk section, do we need to here? We might want to revise the -z type section below as well.

[tonyhutter]

Yea, we could grep type from $out so that we're only setting it in the awk section.

[codecov]

Codecov Report

Merging #7178 into master will decrease coverage by 0.09%.
The diff coverage is n/a.

@@            Coverage Diff            @@
##           master    #7178     +/-   ##
=========================================
- Coverage   76.49%   76.39%   -0.1%     
=========================================
  Files         327      327             
  Lines      103867   103835     -32     
=========================================
- Hits        79450    79323    -127     
- Misses      24417    24512     +95

Flag	Coverage Δ
#kernel	76.33% <ø> (+0.3%)	⬆️
#user	65.75% <ø> (-0.09%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4af6873...d1bbf28. Read the comment docs.

[h1z1]

Curious, since this adds smartctl as a dependency should that not be reflected in things like the rpm spec? There is a rather odd change to sudoers too, should that not be more documented? From what I gather of this change if the user is not in sudoers, access will be undefined anyway.

smartctl_path=$(which smartctl)

The only sanity check I can see is that smartctl is executable.

[tonyhutter]

@h1z1 yea, we should probably add a Recommends: smartmontools line to the spec for the distros that support it, and print an error if you can't run smartctl for any reason. Error reporting for -c is basically non-existent right now... We do have a note about adding smartctl to the sudoers file, but looking at it now, I don't think it will work for NVMe devices:

$ cat etc/sudoers.d/zfs 
##
## Allow any user to run `zpool iostat/status -c smart` in order
## to read basic SMART health statistics for a pool.
##
## CAUTION: Any syntax error introduced here will break sudo.
##

# ALL ALL = (root) NOPASSWD: /usr/sbin/smartctl -a /dev/[hsv]d[a-z0-9]*

So lots of work still needed...

[h1z1]

@tonyhutter Indeed there is the formatting and device regex not matching but also allowing users to do stupid things like calling smartctl in a loop. It will pound the drive(s) in question. Discloses serial numbers, etc too.