From 77b68c5fd98b8d8ad066d948375f5e3317f7349e Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Thu, 22 May 2025 16:48:49 +1000 Subject: [PATCH] doc/mgr: edit iostat.rst Edit doc/mgr/iostat.rst. Improve the English where necessary. This is part of a project to separate out the twenty-five files that were committed to https://github.com/ceph/ceph/pull/62782. Signed-off-by: Zac Dover (cherry picked from commit 98708a7f7f3c470758063e21e840393440450381) --- doc/mgr/iostat.rst | 37 +++++++++++++++++++++++++------------ 1 file changed, 25 insertions(+), 12 deletions(-) diff --git a/doc/mgr/iostat.rst b/doc/mgr/iostat.rst index f9f8493831bca..ff24f1758604e 100644 --- a/doc/mgr/iostat.rst +++ b/doc/mgr/iostat.rst @@ -3,30 +3,43 @@ iostat ====== -This module shows the current throughput and IOPS done on the Ceph cluster. +The ``iostat`` module shows the current throughput and IOPS done on the Ceph +cluster. Enabling -------- -To check if the *iostat* module is enabled, run:: +To determine whether the ``iostat`` module is enabled, run the following +command: - ceph mgr module ls +.. prompt:: bash # -The module can be enabled with:: + ceph mgr module ls - ceph mgr module enable iostat +To enable the ``iostat`` module, run the following command: -To execute the module, run:: +.. prompt:: bash # - ceph iostat + ceph mgr module enable iostat + +To execute the module, run the following command: + +.. prompt:: bash # + + ceph iostat To change the frequency at which the statistics are printed, use the ``-p`` -option:: +option: + +.. prompt:: bash # + + ceph iostat -p - ceph iostat -p +For example, use the following command to print the statistics every 5 +seconds: -For example, use the following command to print the statistics every 5 seconds:: +.. prompt:: bash # - ceph iostat -p 5 + ceph iostat -p 5 -To stop the module, press Ctrl-C. +To stop the module, press ``Ctrl-C``. -- 2.39.5