iftop

2.0.1 • Public • Published

iftop

Use the power and speed of iftop to get flow rates and totals of traffic incident on a network device.

Note that the user running this process will need capture permissions on the specified device.

Examples of how this is typically done:

linux:

sudo setcap cap_net_raw,cap_net_admin=eip /usr/sbin/iftop

macOS:

sudo chmod +r /dev/bpf*

Usage

var IftopParser = require('iftop');
 
IftopParser.iftopPath = "/usr/sbin/iftop"; // only if iftop is not on the path
 
var iftop = new IftopParser("eth0");
 
# set up error handler
iftop.on('error', (e) => {
    console.error(e);
});
 
# set up data handler
iftop.on('data', (d) => {
    console.log(d);
});
 
iftop.start();
 
# optional manipulations after start() has been called (these are passed to iftop)
iftop.toggleAggregateSrc();
iftop.toggleAggregateDst();
iftop.toggleDNSResolution();
iftop.togglePortDisplay();
 

License

ISC

Dependencies (2)

Dev Dependencies (0)

    Package Sidebar

    Install

    npm i iftop

    Weekly Downloads

    5

    Version

    2.0.1

    License

    ISC

    Last publish

    Collaborators

    • msmiley