From 226bfe7477eb861d8028c807a2d65f7110961e8c Mon Sep 17 00:00:00 2001 From: Noah Watkins Date: Thu, 9 Aug 2018 12:44:42 -0700 Subject: [PATCH] doc: add insights module documentation Signed-off-by: Noah Watkins --- doc/mgr/index.rst | 1 + doc/mgr/insights.rst | 48 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+) create mode 100644 doc/mgr/insights.rst diff --git a/doc/mgr/index.rst b/doc/mgr/index.rst index e00c0381a052b..ed107595444d7 100644 --- a/doc/mgr/index.rst +++ b/doc/mgr/index.rst @@ -43,3 +43,4 @@ sensible. Devicehealth plugin Orchestrator CLI plugin Rook plugin + Insights plugin diff --git a/doc/mgr/insights.rst b/doc/mgr/insights.rst new file mode 100644 index 0000000000000..74617b99895f8 --- /dev/null +++ b/doc/mgr/insights.rst @@ -0,0 +1,48 @@ +Insights plugin +=============== + +The insights plugin collects and exposes system information to the Insights Core +data analysis framework. It is intended to replace explicit interrogation of +Ceph CLIs and daemon admin sockets, reducing the API surface that Insights +depends on. The insights reports contains the following: + +* **Health reports**. In addition to reporting the current health of the + cluster, the insights module reports a summary of the last 24 hours of health + checks. This feature is important for catching cluster health issues that are + transient and may not be present at the moment the report is generated. Health + checks are deduplicated to avoid unbounded data growth. + +* **Crash reports**. A summary of any daemon crashes in the past 24 hours is + included in the insights report. Crashes are reported as the number of crashes + per daemon type (e.g. `ceph-osd`) within the time window. Full details of a + crash may be obtained using the `crash module`_. + +* Software version, storage utilization, cluster maps, placement group summary, + monitor status, cluster configuration, and OSD metadata. + +Enabling +-------- + +The *insights* module is enabled with:: + + ceph mgr module enable insights + +Commands +-------- +:: + + ceph insights + +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. + +.. _crash module: ../crash -- 2.39.5