This software is provided "as-is" and without warranty of any kind, expressed, implied or otherwise, including and without limitation, any warranty of merchantability or fitness for a particular purpose.
Use this software at your own risk! In no event shall the author be liable for any special, incidental, indirect or consequential damages whatsoever (including, without limitation, damages for loss of profits, business interruption, loss of information, or any other loss), whether or not advised of the possibility of damage, and on any theory of liability, arising out of or in connection with the use or inability to use this software.
Read the whole README before installing the addon!
Extra Graphs is an addon for IPCop ( http://www.ipcop.org/ ). It displays additional traffic graphs. You can plot the traffic on any interface you like, eihter any IPCop interface (red, green, orange, blue) or interfaces from the "Extra Interfaces" addon, ipsecN interfaces from VPN or tunN interfaces from OpenVPN. You can either count the traffic in total or for single ports or a portrange. The traffic can be collected for a single computer or subnet, eihter for all data or split by protocol (tcp, udp, icmp).
The are no requirements for this addon. It should run on all IPCop installations.
After downloading the addon (in the download section, it's a file like "xtgraphs_VERSION.tar.gz") copy it to the IPCop machine.
Unpack the archive with "tar xzf xtgraphs_VERSION.tar.gz".
Go to the folder: "cd xtgraphs_VERSION".
Install with "./install".
After a successful install the folder may be removed.
After the installation there is an extra entry in the "Status" tab called "Extra Graphs":
Click on it and you see the page with the configuration in the upper part and graphs in the lower part.
Here you see the configuration. There are a few sample rules:
The possible actions are:
| A click on the arrows takes you to the corresponding graphs. | |
| Here you can enable/disable the rule. This is relevant only for displaying the graphs. The traffic itself is collected for all created rules. | |
| A click on the yellow pencil shows you an input mask. There you can change the rule. | |
| A click on the red pencil shows you an input mask, where you can add a new rule. The new rule will be inserted at the position you clicked. All rules below will be moved one position down. | |
| This deletes the rule. All data and graphs of this rule will be lost! | |
| Click on the up or down arrow to move the rule in the respective direction. This is useful, because the graphs are shown in the order of the configuration lines. | |
| Click on "Manage categories" to see a new page for manage your categories (as explained further down the page). | |
| Click on "Manage settings" to see a new page to manage the addon's settings (as explained further down the page). |
Upon adding a new rule you will see the following input mask:
| Here you choose the interface. | |
| Here you enter the source computer/subnet. You have to enter the IP with subnet mask as "ip/mask". The mask must be in abbreviated CIDR form (e.g. 24). For a single computer you could write 192.168.1.1/32. If you want to see the traffic between one computer/subnet an the rest of the world, specify 0.0.0.0/0. | |
| Here you can specify ports. This isn't a mandatory setting. You may either input single ports, a port range with port1:port2 or multiple ports seperated with commata (port1,port2,...). | |
| Here you specify the destination interface/IP/ports in analogy to the steps 1-3. | |
| Here you choose the protocol. Either all or tcp, udp, icmp. If you specified ports then you have to choose either tcp or udp. | |
| A description of the rule. It is displayed in the graph. | |
| Here you may choose a predefined category. | |
| "Add entry" creates the rule. | |
| "Abort" aborts the creation of the rule and returns to the main page. |
A newly created rule is activated by default.
A few words on networks and ports: It is possible to negate them with a "!" in front. If you want to measure the total traffic of all but one computer you should write: ! 192.168.1.1/32. If you want to measure all but FTP traffic you should write in the ports field: ! 20:21
The same mask is displayed upon editing a rule:
The fields are preallocated with the old values. The currently edited line is marked with yellow in the configuration overview. After saving the new rule is adopted. Attention: If you change the description or category only, the accumulated data will be kept. If you change the interface, IPs, ports or protocols, then all old data will be deleted! Then you will have to wait up to 5 minutes for the new graphs to be shown!
The graphs look like this:
| Here you see the IPs of the rule incl. the description. | |
| All values once again. | |
| By clicking on a graph you will be displayed graphs for other periods (hour, day, week, month, year). | |
| Here you see a listing of the traffic for the last few days. Click on 'Goto traffic overview' to see a complete listing. | |
| Click "To top" to go to the top of the page. |
In this filter dialog you can specify filter criteria. Only rules which satisfy the criteria are shown. If you don't want to filter for a criterion, don't choose/enter anything.
| Choose a source interface. | |
| Choose a source computer/subnet. | |
| Here you choose the destination interface/IP in analogy to the steps 1-2. | |
| Choose the protocol here. | |
| Choose the category here. | |
| Click on "Apply filter" to show only the rules which satisfy the criteria. | |
| Click on "Show all graphs" to disable the filter. |
If you filter the sample rules above for the source IP (in this case it's a subnet) "10.0.10.0/24", you'll get a screen like this. Only the green-colored rules are shown on the page and thus have clickable jump arrows.
On this page you can see the traffic data for all days and the traffic sum for a selectable period:
| Here you see the IPs of the rule incl. the description. | |
| All values once again. | |
| Here you can choose the first and last day of the period, for which you want to see the traffic data and sum. | |
| Click on "Show period" to see the selected period. | |
| Click on "Show all data" to see the traffic for all days. | |
| Here you see the traffic data for the selected days. | |
| Click on "Back" to go back to the main page. |
On this page you can manage your categories. Categories are useful to group rules together, e.g for filtering them.
| Here you enter the name for a new category. If you edit a category you may change the name here. | |
| Click here to save an added/edited category. | |
| Click here to change the name of a category. The default category "-" can not be changed. | |
| Click here to delete a category. The default category "-" can not be deleted. | |
| Click "Back" to go back to the main page. |
In the column "Category used" you can see how many rules are assigned to a category. If you delete a category, the rules with that category are reset to the default category "-".
On this page you can change some settings of the addon:
| Enable this checkbox to see the filter dialog. This is maybe not necessary if you have only a few rules. | |
| Enable this checkbox to write a log file. This is mainly useful if you have problems running Extra Graphs. | |
| Here you can choose how many days you want to see in the traffic table (on the main page) for each graph. | |
| Enable this checkbox to see debug output in the web interface. This is mainly useful if you have problems running Extra Graphs. | |
| Enable this checkbox to see original traffic graphs, like on the system graphs page. Otherwise you will see nicer graphs (in my opinion). This setting will take effect after the graphs have been recreated (which is done every 5 minutes). | |
| Enable this checkbox to check for updates (once per week). You will see a message announcing a new versions of the addon on the main page. | |
| Click "Save settings" to write the settings to disk. | |
| Click "Back" to go back to the main page. |
Version 0.2.3 - 22.03.2009
Fixed error in traffic overview.
Version 0.2.2 - 26.11.2008
Fix for Opera and IE: rule management didn't work (Thanks to FischerM).
New translation: portuguese (Thanks to Samuel Honorato).
Version 0.2.1 - 25.11.2008
Fixed bug while checking the description (Thanks to Korki).
Fixed bug while checking for new updates.
Version 0.2.0 - 24.11.2008
The rules can be assigned to (user-defined) categories.
Improved rules, part 1: the traffic can now be measured for single ports or port ranges.
Improved rules, part 2: the IPs and ports can also be negated to create complex rules.
The daily traffic sum is saved.
Added a filter to view only selected graphss.
Version 0.1 - 25.09.2007
First version