From: Mohamad Gebai Date: Wed, 16 May 2018 14:42:22 +0000 (-0400) Subject: doc: add documentation for iostat X-Git-Tag: v14.0.0~24^2~1 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=1e2bf1ec8c0dbe18b816ff9eb3243b73bb40d237;p=ceph.git doc: add documentation for iostat Signed-off-by: Mohamad Gebai --- diff --git a/doc/mgr/index.rst b/doc/mgr/index.rst index 21a8f800e21..28a1d8e97fb 100644 --- a/doc/mgr/index.rst +++ b/doc/mgr/index.rst @@ -37,3 +37,4 @@ sensible. Hello plugin Telegraf plugin Telemetry plugin + Iostat plugin diff --git a/doc/mgr/iostat.rst b/doc/mgr/iostat.rst new file mode 100644 index 00000000000..521c0bd7ace --- /dev/null +++ b/doc/mgr/iostat.rst @@ -0,0 +1,32 @@ +.. _mgr-iostat-overview: + +iostat +====== + +This plugin 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 + +For example, use the following command to print the statistics every 5 seconds:: + + ceph iostat -p 5 + +To stop the module, press Ctrl-C. diff --git a/doc/releases/mimic.rst b/doc/releases/mimic.rst index 9cec79be122..4ffbb336003 100644 --- a/doc/releases/mimic.rst +++ b/doc/releases/mimic.rst @@ -388,6 +388,11 @@ These changes occurred between the Luminous and Mimic releases. via a "pass through" method. See http://docs.ceph.com/docs/master/mgr/restful for details. + - New command to track throughput and IOPS statistics, also available in + ``ceph -s`` and previously in ``ceph -w``. To use this command, enable + the ``iostat`` Manager module and invoke it using ``ceph iostat``. See the + :ref:`iostat documentation ` for details. + * *build/packaging* - The ``rcceph`` script (``systemd/ceph`` in the source code tree, shipped as