ceph/doc/mgr/devicehealth.rst
Sage Weil df71738d79 doc/mgr/devicehealth: update docs
- several new commands weren't documented

Signed-off-by: Sage Weil <sage@redhat.com>
2018-08-29 12:30:24 -05:00

71 lines
2.0 KiB
ReStructuredText

Devicehealth plugin
===================
The *devicehealth* plugin includes code to manage physical devices
that back Ceph daemons (e.g., OSDs). This includes scraping health
metrics (e.g., SMART) and responding to health metrics by migrating
data away from failing devices.
Enabling
--------
The *devicehealth* module is enabled with::
ceph mgr module enable devicehealth
(The module is enabled by default.)
To turn on automatic device health monitoring, including regular (daily)
scraping of device health metrics like SMART::
ceph device monitoring on
To disable monitoring,::
ceph device monitoring off
Scraping
--------
Health metrics can be scraped from all devices with::
ceph device scrape-health-metrics
A single device can be scraped with::
ceph device scrape-health-metrics <device-id>
Or a single daemon's devices can be scraped with::
ceph device scrape-daemon-health-metrics <who>
The stored health metrics for a device can be retrieved (optionally
for a specific timestamp) with::
ceph device show-health-metrics <devid> [sample-timestamp]
Health monitoring
-----------------
By default, the devicehealth module wakes up periodically and checks
the health of all devices in the system. This will raise health
alerts if devices are expected to fail soon. This can be disabled by
turning off the ``mgr/devicehealth/enable_monitoring`` option.
The ``mgr/devicehealth/warn_threshold`` controls how soon an expected
device failure must be before we generate a health warning.
If the ``mgr/devicehealth/self_heal`` option is enabled (it is by
default), then for devices that are expected to fail soon the module
will automatically migrate data away from them by marking the devices
"out".
The ``mgr/devicehealth/mark_out_threshold`` controls how soon an
expected device failure must be before we automatically mark an osd
"out".
The stored life expectancy of all devices can be checked, and any
appropriate health alerts generated, with::
ceph device check-health