summaryrefslogtreecommitdiffstats
path: root/doc/mgr/iostat.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 18:45:59 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 18:45:59 +0000
commit19fcec84d8d7d21e796c7624e521b60d28ee21ed (patch)
tree42d26aa27d1e3f7c0b8bd3fd14e7d7082f5008dc /doc/mgr/iostat.rst
parentInitial commit. (diff)
downloadceph-19fcec84d8d7d21e796c7624e521b60d28ee21ed.tar.xz
ceph-19fcec84d8d7d21e796c7624e521b60d28ee21ed.zip
Adding upstream version 16.2.11+ds.upstream/16.2.11+dsupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/mgr/iostat.rst')
-rw-r--r--doc/mgr/iostat.rst32
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/mgr/iostat.rst b/doc/mgr/iostat.rst
new file mode 100644
index 000000000..f9f849383
--- /dev/null
+++ b/doc/mgr/iostat.rst
@@ -0,0 +1,32 @@
+.. _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.