.. _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.