Using the cephfs-top utility

The Ceph File System (CephFS) provides a top-like utility to display metrics on Ceph File Systems in real-time. The cephfs-top utility is a curses-based Python script that uses the Ceph Manager stats module to fetch and display client performance metrics.

Before you begin

Before using the cephfs-top utility, be sure that you have the following:
  • A healthy and running IBM Storage Ceph cluster.
  • Deployment of a Ceph File System.
  • Root-level access to a Ceph client node.
  • cephfs-top package installed.

About this task

Currently, the cephfs-top utility supports nearly 10,000 clients.
Note: Not all of the performance stats are available in the Red Hat Enterprise Linux 9 kernel.

Procedure

  1. Enable the IBM Storage Ceph 9.9.0 Tools repository: 
    curl https://public.dhe.ibm.com/ibmdl/export/pub/storage/ceph/ibm-storage-ceph-9-rhel-9.repo | sudo tee /etc/yum.repos.d/ibm-storage-ceph-9-rhel-9.repo
  2. Install the cephfs-top package. 
    dnf install cephfs-top
    For example, 
    [root@client ~]# dnf install cephfs-top
  3. Enable the Ceph Manager stats plug-in. 
    ceph mgr module enable stats
    For example, 
    [root@client ~]# ceph mgr module enable stats
  4. Create the client.fstop Ceph user. 
    ceph auth get-or-create client.fstop mon 'allow r' mds 'allow r' osd 'allow r' mgr 'allow r' > /etc/ceph/ceph.client.fstop.keyring
    Note: Optionally, use the --id argument to specify a different Ceph user, other than client.fstop.
  5. Start the cephfs-top utility, by using the cephfs-top command.
    For example: 
    [root@client ~]# cephfs-top
cephfs-top - Thu Oct 20 07:29:35 2022
Total Client(s): 3 - 2 FUSE, 1 kclient, 0 libcephfs
HELP: All filesystem info [Press 'm' to select a filesystem and 'q' to quit]

Filesystem: cephfs01 - 2 client(s)

  client_id mount_root chit(%) dlease(%) ofiles oicaps oinodes rtio(MB) raio(MB) rsp(MB/s) wtio(MB) waio(MB) wsp(MB/s) rlatavg(ms) rlatsd(ms) wlatavg(ms) wlatsd(ms) mlatavg(ms) mlatsd(ms) mount_point@host/addr
  4880     /          100.00   0.0          0      1    0       0.0      0.0      0.0        0.0     0.00     0.0       0.0         0.0        0.0          0.0        0.27         0.0       /mnt/cephfs@example/127.0.0.1
  4885     /          100.00   0.0          0      1    0       0.0      0.0      0.0        0.0     0.00     0.0       0.0         0.0        0.0          0.0        0.35         0.0        N/A@cephfs@example/127.0.0.1

Filesystem: cephfs02 - 2 client(s)

  client_id mount_root chit(%) dlease(%) ofiles oicaps oinodes rtio(MB) raio(MB) rsp(MB/s) wtio(MB) waio(MB) wsp(MB/s) rlatavg(ms) rlatsd(ms) wlatavg(ms) wlatsd(ms) mlatavg(ms) mlatsd(ms) mount_point@host/addr
  4889     /          100.0   0.0           0      1      0       0.0      0.0      0.0           0.0      0.0      0.0       0.0         0.0        0.0         0.0        0.45        0.0        /mnt/cephfs@example/127.0.0.1