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 or five 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.legend - legend (optional)
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 fping installed change STATS_TYPE from 'ping' to 'fping' (www.fping.com) for faster stats generation
if you have nmap installed change STATS_TYPE from 'ping' to 'nmap' (www.insecure.org/nmap/) for faster stats generation
run 'gen_stats' to test the configuration
edit 'data/*' files to match your configuration (sample files are included)
add 'gen_stats' to cron if you want to generate statistics periodically

Packet latency information is supported only if you are using ping or fping.

*.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;

You can add those characters before computer name:
! - IP address and packet latency information will not be showed
$ - IP address will not be showed
% - packet latency information will not be showed

If you assign IP address 127.0.0.1 to some computer, it will be showed as passive object without any availability information.

Example - test1.comp
Server1;192.168.1.1;1;250;120;
%Server2;192.168.1.2;1;100;120;
$Router1;1.2.3.4;1;250;50;
!iGW;5.6.7.8;1;400;50;
Client1;192.168.1.10;0;250;190;
Client2;192.168.1.11;0;400;190;
Client3;192.168.1.12;0;400;120;
Storage;127.0.0.1;0;100;50;

*.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;

First number means color (if >10), second number means link importance.
COLOR 0, COLOR 1, COLOR 2, COLOR 3, COLOR 4, COLOR 5, COLOR 6, COLOR 7, COLOR 8, COLOR 9

Example - test1.link
41;Storage;Server2;Server1;Router1;
1;Router1;iGW;
40;Server1;Client1;
40;192.168.1.1;Client2;
40;Server1;Client3;

*.legend files
link_importance;link_importance_legend;

Example - test1.legend
1;WiFi Link;
40;Ethernet 10mbit;
41;Ethernet 100mbit;

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

Example - test1.state
192.168.1.1;1;1.10;
192.168.1.2;1;1.40;
1.2.3.4;1;1.40;
5.6.7.8;1;5.70;
192.168.1.10;1;2.30;
192.168.1.11;1;2.70;
192.168.1.12;0;0;
127.0.0.1;1;1;