From eb1103e94d0cf6754d077eb64b7f7b94bd684e98 Mon Sep 17 00:00:00 2001 From: Dan Mick Date: Wed, 27 Jun 2018 15:14:08 -0700 Subject: [PATCH] doc/mgr: add doc for crash mgr module Signed-off-by: Dan Mick --- doc/mgr/crash.rst | 60 +++++++++++++++++++++++++++++++++++++++++++++++ doc/mgr/index.rst | 1 + 2 files changed, 61 insertions(+) create mode 100644 doc/mgr/crash.rst diff --git a/doc/mgr/crash.rst b/doc/mgr/crash.rst new file mode 100644 index 0000000000000..5639f32ebb2b9 --- /dev/null +++ b/doc/mgr/crash.rst @@ -0,0 +1,60 @@ +Crash plugin +============ +The crash plugin collects information about daemon crashdumps and stores +it in the Ceph cluster for later analysis. + +Daemon crashdumps are dumped in /var/lib/ceph/crash by default; this can +be configured with the option 'crash dir'. Crash directories are named by +time and date and a randomly-generated UUID, and contain a metadata file +'meta' and a recent log file, with a "crash_id" that is the same. +This plugin allows the metadata about those dumps to be persisted in +the monitors' storage. + +Enabling +-------- + +The *crash* module is enabled with:: + + ceph mgr module enable crash + +Commands +-------- +:: + + ceph crash post -i + +Save a crash dump. The metadata file is a JSON blob stored in the crash +dir as ``meta``. As usual, the ceph command can be invoked with ``-i -``, +and will read from stdin. + +:: + + ceph rm + +Remove a specific crash dump. + +:: + + ceph crash ls + +List the timestamp/uuid crashids for all saved crash info. + +:: + + ceph crash stat + +Show a summary of saved crash info grouped by age. + +:: + + ceph crash info + +Show all details of a saved crash. + +:: + + ceph crash prune + +Remove saved crashes older than 'keep' days. must be an integer. + + diff --git a/doc/mgr/index.rst b/doc/mgr/index.rst index 28a1d8e97fbc3..ea8c9d48ca1bf 100644 --- a/doc/mgr/index.rst +++ b/doc/mgr/index.rst @@ -38,3 +38,4 @@ sensible. Telegraf plugin Telemetry plugin Iostat plugin + Crash plugin -- 2.39.5