Skip to content

About

A lightweight sFlow analyzer for VyOS . Dual TUI/ WebUI.deployed in 30 seconds.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

vyos-sflow logo

vyos-sflow

See your vyos router's traffic in a browser: traffic trends, Top IPs, ports and protocols, with 48 hours of local history powered by DuckDB™.

Get started in 3 steps

1. Enable sFlow on your router

Connect to the router over SSH. Replace eth0 with the interface you want to monitor and ROUTER_IP with that interface's IPv4 address. You can find the address with ip -4 addr show dev eth0.

configure
set system sflow interface eth0
set system sflow agent-address ROUTER_IP
set system sflow sampling-rate 1000
set system sflow polling 30
set system sflow server 127.0.0.1 port 6343
commit
save
exit

These are VyOS sFlow configuration commands. They enable sampling on the selected interface and send samples to the analyzer on this router.

2. Download and run

In a writable directory on the router:

curl -fLO https://github.com/githubflyideas/vyos-sflow/releases/download/v1.0.0/vyos-sflow-1.0.0-linux-amd64.tar.gz &&
curl -fLO https://github.com/githubflyideas/vyos-sflow/releases/download/v1.0.0/SHA256SUMS &&
sha256sum --ignore-missing -c SHA256SUMS &&
tar -xzf vyos-sflow-1.0.0-linux-amd64.tar.gz &&
cd vyos-sflow-1.0.0-linux-amd64

Replace ROUTER_IP with the agent address from step 1, then start:

./vyos-sflow serve -data ./data -agent ROUTER_IP -sub-agent 100000

Keep this terminal open; press Ctrl+C to stop. History and accounts stay in ./data; reuse the same directory when restarting. 100000 is the native VyOS flow sub-agent tested with v1.0.0; other exporters may differ.

3. Open the dashboard

On your computer, open http://ROUTER_IP:8066 using a reachable router address.

  • Username: admin
  • Initial password: tryvyossflow66
  • Change the password when prompted, then open Overview or Top.

Use the monitored interface normally. Charts populate when sampled traffic arrives. Sources shows whether samples are being received. The latest 48 hours are retained automatically; the interface supports 15 languages.

Keep it private: Web TCP 8066 and sFlow UDP 6343 listen on all interfaces by default. Restrict them to trusted networks before logging in. HTTP is unencrypted; optional TLS configuration is in the installation guide.

Optional installation and help

No data? Check the agent IP/sub-agent ID in Sources, exporter settings and UDP port 6343. Check the running terminal for errors.

Want automatic startup? Install as a service. Otherwise, keep running the executable directly.

Configuration · User manual · Compatibility and validation

License and DuckDB trademark

Apache License 2.0 — see LICENSE. Third-party licenses and notices are listed in THIRD_PARTY_NOTICES.md.

DuckDB is a trademark of the DuckDB Foundation. This project uses DuckDB as its embedded database. It is not an official DuckDB product and is not affiliated with, sponsored by or endorsed by the DuckDB Foundation. DuckDB is distributed under the MIT license; software licenses do not grant rights to DuckDB trademarks or logos.

About

A lightweight sFlow analyzer for VyOS . Dual TUI/ WebUI.deployed in 30 seconds.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages