diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 18:45:59 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 18:45:59 +0000 |
commit | 19fcec84d8d7d21e796c7624e521b60d28ee21ed (patch) | |
tree | 42d26aa27d1e3f7c0b8bd3fd14e7d7082f5008dc /doc/man/8/cephfs-top.rst | |
parent | Initial commit. (diff) | |
download | ceph-19fcec84d8d7d21e796c7624e521b60d28ee21ed.tar.xz ceph-19fcec84d8d7d21e796c7624e521b60d28ee21ed.zip |
Adding upstream version 16.2.11+ds.upstream/16.2.11+dsupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/8/cephfs-top.rst')
-rw-r--r-- | doc/man/8/cephfs-top.rst | 121 |
1 files changed, 121 insertions, 0 deletions
diff --git a/doc/man/8/cephfs-top.rst b/doc/man/8/cephfs-top.rst new file mode 100644 index 000000000..c3719cd36 --- /dev/null +++ b/doc/man/8/cephfs-top.rst @@ -0,0 +1,121 @@ +:orphan: + +========================================== + cephfs-top -- Ceph Filesystem Top Utility +========================================== + +.. program:: cephfs-top + +Synopsis +======== + +| **cephfs-top** [flags] + + +Description +=========== + +**cephfs-top** provides top(1) like functionality for Ceph Filesystem. +Various client metrics are displayed and updated in realtime. + +Ceph Metadata Servers periodically send client metrics to Ceph Manager. +``Stats`` plugin in Ceph Manager provides an interface to fetch these metrics. + +Options +======= + +.. option:: --cluster + + Cluster: Ceph cluster to connect. Defaults to ``ceph``. + +.. option:: --id + + Id: Client used to connect to Ceph cluster. Defaults to ``fstop``. + +.. option:: --selftest + + Perform a selftest. This mode performs a sanity check of ``stats`` module. + +Descriptions of fields +====================== + +.. describe:: chit + + cap hit rate + +.. describe:: dlease + + dentry lease rate + +.. describe:: ofiles + + number of opened files + +.. describe:: oicaps + + number of pinned caps + +.. describe:: oinodes + + number of opened inodes + +.. describe:: rtio + + total size of read IOs + +.. describe:: wtio + + total size of write IOs + +.. describe:: raio + + average size of read IOs + +.. describe:: waio + + average size of write IOs + +.. describe:: rsp + + speed of read IOs compared with the last refresh + +.. describe:: wsp + + speed of write IOs compared with the last refresh + +.. describe:: rlatavg + + average read latency + +.. describe:: rlatsd + + standard deviation (variance) for read latency + +.. describe:: wlatavg + + average write latency + +.. describe:: wlatsd + + standard deviation (variance) for write latency + +.. describe:: mlatavg + + average metadata latency + +.. describe:: mlatsd + + standard deviation (variance) for metadata latency + +Availability +============ + +**cephfs-top** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at +http://ceph.com/ for more information. + + +See also +======== + +:doc:`ceph <ceph>`\(8), +:doc:`ceph-mds <ceph-mds>`\(8) |