]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: add documentation for iostat
authorMohamad Gebai <mgebai@suse.com>
Wed, 16 May 2018 14:42:22 +0000 (10:42 -0400)
committerMohamad Gebai <mgebai@suse.com>
Fri, 25 May 2018 04:50:00 +0000 (00:50 -0400)
Conflicts:
        doc/releases/mimic.rst: remove file
        doc/mgr/index.rst: trivial resolution

Signed-off-by: Mohamad Gebai <mgebai@suse.com>
(cherry picked from commit 1e2bf1ec8c0dbe18b816ff9eb3243b73bb40d237)

doc/mgr/index.rst
doc/mgr/iostat.rst [new file with mode: 0644]

index a4f33fd867e48d095ebab1be1b1d7079c6957283..d8440cb8e6a3dc659a1d6bb0c64b799fec68f8b2 100644 (file)
@@ -37,3 +37,4 @@ sensible.
     Hello plugin <hello>
     Telemetry plugin <telemetry>
     Telegraf plugin <telegraf>
+    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
@@ -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.