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 .. option:: --conffile [CONFFILE]
  40
  41    Path to cluster configuration file
  42
  43 .. option:: -d [DELAY], --delay [DELAY]
  44
  45    Refresh interval in seconds (default: 1)
  46
  47 .. option:: --dump
  48
  49    Dump the metrics to stdout
  50
  51 .. option:: --dumpfs <fs_name>
  52
  53    Dump the metrics of the given filesystem to stdout
  54
  55 Descriptions of fields
  56 ======================
  57
  58 .. describe:: chit
  59
  60    cap hit rate
  61
  62 .. describe:: dlease
  63
  64    dentry lease rate
  65
  66 .. describe:: ofiles
  67
  68    number of opened files
  69
  70 .. describe:: oicaps
  71
  72    number of pinned caps
  73
  74 .. describe:: oinodes
  75
  76    number of opened inodes
  77
  78 .. describe:: rtio
  79
  80    total size of read IOs
  81
  82 .. describe:: wtio
  83
  84    total size of write IOs
  85
  86 .. describe:: raio
  87
  88    average size of read IOs
  89
  90 .. describe:: waio
  91
  92    average size of write IOs
  93
  94 .. describe:: rsp
  95
  96    speed of read IOs compared with the last refresh
  97
  98 .. describe:: wsp
  99
 100    speed of write IOs compared with the last refresh
 101
 102 .. describe:: rlatavg
 103
 104    average read latency
 105
 106 .. describe:: rlatsd
 107
 108    standard deviation (variance) for read latency
 109
 110 .. describe:: wlatavg
 111
 112    average write latency
 113
 114 .. describe:: wlatsd
 115
 116    standard deviation (variance) for write latency
 117
 118 .. describe:: mlatavg
 119
 120    average metadata latency
 121
 122 .. describe:: mlatsd
 123
 124    standard deviation (variance) for metadata latency
 125
 126 Availability
 127 ============
 128
 129 **cephfs-top** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at
 130 http://ceph.com/ for more information.
 131
 132
 133 See also
 134 ========
 135
 136 :doc:`ceph <ceph>`\(8),
 137 :doc:`ceph-mds <ceph-mds>`\(8)