prostat version 1.3

============================================================================

Prerequisites :
        - Squid version 1.1 et plus
        - Squid configuration :
                - emulate_httpd_log off
        - il est egalement tres conseille de mettre "log_fqdn off"
          et de definir les voisins et parents par leur adresse IP et non leur n
om

============================================================================

Installation :

	- editer le fichier Makefile et verifier que c'est bon
	- editer le fichier analhead.h et indiquer en particulier :
		- LOGFILE : le fichier log a traiter par defaut
		- OUTDIR : repertoire par defaut ou prostat va creer les fichier de resultats
		- DOMAINSFILE : le nom du fichier des domaines
		- TYPESFILE : le nom du fichier des types mime
		- LOGOURL : l'url du logo de votre site
		- CONFIGFILE : le fichier de configuration par defaut de prostat (par defaut /usr/local/squid/stats/prostat.conf)
		- HOSTNAME : le nom de votre cache
		- HOSTURL : l'url de la page d'accueil de votre cache
		
La plupart des parametres de analhead.h peuvent etre modifier soit dans un fichier de configuration soit par un parametre de la ligne de commande de prostat.

	- Si vous utilisez deja une version de prostat < 1.3, vous devez 
	  modifier le fichier proxy.db qui se trouve dans le repertoire OUTDIR, avant
	  d'executer prostat 1.3. Pour cela, dans le repertoire OUTDIR, executer les
	  commandes suivantes :

		% awk -F ":" '{print $1":"$2":"$3":0:"$5":"$6":0:"$8":"$9":"$10}' proxy.db > proxy.db.new
		% mv proxy.db.new proxy.db
	  

Lancement de prostat :

1. Generalites
	prostat se lance normalement 1 fois par semaine, par exemple le dimanche a 0h apres avoir fait "tourner" les logs de squid. Cette procedure peut se faire via cron avec par exemple le script suivant :

	#!/bin/sh


	kill -USR1 `cat /usr/local/squid/squid.pid`
	sleep 120
	/usr/local/squid/stats/prostat /var/log/squid/access.log.0 2> /usr/local/squid/utilities/chlog.log
	/usr/bin/gzip /var/log/squid/access.log.0


2. cas normal :
	$ prostat      

	dans ce cas prostat va utiliser les valeurs de tous les parametres indiques dans le fichier analhead.h ainsi que celles indiquees dans le fichier de configuration (prostat.conf). Les valeurs des parametres indiquees dans le fichier de config sont prioritaires.

3. utilisation d'un autre fichier de config

	$ prostat +g<path du fichier de config>

	pas d'espace engre +g et le path du fichier

4. utilisation de parametres dans la ligne de commande

Exemple :

	$prostat +Sb18 -R

	dans cette exemple on veut un rapport contenant les infos sur les machines clientes (+S), classees par le nombre d'octets (+Sb) et corespondant au moins a 0.18% du traffic total (+Sb18). On ne veut pas pas d'infos sur les urls demandes au cache (-R).


# Parametres utilisables dans le fichier de conf

# Parametres utilisables dans le fichier de conf
# avec les options correspondantes entre parentheses
#
# colsorder : 
# exemple :  COLSORDER RrBb
# R = nombre de reqs, r = % de reqs, B = nombre d'octets, b = % d'octets.
#
# Valeurs de SITESFLOOR, hostfloor, mimefloor, typefloor, domfloor et protofloor :
#
#    si < 0 : -(nombre de requetes minimum)
#    si = 0 : pas de limites
#    si > 0 : pourcentage d'octets minimum / 100 (ex : 20 => 0.20%)


LANG EN/FR
OUTDIR Directory  (+/-O)
LOGFILE Logfile

HOSTS ON/OFF (+/-S)
HOSTSORTBY BYREQUESTS/BYBYTES
HOSTFLOOR value
HOSTCOLS colsorder

MIMETYPE ON/OFF (+/-m)
MIMESORTBY BYREQUESTS/BYBYTES
MIMEFLOOR value
MIMECOLS colsorder

FILETYPE ON/OFF (+/-t)
TYPESORTBY BYREQUESTS/BYBYTES
TYPEFLOOR value
TYPECOLS colsorder

DOMAINS ON/OFF (+/-D)
DOMSORTBY BYREQUESTS/BYBYTES
DOMFLOOR value
DOMCOLS colsorder

SITES ON/OFF (+/-s)
SITESSORTBY BYREQUESTS/BYBYTES
SITESFLOOR value
SITESCOLS colsorder

REQUESTS ON/OFF (+/-r)

PROTOCOL ON/OFF (+/-P)
PROTOFLOOR value
PROTOCOLS colsorder

DAILY ON/OFF (+/-d)

HOURLY ON/OFF (+/-h)

LOGO ON/OFF (+/-l)
LOGOURL url

CUMUL ON/OFF (+/-C)

GRAPH ON/OFF (+/-G)

HOSTIGNORE host

HOSTONLY host

REPORTORDER SrDPdhmt

SEPCHAR char

HOSTALIAS host alias

================================================
Claude Gross
CNRS/Unit Rseaux du CNRS
Email: Claude.Gross@urec.cnrs.fr

