CaLStats documentation

CaLStats documentation
Computer and Links Statistics

Example - Test1

Basic information
First of all check out CaLStats homepage if there is newer version available:
http://www.mobilnews.cz/honza/en_prog_linux_calstats.php

Every site stat consist of four files. So our testing example will consist of those files:
test1.config - configuration file
test1.comp - list of computers
test1.link - list of links between computers
test1.state - actual state of computers (generated by CaLStats)

You need to create those three files (.config, .comp and .link) for every site stat. You can place as many sites as you want into data directory. Then just run gen_stats and stats will be gererated. If you want up to date stats, insert gen_stats into cron daemon (for example every 5-10 minutes).

Installation

These programs must be available in the system: awk, PHP

unpack the archive
move calstats directory to /var (or somewhere you want to use it in)
change path and directories in 'gen_onestatpict' and 'gen_stats'
if you have nmap installed change STATS_TYPE from 'ping' to 'nmap' (www.insecure.org/nmap/) for faster stats generation
if you have fping installed change STATS_TYPE from 'ping' to 'fping' (www.fping.com) for faster stats generation
run 'gen_stats' to test the configuration
edit 'data/*' files to match your configuration (sample files are included, look at README)
add 'gen_stats' to cron if you want to generate statistics periodically

*.config files
title;x_size;y_size;

Example - test1.config
Test1;500;230;

*.comp files
computer_name;ip_address;computer_importance(0-5);x_location;y_location;

Example - test1.comp
Server;192.168.1.1;1;250;120;
Router1;1.2.3.4;1;250;50;
iGW;5.6.7.8;1;400;50;
Client1;192.168.1.2;0;100;190;
Client2;192.168.1.3;0;250;190;
Client3;192.168.1.4;0;400;190;

*.link files
link_importance(0-5);source_ip;destination_ip;
link_importance(0-5);source_name;destination_name;
link_importance(0-5);source_ip;destination_name;
link_importance(0-5);source_name;destination_ip;

WARNING - structure of *.link files has changed in CaLStats 0.0.5!

Example - test1.link
1;Server;Router1;iGW;
0;Server;Client1;
0;192.168.1.1;Client2;
0;Server;Client3;

*.state files
ip_address;number_of_pings_received(if >0 => computer is green, otherwise red)

Example - test1.state
192.168.1.1;1;
1.2.3.4;1;
5.6.7.8;1;
192.168.1.2;1;
192.168.1.3;1;
192.168.1.4;0;