ceph/doc/man/8/cephfs-top.rst

   1 :orphan:
   2
   3 ==========================================
   4  cephfs-top -- Ceph Filesystem Top Utility
   5 ==========================================
   6
   7 .. program:: cephfs-top
   8
   9 Synopsis
  10 ========
  11
  12 | **cephfs-top** [flags]
  13
  14
  15 Description
  16 ===========
  17
  18 **cephfs-top** provides top(1) like functionality for Ceph Filesystem.
  19 Various client metrics are displayed and updated in realtime.
  20
  21 Ceph Metadata Servers periodically send client metrics to Ceph Manager.
  22 ``Stats`` plugin in Ceph Manager provides an interface to fetch these metrics.
  23
  24 Options
  25 =======
  26
  27 .. option:: --cluster
  28
  29    Cluster: Ceph cluster to connect. Defaults to ``ceph``.
  30
  31 .. option:: --id
  32
  33    Id: Client used to connect to Ceph cluster. Defaults to ``fstop``.
  34
  35 .. option:: --selftest
  36
  37    Perform a selftest. This mode performs a sanity check of ``stats`` module.
  38
  39 Availability
  40 ============
  41
  42 **cephfs-top** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at
  43 http://ceph.com/ for more information.
  44
  45
  46 See also
  47 ========
  48
  49 :doc:`ceph <ceph>`\(8),
  50 :doc:`ceph-mds <ceph-mds>`\(8)