From: Noah Watkins Date: Tue, 21 Aug 2018 23:48:19 +0000 (-0700) Subject: doc: clarify use of insights health pruning X-Git-Tag: v14.0.1~336^2~2 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=b693af6b495cb6e8698df2edb92f5014e4187f49;p=ceph.git doc: clarify use of insights health pruning Signed-off-by: Noah Watkins --- diff --git a/doc/mgr/insights.rst b/doc/mgr/insights.rst index 74617b99895f..b66de3de4e6f 100644 --- a/doc/mgr/insights.rst +++ b/doc/mgr/insights.rst @@ -39,10 +39,14 @@ Generate the full report. ceph insights prune-health -Remove historical health data collected within the last . Passing in `0` -for will clear all health data. This command is useful for removing -health checks that have been recently resolved but which remain in the report. -There is no need to prune health data to reclaim space; pruning occurs -automatically each hour removing old health data from persistent storage. +Remove historical health data older than . Passing `0` for will +clear all health data. + +This command is useful for cleaning the health history before automated nightly +reports are generated, which may contain spurious health checks accumulated +while performing system maintenance, or other health checks that have been +resolved. There is no need to prune health data to reclaim storage space; +garbage collection is performed regularly to remove old health data from +persistent storage. .. _crash module: ../crash