doc: add description of metric fields for cephfs-top

Fixes: https://tracker.ceph.com/issues/63991
Signed-off-by: Neeraj Pratap Singh <neesingh@redhat.com>
(cherry picked from commit 956f644f86c0790c17976b98df112747d66837df)

diff --git a/doc/cephfs/cephfs-top.rst b/doc/cephfs/cephfs-top.rst
index 49439a4bd18bbed75659a627d84c98b5cd9e0fce..1588c4f5ced7ef365eb26012e4bf03c4156f22dd 100644 (file)
--- a/doc/cephfs/cephfs-top.rst
+++ b/doc/cephfs/cephfs-top.rst
@@ -63,6 +63,62 @@ By default, `cephfs-top` uses `client.fstop` user to connect to a Ceph cluster::
   $ ceph auth get-or-create client.fstop mon 'allow r' mds 'allow r' osd 'allow r' mgr 'allow r'
   $ cephfs-top
 
+Description of Fields
+---------------------
+
+1. chit     : Cap hit
+             Percentage of file capability hits over total number of caps
+
+2. dlease   : Dentry lease
+             Percentage of dentry leases handed out over the total dentry lease requests
+
+3. ofiles   : Opened files
+             Number of opened files
+
+4. oicaps   : Pinned caps
+             Number of pinned caps
+
+5. oinodes  : Opened inodes
+             Number of opened inodes
+
+6. rtio     : Total size of read IOs
+             Number of bytes read in input/output operations generated by all process
+
+7. wtio     : Total size of write IOs
+             Number of bytes written in input/output operations generated by all processes
+
+8. raio     : Average size of read IOs
+             Mean of number of bytes read in input/output operations generated by all 
+             process over total IO done
+
+9. waio     : Average size of write IOs
+             Mean of number of bytes written in input/output operations generated by all 
+             process over total IO done
+
+10. rsp     : Read speed
+             Speed of read IOs with respect to the duration since the last refresh of clients
+
+11. wsp     : Write speed 
+             Speed of write IOs with respect to the duration since the last refresh of clients
+
+12. rlatavg : Average read latency
+             Mean value of the read latencies
+
+13. rlatsd  : Standard deviation (variance) for read latency
+             Dispersion of the metric for the read latency relative to its mean
+
+14. wlatavg : Average write latency
+             Mean value of the write latencies
+
+15. wlatsd  : Standard deviation (variance) for write latency
+             Dispersion of the metric for the write latency relative to its mean
+
+16. mlatavg : Average metadata latency
+             Mean value of the metadata latencies
+
+17. mlatsd  : Standard deviation (variance) for metadata latency
+             Dispersion of the metric for the metadata latency relative to its mean
+
 Command-Line Options
 --------------------