.. image:: http://img.shields.io/pypi/v/check-zpool-scrub.svg :target: https://pypi.org/project/check-zpool-scrub :alt: This package on the Python Package Index
.. image:: https://github.com/Josef-Friedrich/check_zpool_scrub/actions/workflows/tests.yml/badge.svg :target: https://github.com/Josef-Friedrich/check_zpool_scrub/actions/workflows/tests.yml :alt: Tests
Note: This monitoring plugin is written in Python from version 3 onwards.
Earlier versions of this plugin were written in shell script. The latest version
of the shell script can be retrieved via the git history __.
Command line interface
::
usage: check_zpool_scrub [-h] [-V] [-v] [-p POOL] [-w TIMESPAN] [-c TIMESPAN]
[-d]
version 3.0.0a2
Licensed under the MIT.
Repository: https://github.com/Josef-Friedrich/check_zpool_scrub.
Copyright (c) 2016-2026 Josef Friedrich
Monitoring plugin to check how long ago the last ZFS scrub was performed.
options:
-h, --help show this help message and exit
-V, --version show program's version number and exit
-v, --verbose Increase the output verbosity.
-p, --pool POOL Name of the pool. If this option is omitted all pools
are checked.
-w, --warning TIMESPAN
Interval in seconds for warning state. See timespan
format specification below. Must be lower than -c.
-c, --critical TIMESPAN
Interval in seconds for critical state. See timespan
format specification below.
-d, --debug Increase debug verbosity (use up to 3 times): -D: info
-DD: debug. -DDD verbose
Performance data:
POOL is the name of the pool
- POOL_last_scrub
Time interval in seconds for last scrub.
- POOL_progress
Percent 0 - 100
- POOL_speed
MB per second.
- POOL_time_to_go
Time to go in seconds.
Details about the implementation of this monitoring plugin:
This monitoring plugin grabs the last scrub date from the command
'zpool status POOL'.
Timespan format
---------------
If no time unit is specified, generally seconds are assumed. The following time
units are understood:
- years, year, y (defined as 365.25 days)
- months, month, M (defined as 30.44 days)
- weeks, week, w
- days, day, d
- hours, hour, hr, h
- minutes, minute, min, m
- seconds, second, sec, s
- milliseconds, millisecond, msec, ms
- microseconds, microsecond, usec, μs, μ, us
The following are valid examples of timespan specifications:
- `1`
- `1.23`
- `2.345s`
- `3min 45.234s`
- `34min`
- `2 months 8 days`
- `1h30m`
