summaryrefslogtreecommitdiffstats
path: root/doc/man/8/cephfs-top.rst
blob: fd18ada77ae06bb5a01bda3849179a04b6c8f33d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
: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.

.. option:: --conffile [CONFFILE]

   Path to cluster configuration file

.. option:: -d [DELAY], --delay [DELAY]

   Refresh interval in seconds (default: 1)

.. option:: --dump

   Dump the metrics to stdout

.. option:: --dumpfs <fs_name>

   Dump the metrics of the given filesystem to stdout

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)