]> git.proxmox.com Git - ceph.git/blame - ceph/doc/rbd/iscsi-monitoring.rst
update sources to v12.2.3
[ceph.git] / ceph / doc / rbd / iscsi-monitoring.rst
CommitLineData
181888fb
FG
1-----------------------------
2Monitoring the iSCSI gateways
3-----------------------------
4
5Ceph provides an additional tool for iSCSI gateway environments
6to monitor performance of exported RADOS Block Device (RBD) images.
7
8The ``gwtop`` tool is a ``top``-like tool that displays aggregated
9performance metrics of RBD images that are exported to clients over
10iSCSI. The metrics are sourced from a Performance Metrics Domain Agent
11(PMDA). Information from the Linux-IO target (LIO) PMDA is used to list
12each exported RBD image with the connected client and its associated I/O
13metrics.
14
15**Requirements:**
16
17- A running Ceph iSCSI gateway
18
19**Installing:**
20
21#. As ``root``, install the ``ceph-iscsi-tools`` package on each iSCSI
22 gateway node:
23
24 ::
25
26 # yum install ceph-iscsi-tools
27
28#. As ``root``, install the performance co-pilot package on each iSCSI
29 gateway node:
30
31 ::
32
33 # yum install pcp
34
35#. As ``root``, install the LIO PMDA package on each iSCSI gateway node:
36
37 ::
38
39 # yum install pcp-pmda-lio
40
41#. As ``root``, enable and start the performance co-pilot service on
42 each iSCSI gateway node:
43
44 ::
45
46 # systemctl enable pmcd
47 # systemctl start pmcd
48
49#. As ``root``, register the ``pcp-pmda-lio`` agent:
50
51 ::
52
53 cd /var/lib/pcp/pmdas/lio
54 ./Install
55
56By default, ``gwtop`` assumes the iSCSI gateway configuration object is
57stored in a RADOS object called ``gateway.conf`` in the ``rbd`` pool.
58This configuration defines the iSCSI gateways to contact for gathering
59the performance statistics. This can be overridden by using either the
60``-g`` or ``-c`` flags. See ``gwtop --help`` for more details.
61
62The LIO configuration determines which type of performance statistics to
63extract from performance co-pilot. When ``gwtop`` starts it looks at the
64LIO configuration, and if it find user-space disks, then ``gwtop``
65selects the LIO collector automatically.
66
67**Example ``gwtop`` Outputs**
68
181888fb
FG
69::
70
71 gwtop 2/2 Gateways CPU% MIN: 4 MAX: 5 Network Total In: 2M Out: 3M 10:20:00
72 Capacity: 8G Disks: 8 IOPS: 503 Clients: 1 Ceph: HEALTH_OK OSDs: 3
73 Pool.Image Src Size iops rMB/s wMB/s Client
74 iscsi.t1703 500M 0 0.00 0.00
75 iscsi.testme1 500M 0 0.00 0.00
76 iscsi.testme2 500M 0 0.00 0.00
77 iscsi.testme3 500M 0 0.00 0.00
78 iscsi.testme5 500M 0 0.00 0.00
79 rbd.myhost_1 T 4G 504 1.95 0.00 rh460p(CON)
80 rbd.test_2 1G 0 0.00 0.00
81 rbd.testme 500M 0 0.00 0.00
82
83In the *Client* column, ``(CON)`` means the iSCSI initiator (client) is
84currently logged into the iSCSI gateway. If ``-multi-`` is displayed,
85then multiple clients are mapped to the single RBD image.