From b693af6b495cb6e8698df2edb92f5014e4187f49 Mon Sep 17 00:00:00 2001 From: Noah Watkins Date: Tue, 21 Aug 2018 16:48:19 -0700 Subject: [PATCH] doc: clarify use of insights health pruning Signed-off-by: Noah Watkins --- doc/mgr/insights.rst | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/doc/mgr/insights.rst b/doc/mgr/insights.rst index 74617b99895f8..b66de3de4e6fc 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 -- 2.39.5