]>
Commit | Line | Data |
---|---|---|
f67539c2 TL |
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 | ||
b3b6e05e TL |
39 | Descriptions of fields |
40 | ====================== | |
41 | ||
42 | .. describe:: chit | |
43 | ||
44 | cap hit rate | |
45 | ||
46 | .. describe:: rlat | |
47 | ||
48 | read latency | |
49 | ||
50 | .. describe:: wlat | |
51 | ||
52 | write latency | |
53 | ||
54 | .. describe:: mlat | |
55 | ||
56 | metadata latency | |
57 | ||
58 | .. describe:: dlease | |
59 | ||
60 | dentry lease rate | |
61 | ||
62 | .. describe:: ofiles | |
63 | ||
64 | number of opened files | |
65 | ||
66 | .. describe:: oicaps | |
67 | ||
68 | number of pinned caps | |
69 | ||
70 | .. describe:: oinodes | |
71 | ||
72 | number of opened inodes | |
73 | ||
a4b75251 TL |
74 | .. describe:: rtio |
75 | ||
76 | total size of read IOs | |
77 | ||
78 | .. describe:: wtio | |
79 | ||
80 | total size of write IOs | |
81 | ||
82 | .. describe:: raio | |
83 | ||
84 | average size of read IOs | |
85 | ||
86 | .. describe:: waio | |
87 | ||
88 | average size of write IOs | |
89 | ||
90 | .. describe:: rsp | |
91 | ||
92 | speed of read IOs compared with the last refresh | |
93 | ||
94 | .. describe:: wsp | |
95 | ||
96 | speed of write IOs compared with the last refresh | |
97 | ||
b3b6e05e | 98 | |
f67539c2 TL |
99 | Availability |
100 | ============ | |
101 | ||
102 | **cephfs-top** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at | |
103 | http://ceph.com/ for more information. | |
104 | ||
105 | ||
106 | See also | |
107 | ======== | |
108 | ||
109 | :doc:`ceph <ceph>`\(8), | |
110 | :doc:`ceph-mds <ceph-mds>`\(8) |