brbsix / hogwatch Goto Github PK

#####A bandwidth monitor that shows per process network transfer(Alpha)

I built this project for my college assignment. It's my first python project/package for that matter. I am really overwhelmed by the response, however the application is still in early stages.

Here are some things that need to be fixed/added for eg.

• fix some bugs on frontend
  • sort on transfer_amount instead
  • fix error #15 on switching charts
• kill nethogs process on exit ( when using window mode the server thread daemon is not killed on main thread exit)
• filter by device such as wlan,eth0 (frontend ui)
• show more details such as pid,user with improved ui (possible for linux)
• store history for restarts
• proper packaging
• unit tests

######Screenshots

####Requirements:

• nethogs (0.8.2 +) make sure its available in your path. This tool provides all the information and is quick to use from cli. Hogwatch gui plots graphs from this data over time.
• python 2.7

####Install

• pip install hogwatch --upgrade

update: The package requires a pip module called pywebview for opening a webview window directly. It sometimes doesn't display output as it would on a web browser such as chrome, moreover installing it requires some additional packages on some systems as reported by users. see issue #6 and #4

####Running As hogwatch runs a light web server. you can view using either

1. Standalone (webview): sudo hogwatch sudo is needed for nethogs. Its a bad idea to run the whole process as root. need to fix this. update: this mode is not recommended for now. wait for issue#7

2. Web browser: sudo hogwatch server view at localhost:6432 default port. for custom port specify port egsudo hogwatch server 8010. You can see this output from other devices on the network by specifying ip in place of localhost.

3. Menubar: currently experimental. head to the menubar folder for instructions

#####Usage The list contains the process names. Initially none of the processes is selected and global(accumulated) transfer rate/amount are displayed in the ui. Upon clicking one of the processes from the list, the metrics belonging to that process only will be shown. clicking on it again will toggle it off and will switch to global metrics once again.

note: on osx, currently only connections are shown and are yet to be mapped to the process.

Toggles on the top right: - play/pause button stops updating the graph so you may scroll it sideways without it jumping to the end with each update. In future it will also pause list transition for easier selection. - 5m,30m etc. are graph range selectors and determine the range window for the graph. For eg. if 5m is selected then the graph is scaled to show the latest 5 minute stats (pause and scroll for navigating history). "[ ]" button makes the range over the entire duration of the program.

####installation/run: (Development)

• git clone https://github.com/akshayKMR/hogwatch.git
• cd hogwatch
• optional: for only server mode. remove pywebview from requirements.txt and comment it from setup.py
• pip install -r requirements.txt --upgrade
• python setup.py install
• run with sudo ./bin/hogwatch wait for issue#7
• optional sudo ./bin/hogwatch server for only server accessible at localhost:6432

All are welcome to fork and contribute.

####Contributing Hogwatch uses a light python webserver(bottle) feeding nethogs trace mode output to the frontend (Vue.js) using websockets. You can contribute in Python/C++/Javascript.

####License Copyright Akshay Kumar [email protected]
MIT