jablonka.czprosek.czf

netmap

 Subversion Repositories:
[/] [work/] [calstats-0.1.2/] [doc/] [index.html] - Blame information for rev 99

 

Line No. Rev Author Line
11simandl<html>
2<title>CaLStats documentation</title>
3 
4<body>
5<font face="Verdana, Arial, Helvetica" color="#000000" size="2">
6<font size="+1"><b>CaLStats documentation</b></font><br>
7Computer and Links Statistics<br>
8<br>
9 
10<img src="test1.png" border="0" width="500" height="230" alt="Example - Test1">
11<img src="calstats_help1.png" border="0" width="298" height="244" alt="Image description"><br>
12<br>
13 
14<hr size="1">
15 
16<font size="3"><b>Basic information</b></font><br>
17First of all check out CaLStats homepage if there is newer version available:<br>
18<a href="http://www.mobilnews.cz/honza/en_prog_linux_calstats.php">http://www.mobilnews.cz/honza/en_prog_linux_calstats.php</a><br>
19<br>
20 
21Every site stat consist of three to five files. So our testing example will consist of those files:<br>
22<a href="#config">test1.config</a> - configuration file<br>
23<a href="#comp">test1.comp</a> - list of computers<br>
24<a href="#link">test1.link</a> - list of links between computers (optional)<br>
25<a href="#legend">test1.legend</a> - legend (optional)<br>
26<a href="#state">test1.state</a> - actual state of computers (generated by CaLStats)<br>
27<br>
28 
29You need to create <i>.config</i> and <i>.comp</i> files for every site stat. You can
30place as many sites as you want into data directory. Then just run <i>gen_stats</i> and stats will
31be gererated. If you want up to date stats, insert <i>gen_stats</i> into cron daemon (for example every
325-10 minutes).<br>
33<br>
34 
35<hr size="1">
36 
37<font size="3"><b>Installation</b></font><br>
38<br>
39 
40<b>These programs must be available in the system:</b> awk, PHP (with GD library)<br>
41<ul>
42<li>unpack the archive</li>
43<li>move calstats directory to /usr/local (or somewhere you want to use it in)</li>
44<li>change path, directories and configuration in 'gen_stats'</li>
45<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>
46<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>
47<li>run 'gen_stats' to test the configuration</li>
48<li>edit 'data/*' files to match your configuration (sample files are included)</li>
49<li>add 'gen_stats' to cron if you want to generate statistics periodically</li>
50</ul>
51 
52Packet latency information is supported only if you are using <i>ping</i> or <i>fping</i>.<br>
53<br>
54 
55<hr size="1">
56 
57<a name="config">
58<font size="3"><b>*.config files</b></font><br>
59title;x_size;y_size;legend_location;border;background_color;<br>
60<br>
61<b>legend_location:</b><br>
62 
631 ... top left<br>
642 ... top right<br>
653 ... bottom left<br>
664 ... bottom right<br>
67<br>
68 
69<b>border:</b><br>
70 
711 ... on<br>
72<br>
73 
74You can leave background_color field blank if you want white background.<br>
75<br>
76 
77<font face="Verdana, Arial, Helvetica" color="#000000" size="1">
78<b><i>Example - test1.config</i></b><br>
79Test1;500;230;3;1;FFFFFF;<br>
80</font>
81<br>
82 
83<hr size="1">
84 
85<a name="comp">
86<font size="3"><b>*.comp files</b></font><br>
87computer_name;ip_address;computer_importance(0-5);x_location;y_location;<br>
88<br>
89 
90You can add those characters before computer name:<br>
91<b>!</b> - IP address and packet latency information will not be showed<br>
92<b>$</b> - IP address will not be showed<br>
93<b>%</b> - packet latency information will not be showed<br>
94<br>
95 
96If you assign IP address 127.0.0.1 to some computer, it will be showed as passive object
97without any availability information.<br>
98<br>
99 
100You can add comments to data file by placing <b>#</b> in the beginning of the line.<br>
101<br>
102 
103<font face="Verdana, Arial, Helvetica" color="#000000" size="1">
104<b><i>Example - test1.comp</i></b><br>
105Server1;192.168.1.1;1;250;120;<br>
106%Server2;192.168.1.2;1;100;120;<br>
107$Router1;1.2.3.4;1;250;50;<br>
108!iGW;5.6.7.8;1;400;50;<br>
109Client1;192.168.1.10;0;250;190;<br>
110Client2;192.168.1.11;0;400;190;<br>
111Client3;192.168.1.12;0;400;120;<br>
112Storage;127.0.0.1;0;100;50;<br>
113</font>
114<br>
115 
116<hr size="1">
117 
118<a name="link">
119<font size="3"><b>*.link files</b></font><br>
120link_importance(0-5);source_ip;destination_ip;<br>
121link_importance(0-5);source_name;destination_name;<br>
122link_importance(0-5);source_ip;destination_name;<br>
123link_importance(0-5);source_name;destination_ip;<br>
124<br>
125 
126First number means color (if >10), second number means link importance.<br>
127<b><font color="#B4B4B4">COLOR 0</font>,
128<font color="#000000">COLOR 1</font>,
129<font color="#B40000">COLOR 2</font>,
130<font color="#00B400">COLOR 3</font>,
131<font color="#0000B4">COLOR 4</font>,
132<font color="#B400B4">COLOR 5</font>,
133<font color="#B4B400">COLOR 6</font>,
134<font color="#00B4B4">COLOR 7</font>,
135<font color="#FF0000">COLOR 8</font>,
136<font color="#00FF00">COLOR 9</font></b><br>
137<br>
138 
139You can add comments to data file by placing <b>#</b> in the beginning of the line.<br>
140<br>
141 
142<font face="Verdana, Arial, Helvetica" color="#000000" size="1">
143<b><i>Example - test1.link</i></b><br>
14441;Storage;Server2;Server1;Router1;<br>
1450;Router1;iGW;<br>
14651;Router1;iGW;<br>
14740;Server1;Client1;<br>
14840;192.168.1.1;Client2;<br>
14940;Server1;Client3;<br>
150</font>
151<br>
152 
153<hr size="1">
154 
155<a name="legend">
156<font size="3"><b>*.legend files</b></font><br>
157link_importance;link_importance_legend;<br>
158<br>
159 
160You can add comments to data file by placing <b>#</b> in the beginning of the line.<br>
161<br>
162 
163<font face="Verdana, Arial, Helvetica" color="#000000" size="1">
164<b><i>Example - test1.legend</i></b><br>
1651;WiFi Link;<br>
16651;Optic Link;<br>
16740;Ethernet 10mbit;<br>
16841;Ethernet 100mbit;<br>
169</font>
170<br>
171 
172<hr size="1">
173 
174<a name="state">
175<font size="3"><b>*.state files</b></font><br>
176ip_address;number_of_pings_received(if >0 => computer is green, otherwise red);latency;<br>
177<br>
178 
179<font face="Verdana, Arial, Helvetica" color="#000000" size="1">
180<b><i>Example - test1.state</i></b><br>
181192.168.1.1;1;1.10;<br>
182192.168.1.2;1;1.40;<br>
1831.2.3.4;1;1.40;<br>
1845.6.7.8;1;5.70;<br>
185192.168.1.10;1;2.30;<br>
186192.168.1.11;1;2.70;<br>
187192.168.1.12;0;0;<br>
188127.0.0.1;1;1;<br>
189</font>
190<br>
191 
192<hr size="1">
193 
194(c)2003 by <a href="mailto:krupaj@mobilnews.cz">Jan Krupa</a>.<br>
195<br>
196 
197</font>
198</body>
199</html>

Powered by WebSVN 2.2.1