netmap |
Subversion Repositories: |
[/] [doc/] [index.html] - Rev 1
Compare with Previous -
Blame
- Download
<html>
<title>CaLStats documentation</title>
<body>
<font face="Verdana, Arial, Helvetica" color="#000000" size="2">
<font size="+1"><b>CaLStats documentation</b></font><br>
Computer and Links Statistics<br>
<br>
<img src="test1.png" border="0" width="500" height="230" alt="Example - Test1">
<img src="calstats_help1.png" border="0" width="298" height="244" alt="Image description"><br>
<br>
<hr size="1">
<font size="3"><b>Basic information</b></font><br>
First of all check out CaLStats homepage if there is newer version available:<br>
<a href="http://www.mobilnews.cz/honza/en_prog_linux_calstats.php">http://www.mobilnews.cz/honza/en_prog_linux_calstats.php</a><br>
<br>
Every site stat consist of three to five files. So our testing example will consist of those files:<br>
<a href="#config">test1.config</a> - configuration file<br>
<a href="#comp">test1.comp</a> - list of computers<br>
<a href="#link">test1.link</a> - list of links between computers (optional)<br>
<a href="#legend">test1.legend</a> - legend (optional)<br>
<a href="#state">test1.state</a> - actual state of computers (generated by CaLStats)<br>
<br>
You need to create <i>.config</i> and <i>.comp</i> files for every site stat. You can
place as many sites as you want into data directory. Then just run <i>gen_stats</i> and stats will
be gererated. If you want up to date stats, insert <i>gen_stats</i> into cron daemon (for example every
5-10 minutes).<br>
<br>
<hr size="1">
<font size="3"><b>Installation</b></font><br>
<br>
<b>These programs must be available in the system:</b> awk, PHP (with GD library)<br>
<ul>
<li>unpack the archive</li>
<li>move calstats directory to /usr/local (or somewhere you want to use it in)</li>
<li>change path, directories and configuration in 'gen_stats'</li>
<li>if you have fping installed change STATS_TYPE from 'ping' to 'fping' (<a href="http://www.fping.com">www.fping.com</a>) for faster stats generation</li>
<li>if you have nmap installed change STATS_TYPE from 'ping' to 'nmap' (<a href="http://www.insecure.org/nmap/">www.insecure.org/nmap/</a>) for faster stats generation</li>
<li>run 'gen_stats' to test the configuration</li>
<li>edit 'data/*' files to match your configuration (sample files are included)</li>
<li>add 'gen_stats' to cron if you want to generate statistics periodically</li>
</ul>
Packet latency information is supported only if you are using <i>ping</i> or <i>fping</i>.<br>
<br>
<hr size="1">
<a name="config">
<font size="3"><b>*.config files</b></font><br>
title;x_size;y_size;legend_location;border;background_color;<br>
<br>
<b>legend_location:</b><br>
0 ... no legend<br>
1 ... top left<br>
2 ... top right<br>
3 ... bottom left<br>
4 ... bottom right<br>
<br>
<b>border:</b><br>
0 ... off<br>
1 ... on<br>
<br>
You can leave background_color field blank if you want white background.<br>
<br>
<font face="Verdana, Arial, Helvetica" color="#000000" size="1">
<b><i>Example - test1.config</i></b><br>
Test1;500;230;3;1;FFFFFF;<br>
</font>
<br>
<hr size="1">
<a name="comp">
<font size="3"><b>*.comp files</b></font><br>
computer_name;ip_address;computer_importance(0-5);x_location;y_location;<br>
<br>
You can add those characters before computer name:<br>
<b>!</b> - IP address and packet latency information will not be showed<br>
<b>$</b> - IP address will not be showed<br>
<b>%</b> - packet latency information will not be showed<br>
<br>
If you assign IP address 127.0.0.1 to some computer, it will be showed as passive object
without any availability information.<br>
<br>
You can add comments to data file by placing <b>#</b> in the beginning of the line.<br>
<br>
<font face="Verdana, Arial, Helvetica" color="#000000" size="1">
<b><i>Example - test1.comp</i></b><br>
Server1;192.168.1.1;1;250;120;<br>
%Server2;192.168.1.2;1;100;120;<br>
$Router1;1.2.3.4;1;250;50;<br>
!iGW;5.6.7.8;1;400;50;<br>
Client1;192.168.1.10;0;250;190;<br>
Client2;192.168.1.11;0;400;190;<br>
Client3;192.168.1.12;0;400;120;<br>
Storage;127.0.0.1;0;100;50;<br>
</font>
<br>
<hr size="1">
<a name="link">
<font size="3"><b>*.link files</b></font><br>
link_importance(0-5);source_ip;destination_ip;<br>
link_importance(0-5);source_name;destination_name;<br>
link_importance(0-5);source_ip;destination_name;<br>
link_importance(0-5);source_name;destination_ip;<br>
<br>
First number means color (if >10), second number means link importance.<br>
<b><font color="#B4B4B4">COLOR 0</font>,
<font color="#000000">COLOR 1</font>,
<font color="#B40000">COLOR 2</font>,
<font color="#00B400">COLOR 3</font>,
<font color="#0000B4">COLOR 4</font>,
<font color="#B400B4">COLOR 5</font>,
<font color="#B4B400">COLOR 6</font>,
<font color="#00B4B4">COLOR 7</font>,
<font color="#FF0000">COLOR 8</font>,
<font color="#00FF00">COLOR 9</font></b><br>
<br>
You can add comments to data file by placing <b>#</b> in the beginning of the line.<br>
<br>
<font face="Verdana, Arial, Helvetica" color="#000000" size="1">
<b><i>Example - test1.link</i></b><br>
41;Storage;Server2;Server1;Router1;<br>
0;Router1;iGW;<br>
51;Router1;iGW;<br>
40;Server1;Client1;<br>
40;192.168.1.1;Client2;<br>
40;Server1;Client3;<br>
</font>
<br>
<hr size="1">
<a name="legend">
<font size="3"><b>*.legend files</b></font><br>
link_importance;link_importance_legend;<br>
<br>
You can add comments to data file by placing <b>#</b> in the beginning of the line.<br>
<br>
<font face="Verdana, Arial, Helvetica" color="#000000" size="1">
<b><i>Example - test1.legend</i></b><br>
1;WiFi Link;<br>
51;Optic Link;<br>
40;Ethernet 10mbit;<br>
41;Ethernet 100mbit;<br>
</font>
<br>
<hr size="1">
<a name="state">
<font size="3"><b>*.state files</b></font><br>
ip_address;number_of_pings_received(if >0 => computer is green, otherwise red);latency;<br>
<br>
<font face="Verdana, Arial, Helvetica" color="#000000" size="1">
<b><i>Example - test1.state</i></b><br>
192.168.1.1;1;1.10;<br>
192.168.1.2;1;1.40;<br>
1.2.3.4;1;1.40;<br>
5.6.7.8;1;5.70;<br>
192.168.1.10;1;2.30;<br>
192.168.1.11;1;2.70;<br>
192.168.1.12;0;0;<br>
127.0.0.1;1;1;<br>
</font>
<br>
<hr size="1">
(c)2003 by <a href="mailto:krupaj@mobilnews.cz">Jan Krupa</a>.<br>
<br>
</font>
</body>
</html>
Powered by WebSVN 2.2.1
