diff options
Diffstat (limited to 'doc/mgr/iostat.rst')
| -rw-r--r-- | doc/mgr/iostat.rst | 32 |
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. |