vdash is a terminal dashboard for a local Safe Vault and I’m looking for suggestions from all you prospective farmers. What would you like it to show?
The code is a fork of my learning Rust project (logtail) and uses the vault logfile to obtain metrics about the vault and the network. It uses the terminal to display this information using text and relatively crude graphics. The graphs will be a little crude but you can see the kind of thing it can do in this demo of tui-rs.
The current layout is shown below, but what I’d like are suggestions for what to show in each area: Status / Graphs and Timeline.
The following is a summary of contributions people have made to this topic, and some thoughts on the direction and priorities arising from that. Feel free to comment on this as well.
Status & Metrics:
Vault name [local; network]
Traffic up /down by period (maybe steps up to logarithm to accommodate length)
Network connection info - who are the peers as a list or the number of them cf torrent detail
System info - cpu [type / %average]; mem [max / %average]
Change events; so, a note if there is a change of section
If network lost, then a summary of totals… and if reconnect becomes possible, then %uptime or some suggestion of the loss
Disk space used
What age we are
How many chunks of various kinds do we have
Current clients connected
Current vaults connected
Pending locked earnings
Changes in the consensus for PUT/SAFE price, or at least the sectional view of it
Colormap of chunks stored in the vault based on different criteria… (more)
A “vault map” of your local neighborhood or section… (more)
Questions Users Want Answered:
- RPC Vault I/F proposal includes metrics and relevant discussion, by @mav (on github: RFC, discussion).
- quick reference (e.g. widget) (@mav, here)
- temporal signals (cf. “the history and what might pick up on might be interesting in having a handle on where and how a vault sits in the network… is that stable within a group or forever changing… too much change might suggest problems…” - @davidpbrown here)
Your contributions are very helpful and lead me to identify four overall functions to provide in the short term:
- A Show: impressive, shows key features, something people like to share.
- Education: about running a vault and more generally about Safe
- Problem Indications: anything that needs short term attention
- State and Progress: summary of current status and change over time
- Tuning Metrics: more detailed signals that can be used to optimise performance and resources
Why will people run a vault?
- to earn Safecoin (for profit or utility)
- to support the project (values based)
Who is this for and what do we think they will want?
The priority for the vdash project is to help individuals running a single vault or maybe a handful on one machine or multiple machines. Short term it’s easy for me to support multiple vaults on a single machine but I’d like to be able to support monitoring remote vaults, and think this should be possible (either by fetching their logfiles, using RPC as @mav has suggested, or some combination).