Version 1.1 with conntrack-tools support
[bwmon.git] / README
blobba0a1b6d3c1258a3dca7ccacfb71ce9ea281dd92
2                  bwmon: Application-level bandwidth monitoring
3                  ---------------------------------------------
5  bwmon is an open bandwidth monitoring solution for monitoring per-application
6  bandwidth usage. This can be utilized to better manage and monitor multiple
7  applications running on a single cloud host or a single application running
8  on multiple cloud hosts.
10  -- Features --
12    * Uses ip_conntrack to track connections
13    * Alternative, cross-platform "pipe" traffic monitor
14    * Easily customizable: Written in Python
15    * Combination of conntrack+pipe monitors possible
16    * Open Framework: Create new monitoring methods
17    * Support for SLA parameter input (bandwidth allocation)
18    * Support for SLA violation notification to external services
19    * Fully documented source code and user manual
21  -- News --
23    November 2012 (Version 1.1):
24    In recent kernels, there's no "ip_conntrack" kernel module. As
25    a replacement, bwmon now supports the "conntrack" command-line
26    utility from the "conntrack-utils" package.
28    Make sure to run this command to enable accounting for conntrack
29    (otherwise you might get a "KeyError: 'bytes'" traceback):
31        sysctl -w net.netfilter.nf_conntrack_acct=1
33    Sometimes you have to wait a bit after setting this option to
34    make sure old connections are removed from conntrack's output.
36    Related netfilter mailing list thread:
38        http://marc.info/?t=135194346800001&r=1&w=2
41  -- More information --
43  Web: http://thp.io/2010/bwmon/
44  Git: http://repo.or.cz/w/bwmon.git