"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "README" between
squidanalyzer-6.5.tar.gz and squidanalyzer-6.6.tar.gz

About: SquidAnalyzer is a Squid (proxy) log analyzer.

README  (squidanalyzer-6.5):README  (squidanalyzer-6.6)
skipping to change at line 57 skipping to change at line 57
please proceed as follow: please proceed as follow:
perl Makefile.PL INSTALLDIRS=site perl Makefile.PL INSTALLDIRS=site
make make
make install make install
as the issue is related to an install into the default Perl vendor as the issue is related to an install into the default Perl vendor
installdirs it will then use Perl site installdirs. installdirs it will then use Perl site installdirs.
Note: you may not encountered this issue any more, since v6.6
SquidAnalyzer use site as default installation directory.
Custom install Custom install
You can create your fully customized SquidAnalyzer installation by using You can create your fully customized SquidAnalyzer installation by using
the Makefile.PL Perl script. Here is a sample: the Makefile.PL Perl script. Here is a sample:
perl Makefile.PL \ perl Makefile.PL \
LOGFILE=/var/log/squid3/access.log \ LOGFILE=/var/log/squid3/access.log \
BINDIR=/usr/bin \ BINDIR=/usr/bin \
CONFDIR=/etc \ CONFDIR=/etc \
HTMLDIR=/var/www/squidreport \ HTMLDIR=/var/www/squidreport \
BASEURL=/squidreport \ BASEURL=/squidreport \
MANDIR=/usr/man/man3 \ MANDIR=/usr/share/man/man3 \
DOCDIR=/usr/share/doc/squidanalyzer DOCDIR=/usr/share/doc/squidanalyzer
If you want to build a distro package, there are two other options that If you want to build a distro package, there are two other options that
you may use. The QUIET option is to tell to Makefile.PL to not show the you may use. The QUIET option is to tell to Makefile.PL to not show the
default post install README. The DESTDIR is to create and install all default post install README. The DESTDIR is to create and install all
files in a package build base directory. For example for Fedora RPM, files in a package build base directory. For example for Fedora RPM,
thing may look like that: thing may look like that:
# Make Perl and SendmailAnalyzer distrib files # Make Perl and SendmailAnalyzer distrib files
%{__perl} Makefile.PL \ %{__perl} Makefile.PL \
skipping to change at line 160 skipping to change at line 163
USAGE USAGE
SquidAnalyzer can be run manually or by cron job using the SquidAnalyzer can be run manually or by cron job using the
squid-analyzer Perl script. Here are authorized usage: squid-analyzer Perl script. Here are authorized usage:
Usage: squid-analyzer [ -c squidanalyzer.conf ] [logfile(s)] Usage: squid-analyzer [ -c squidanalyzer.conf ] [logfile(s)]
-c | --configfile filename : path to the SquidAnalyzer configuration fil e. -c | --configfile filename : path to the SquidAnalyzer configuration fil e.
By default: /etc/squidanalyzer/squidanalyze r.conf By default: /etc/squidanalyzer/squidanalyze r.conf
-b | --build_date date : set the date to be rebuilt, format: yyyy-mm -dd -b | --build_date date : set the date to be rebuilt, format: yyyy-mm -dd
or yyyy-mm or yyyy. Used with -r or --rebui ld. or yyyy-mm or yyyy. Used with -r or --rebui ld.
-d | --debug : show debug informations. -d | --debug : show debug information.
-h | --help : show this message and exit. -h | --help : show this message and exit.
-j | --jobs number : number of jobs to run at same time. Default -j | --jobs number : number of jobs to run at same time. Default
is 1, is 1, run as single process.
run as single process.
-p | --preserve number : used to set the statistic obsolescence in -p | --preserve number : used to set the statistic obsolescence in
number of month. Older stats will be remove d. number of month. Older stats will be remove d.
-P | --pid_dir directory : set directory where pid file will be stored . -P | --pid_dir directory : set directory where pid file will be stored .
Default /tmp/ Default /tmp/
-r | --rebuild : use this option to rebuild all html and gra phs -r | --rebuild : use this option to rebuild all html and gra phs
output from all data files. output from all data files.
-t, --timezone +/-HH : set number of hours from GMT of the timezon -s | --start HH:MM : log lines before this time will not be pars
e. ed.
-S | --stop HH:MM : log lines after this time will not be parse
d.
-t | --timezone +/-HH : set number of hours from GMT of the timezon
e.
Use this to adjust date/time of SquidAnalyz er Use this to adjust date/time of SquidAnalyz er
output when it is run on a different timezo ne output when it is run on a different timezo ne
than the squid server. than the squid server.
-v | version : show version and exit. -v | version : show version and exit.
--no-year-stat : disable years statistics, reports will star t --no-year-stat : disable years statistics, reports will star t
from month level only. from month level only.
--no-week-stat : disable weekly statistics. --no-week-stat : disable weekly statistics.
Log files to parse can be given as command line arguments or as a comma Log files to parse can be given as command line arguments or as a comma
separated list of file for the LogFile configuration directive. By separated list of file for the LogFile configuration directive. By
skipping to change at line 273 skipping to change at line 278
current design. For example: current design. For example:
CustomHeader <a href="http://my.isp.dom/"><img src="http://my. isp.dom/logo.png" title="My ISP link" border="0" width="100" height="110"></a> M y ISP Company CustomHeader <a href="http://my.isp.dom/"><img src="http://my. isp.dom/logo.png" title="My ISP link" border="0" width="100" height="110"></a> M y ISP Company
126,1 Bas 126,1 Bas
LogFile squid_access_log_file LogFile squid_access_log_file
Set the path to the Squid log file. This can be a comma separated Set the path to the Squid log file. This can be a comma separated
list of files to process several files at the same time. If the list of files to process several files at the same time. If the
files comes from differents Squid servers, they will be merges in a files comes from differents Squid servers, they will be merges in a
single reports. You can also add to the list a SquidGuard log file, single reports. You can also add to the list a SquidGuard log file,
SquidAnalyzer will atomatically detect the format. SquidAnalyzer will automatically detect the format.
UseClientDNSName 0 UseClientDNSName 0
If you want to use DNS name instead of client Ip address as username If you want to use DNS name instead of client Ip address as username
enable this directive. When you don't have authentication, the enable this directive. When you don't have authentication, the
username is set to the client ip address, this allow you to use the username is set to the client ip address, this allow you to use the
DNS name instead. Note that you must have a working DNS resolution DNS name instead. Note that you must have a working DNS resolution
and that it can really slow down the generation of reports. and that it can really slow down the generation of reports.
DNSLookupTimeout 0.0001 DNSLookupTimeout 0.0001
If you have enabled UseClientDNSName and have lot of ip addresses If you have enabled UseClientDNSName and have lot of ip addresses
skipping to change at line 295 skipping to change at line 300
By default SquidAnalyzer will stop to lookup a DNS name after 0.0001 By default SquidAnalyzer will stop to lookup a DNS name after 0.0001
second (100 ms). second (100 ms).
NetworkAlias network-aliases_file NetworkAlias network-aliases_file
Set path to the file containing network alias name. Network are show Set path to the file containing network alias name. Network are show
as Ip addresses so if you want to display name instead create a file as Ip addresses so if you want to display name instead create a file
with this format: with this format:
LOCATION_NAME IP_NETWORK_ADDRESS LOCATION_NAME IP_NETWORK_ADDRESS
Separator must be a tabulation. Separator must be a tabulation this allow the use of space character
in the network alias name.
You can use regex to match and group some network addresses. See You can use regex to match and group some network addresses. See
network-aliases file for examples. network-aliases file for examples.
UserAlias user-aliases_file UserAlias user-aliases_file
Set path to the file containing user alias name. If you don't have Set path to the file containing user alias name. If you don't have
auth_proxy enable users are seen as ip addresses. So if you want to auth_proxy enable users are seen as ip addresses. So if you want to
show username or computer name instead, create a file with this show username or computer name instead, create a file with this
format: format:
FULL_USERNAME IP_ADDRESS FULL_USERNAME IP_ADDRESS
When 'UseClientDNSName' is ebabled you can replace ip address by a
DNS name.
If you have auth_proxy enable but want to replace login name by full If you have auth_proxy enable but want to replace login name by full
user name for example, create a file with this format: user name for example, create a file with this format:
FULL_USERNAME LOGIN_NAME FULL_USERNAME LOGIN_NAME
Separator for both must be a tabulation. Separator for both must be a tabulation this allow the use of space
character in the user alias name.
You can use regex to match and group some user login or ip You can use regex to match and group some user login or ip
addresses. See user-aliases file for examples. addresses. See user-aliases file for examples.
You can also replace default ip address by his DNS name by enabling
directive 'UseClientDNSName'.
AnonymizeLogin 0 AnonymizeLogin 0
Set this to 1 if you want to anonymize all user login. The username Set this to 1 if you want to anonymize all user login. The username
will be replaced by an unique id that change at each squid-analyzer will be replaced by an unique id that change at each squid-analyzer
run. Default disable. run. Default disable.
OrderNetwork bytes|hits|duration OrderNetwork bytes|hits|duration
OrderUser bytes|hits|duration OrderUser bytes|hits|duration
OrderUrl bytes|hits|duration OrderUrl bytes|hits|duration
Used to set how SquidAnalyzer sort Network, User and User detailed Used to set how SquidAnalyzer sort Network, User and User detailed
Urls reports screen. Value can be: bytes, hits or duration. Default Urls reports screen. Value can be: bytes, hits or duration. Default
skipping to change at line 361 skipping to change at line 368
Enable this directive if you don't want the tree Top URL and Domain Enable this directive if you don't want the tree Top URL and Domain
tables. You will just have the table of Url/Domain ordered per hits tables. You will just have the table of Url/Domain ordered per hits
then you can still sort the URL/Domain order by clicking on each then you can still sort the URL/Domain order by clicking on each
column. This is useful when you have set a high value to TopNumber. column. This is useful when you have set a high value to TopNumber.
QuietMode 0|1 QuietMode 0|1
Run in quiet mode for batch processing or print debug information. Run in quiet mode for batch processing or print debug information.
Default is 0, verbose mode. Default is 0, verbose mode.
CostPrice price/Mb CostPrice price/Mb
Used to set a cost of the bandwith per Mb. If you want to generate Used to set a cost of the bandwidth per Mb. If you want to generate
invoice per Mb for bandwith traffic this can help you. Value 0 mean invoice per Mb for bandwidth traffic this can help you. Value 0 mean
no cost, this is the default value, the "Cost" column is not no cost, this is the default value, the "Cost" column is not
displayed displayed
Currency currency_abreviation Currency currency_abreviation
Used to set the currency of the bandwith cost. Preferably the html Used to set the currency of the bandwidth cost. Preferably the html
special character. Default is &euro; special character. Default is &euro;
TopNumber number TopNumber number
Used to set the number of top url and second level domain to show. Used to set the number of top url and second level domain to show.
Default is top 100. Default is top 100.
TopStorage number
Top number of url to preserve on each data file sorted by OrderUrl.
On huge access log it will improve a lot the performances but you
will have less precision in the top url. Default to 0, all url will
be stored.
TopUrlUser Use this directive to show the top N users that look at an TopUrlUser Use this directive to show the top N users that look at an
URL or a domain. Set it to 0 to disable this feature. Default is top 10. URL or a domain. Set it to 0 to disable this feature. Default is top 10.
Exclude exclusion_file Exclude exclusion_file
Used to set client ip addresses, network addresses, auth login or Used to set client ip addresses, network addresses, auth login or
uri to exclude from report. uri to exclude from report.
You can define one by line exclusion by specifying first the type of You can define one by line exclusion by specifying first the type of
the exclusion (USER, CLIENT or URI) and a space separated list of the exclusion (USER, CLIENT or URI) and a space separated list of
valid regex. valid regex.
You can also use the NETWORK type to define network address with You can also use the NETWORK type to define network address with
netmask using the CIDR notation: xxx.xxx.xxx.xxx/n netmask using the CIDR notation: xxx.xxx.xxx.xxx/n
See example bellow: See example below:
NETWORK 192.168.1.0/24 10.10.0.0/16 NETWORK 192.168.1.0/24 10.10.0.0/16
CLIENT 192\.168\.1\.2 CLIENT 192\.168\.1\.2
CLIENT 10\.169\.1\.\d+ 192\.168\.10\..* CLIENT 10\.169\.1\.\d+ 192\.168\.10\..*
USER myloginstr USER myloginstr
USER guestlogin\d+ guestdemo USER guestlogin\d+ guestdemo
URI http:\/\/myinternetdomain.dom.* URI http:\/\/myinternetdomain.dom.*
URI .*\.webmail\.com\/.*\/login\.php.* URI .*\.webmail\.com\/.*\/login\.php.*
you can have multiple line of the same exclusion type. you can have multiple line of the same exclusion type.
skipping to change at line 411 skipping to change at line 424
include into the report. All others will not be included. It works include into the report. All others will not be included. It works
as the opposite of the Include parameter. as the opposite of the Include parameter.
You can define one by line inclusion by specifying first the type of You can define one by line inclusion by specifying first the type of
the inclusion (USER or CLIENT) and a space separated list of valid the inclusion (USER or CLIENT) and a space separated list of valid
regex. regex.
You can also use the NETWORK type to define network address with You can also use the NETWORK type to define network address with
netmask using the CIDR notation: xxx.xxx.xxx.xxx/n netmask using the CIDR notation: xxx.xxx.xxx.xxx/n
See example bellow: See example below:
NETWORK 192.168.1.0/24 10.10.0.0/16 NETWORK 192.168.1.0/24 10.10.0.0/16
CLIENT 192\.168\.1\.2 CLIENT 192\.168\.1\.2
CLIENT 10\.169\.1\.\d+ 192\.168\.10\..* CLIENT 10\.169\.1\.\d+ 192\.168\.10\..*
USER myloginstr USER myloginstr
USER guestlogin\d+ guestdemo USER guestlogin\d+ guestdemo
URI http:\/\/myinternetdomain.dom.* URI http:\/\/myinternetdomain.dom.*
URI .*\.webmail\.com\/.*\/login\.php.* URI .*\.webmail\.com\/.*\/login\.php.*
you can have multiple line of the same inclusion type. you can have multiple line of the same inclusion type.
skipping to change at line 458 skipping to change at line 471
Date format used to display date (year = %y, month = %m and day = Date format used to display date (year = %y, month = %m and day =
%d) You can also use %M to replace month by its 3 letters %d) You can also use %M to replace month by its 3 letters
abbreviation. Default: %y-%m-%d abbreviation. Default: %y-%m-%d
SiblingHit SiblingHit
Adds peer cache hit (CD_SIBLING_HIT) to be taken has local cache Adds peer cache hit (CD_SIBLING_HIT) to be taken has local cache
hit. Enabled by default, you must disabled it if you don't want to hit. Enabled by default, you must disabled it if you don't want to
report peer cache hit onto your stats. report peer cache hit onto your stats.
TransfertUnit TransfertUnit
Allow to change the default unit used to display transfert size. Allow one to change the default unit used to display transfert size.
Default is BYTES, other possible values are KB, MB and GB. Default is BYTES, other possible values are KB, MB and GB.
MinPie MinPie
Minimum percentage of data in pie's graphs to not be placed in the Minimum percentage of data in pie's graphs to not be placed in the
others item. Lower values will be summarized into the others item. others item. Lower values will be summarized into the others item.
Locale Locale
Set this to your locale to display generated date in your language. Set this to your locale to display generated date in your language.
Default is to use the current locale of the system. If you want date Default is to use the current locale of the system. If you want date
in German for example, set it to de_DE. in German for example, set it to de_DE.
skipping to change at line 492 skipping to change at line 505
Set timezone to use when SquidAnalyzer is used in a different server Set timezone to use when SquidAnalyzer is used in a different server
than the one running squid and there is a different timezone between than the one running squid and there is a different timezone between
these two machines. The value must follow format: +/-HH. Default is these two machines. The value must follow format: +/-HH. Default is
to use local time. For example: to use local time. For example:
TimeZone +01 TimeZone +01
for a log file generated on zone Europe/Paris with UTC+0100 and for a log file generated on zone Europe/Paris with UTC+0100 and
parsed on a computer with different timezone. parsed on a computer with different timezone.
UseUrlPort
Enable this directive if you want to include port number into Url
statistics. Default is to remove the port information from the Url.
UpdateAlias
Enable this directive if you want to apply immedialtly the changes
made in aliases files to avoid duplicates. You still have to use
--rebuild to recreate previous reports with new aliases. Enabling
this will imply a lost of performances with huges log files.
TimeStart and TimeStop
The two following configuration directive allow you to specify a
start and stop time. Log line out of this time range will not be
parsed. The format of the value is HH:MM
SUPPORT SUPPORT
Release annoucement Release announcement
Please follow us on twitter to receive release annoucement and latest Please follow us on twitter to receive release announcement and latest
news : https://twitter.com/SquidAnalyzer news : https://twitter.com/SquidAnalyzer
Bugs and Feature requests Bugs and Feature requests
Please report any bugs, patches, discussion and feature request using Please report any bugs, patches, discussion and feature request using
tools on the git repository at https://github.com/darold/squidanalyzer. tools on the git repository at https://github.com/darold/squidanalyzer.
How to contribute ? How to contribute ?
Any contribution to build a better tool is welcome, you just have to Any contribution to build a better tool is welcome, you just have to
send me your ideas, features request or patches using the tools on the send me your ideas, features request or patches using the tools on the
git repository at https://github.com/darold/squidanalyzer git repository at https://github.com/darold/squidanalyzer
You can also support the developper by donate some contribution by You can also support the developer by donate some contribution by
clicking on the "Donate" button on the SquidAnalyzer web site at clicking on the "Donate" button on the SquidAnalyzer web site at
http://squidanalyzer.darold.net/ http://squidanalyzer.darold.net/
AUTHOR AUTHOR
Gilles DAROLD <gilles@darold.net> Gilles DAROLD <gilles@darold.net>
COPYRIGHT COPYRIGHT
Copyright (c) 2001-2016 Gilles DAROLD Copyright (c) 2001-2017 Gilles DAROLD
This package is free software and published under the GPL v3 or above This package is free software and published under the GPL v3 or above
license. license.
 End of changes. 20 change blocks. 
23 lines changed or deleted 52 lines changed or added

Home  |  About  |  All  |  Newest  |  Fossies Dox  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTPS