vdash is a terminal based dashboard for monitoring Safe Nodes on Windows, MacOS and Linux.
Keyboard commands:
’i’ or ‘o’: zoom timeline in or out (’+’ or ‘-’ also work)
Left/Right arrow: cycle between nodes (if following multiple node logfiles)
’q’: quit
Update: vdash v0.7.x updated February 2022
Screenshot shows v0.2.4
Install from crates.io
See the README for more, but assuming you have Rust installed:
cargo install vdash
vdash --help
If you are on Windows you need to clone the repo and build manually, as described in step 2c.
vdash
can be used with MaidSafe and community run test networks and local test networks.
Use with a local test network
Example:
safe node killall
rm -rf ~/.safe/node/*
RUST_LOG=sn_node=trace safe node run-baby-fleming # plus any additional parameters
Notes:
- you must leave logs in text format when starting your node (not JSON)
- you need to make sure no existing nodes are still running, and deleting existing logfiles prevents you picking up statistics from previous activity.
- setting RUST_LOG ensures the logfiles contain the data which
vdash
needs
Then:
vdash ~/.safe/vault/baby-fleming-nodes/*/sn_node.log
For more info see the README which walks you through everything.
With vdash
you’ll see the node logfiles growing (like using tail --follow=name
) and can scroll up and down using the arrow keys. The display only shows one node at a time, but if you passed multiple logfiles to vdash
you can cycle through them using TAB or the left/right arrow keys.
You’ll see the node ages and age-bracket move from ‘Joining’ to ‘Adult’ to ‘Elder’, and if you store some files with the Safe CLI (e.g. safe files put -r <directory>
) eventually the PUTs will show up too. Same for GETs using safe cat
and so on.
Let me know if you have a go and how you get on.
Collaborate (& Learn Rust If you like)
I don’t have much time for code now so happy for people to fork and chip in or take this forward yourself. I’ll help you learn along the way too when I have time.
To start, see how far you can get by forking the repo, building and setting up a development environment if you don’t have one yet. Then let me know what you’ve managed and anything you need help with.
- github: GitHub - happybeing/vdash: Safe Network Vault Dashboard
- vdash chat: https://matrix.to/#/#vdash:matrix.org (once there you can sign-in or sign-up if you aren’t already).