ceph/doc/mgr/iostat.rst

   1 .. _mgr-iostat-overview:
   2
   3 iostat
   4 ======
   5
   6 This module shows the current throughput and IOPS done on the Ceph cluster.
   7
   8 Enabling
   9 --------
  10
  11 To check if the *iostat* module is enabled, run::
  12
  13   ceph mgr module ls
  14
  15 The module can be enabled with::
  16
  17   ceph mgr module enable iostat
  18
  19 To execute the module, run::
  20
  21   ceph iostat
  22
  23 To change the frequency at which the statistics are printed, use the ``-p``
  24 option::
  25
  26   ceph iostat -p <period in seconds>
  27
  28 For example, use the following command to print the statistics every 5 seconds::
  29
  30   ceph iostat -p 5
  31
  32 To stop the module, press Ctrl-C.