ceph/doc/mgr/iostat.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

33 lines
582 B
ReStructuredText

.. _mgr-iostat-overview:
iostat
======
This module shows the current throughput and IOPS done on the Ceph cluster.
Enabling
--------
To check if the *iostat* module is enabled, run::
ceph mgr module ls
The module can be enabled with::
ceph mgr module enable iostat
To execute the module, run::
ceph iostat
To change the frequency at which the statistics are printed, use the ``-p``
option::
ceph iostat -p <period in seconds>
For example, use the following command to print the statistics every 5 seconds::
ceph iostat -p 5
To stop the module, press Ctrl-C.