ceph/doc/man/8/cephfs-top.rst
Xiubo Li 0b4807aefb cephfs-top: improve the output
When adding more metrics the top line will be too long and maybe
wrapped with serval lines, which will make it hard to read.

Signed-off-by: Xiubo Li <xiubli@redhat.com>
2021-04-15 16:27:34 +08:00

87 lines
1.5 KiB
ReStructuredText

: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:: rlat
read latency
.. describe:: wlat
write latency
.. describe:: mlat
metadata latency
.. describe:: dlease
dentry lease rate
.. describe:: ofiles
number of opened files
.. describe:: oicaps
number of pinned caps
.. describe:: oinodes
number of opened inodes
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)