ceph/doc/mgr/crash.rst
Lenz Grimmer c3149421bc doc: Replaced "plugin" with "module" in the Mgr documentation
The documentation currently refers to Ceph Manager Modules as
"plugins" in many places, while the command line interface uses
"module" to enable/disable modules. Replaced all occurences
of "plugin" with "module" in the docs, to avoid confusion and to
be in alignment with the CLI. Also fixed the capitalizations of some
module chapters.

Fixes: https://tracker.ceph.com/issues/38481
Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
2019-02-27 13:49:47 +01:00

61 lines
1.2 KiB
ReStructuredText

Crash Module
============
The crash module 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 module 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 <metafile>
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 <crashid>
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 <crashid>
Show all details of a saved crash.
::
ceph crash prune <keep>
Remove saved crashes older than 'keep' days. <keep> must be an integer.