aristocratos/bpytop

ZFS awareness

Open

#78 opened on Aug 21, 2020

View on GitHub
 (7 comments) (12 reactions) (1 assignee)Python (9,714 stars) (393 forks)batch import
enhancementhelp wanted

Description

Is your feature request related to a problem? Please describe. On FreeBSD, top is an extremely useful utility. One of its features is that when ZFS is in use, top displays a summary of ARC statistics.

Describe the solution you'd like It would be nice to be aware of ZFS and provide some ARC stats like top does on FreeBSD. Making the disks panel understand pools and datasets and vdev iostats could be nice, too.

Describe alternatives you've considered I'll just use the standard top for when I need something more utilitarian than pretty.

Additional context

Contributor guide

Tech stack
python
Domain
cliobservability
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ZFS basicsPythonbpytop codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
To implement ZFS awareness, first understand how bpytop currently gathers system statistics (likely via psutil or direct file reads). For ZFS ARC stats on FreeBSD, you'll need to read values from sysctl (e.g., `kstat.zfs.misc.arcstats`) or from procfs (`/proc/spl/kstat/zfs`). Look at the existing disk panel to see how it handles i/o stats and consider adding a similar panel for ZFS pools and datasets. Review the issue comments for any maintainer hints or design discussions. The main source file is likely `bpytop.py` or a module like `disks.py`.