doc: add documentation for iostat

Signed-off-by: Mohamad Gebai <mgebai@suse.com>

diff --git a/doc/mgr/index.rst b/doc/mgr/index.rst
index 21a8f800e21db2af7ea7d6267c8c038047af5a19..28a1d8e97fbc35e556e10091980a8d1a62250d75 100644 (file)
--- a/doc/mgr/index.rst
+++ b/doc/mgr/index.rst
@@ -37,3 +37,4 @@ sensible.
     Hello plugin <hello>
     Telegraf plugin <telegraf>
     Telemetry plugin <telemetry>
+    Iostat plugin <iostat>

diff --git a/doc/mgr/iostat.rst b/doc/mgr/iostat.rst
new file mode 100644 (file)
index 0000000..521c0bd
--- /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 <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.

diff --git a/doc/releases/mimic.rst b/doc/releases/mimic.rst
index 9cec79be122e507d2384175703f448c4ef810cc3..4ffbb336003d1830000d8252b6e6ee8b13992bf9 100644 (file)
--- 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 <mgr-iostat-overview>` for details.
+
 * *build/packaging*
 
   - The ``rcceph`` script (``systemd/ceph`` in the source code tree, shipped as