"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "doc/SquidAnalyzer.pod" between
squidanalyzer-6.5.tar.gz and squidanalyzer-6.6.tar.gz

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

SquidAnalyzer.pod  (squidanalyzer-6.5):SquidAnalyzer.pod  (squidanalyzer-6.6)
skipping to change at line 61 skipping to change at line 61
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 installdirs as the issue is related to an install into the default Perl vendor installdirs
it will then use Perl site 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.
=head2 Custom install =head2 Custom install
You can create your fully customized SquidAnalyzer installation by using the You can create your fully customized SquidAnalyzer installation by using the
Makefile.PL Perl script. Here is a sample: 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 you may use. The QUIET option is to tell to Makefile.PL to not show the default post ins tall README. The DESTDIR is to create and install all files in a package build b ase directory. For example for Fedora RPM, thing may look like 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 default post ins tall README. The DESTDIR is to create and install all files in a package build b ase directory. For example for Fedora RPM, thing may look like that:
# Make Perl and SendmailAnalyzer distrib files # Make Perl and SendmailAnalyzer distrib files
%{__perl} Makefile.PL \ %{__perl} Makefile.PL \
INSTALLDIRS=vendor \ INSTALLDIRS=vendor \
QUIET=1 \ QUIET=1 \
LOGFILE=/var/log/squid/access.log \ LOGFILE=/var/log/squid/access.log \
BINDIR=%{_bindir} \ BINDIR=%{_bindir} \
skipping to change at line 163 skipping to change at line 166
SquidAnalyzer can be run manually or by cron job using the squid-analyzer Perl SquidAnalyzer can be run manually or by cron job using the squid-analyzer Perl
script. Here are authorized usage: 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 file. -c | --configfile filename : path to the SquidAnalyzer configuration file.
By default: /etc/squidanalyzer/squidanalyzer.con f By default: /etc/squidanalyzer/squidanalyzer.con f
-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 --rebuild. or yyyy-mm or yyyy. Used with -r or --rebuild.
-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 is -j | --jobs number : number of jobs to run at same time. Default
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 removed. number of month. Older stats will be removed.
-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 graphs -r | --rebuild : use this option to rebuild all html and graphs
output from all data files. output from all data files.
-t, --timezone +/-HH : set number of hours from GMT of the timezone. -s | --start HH:MM : log lines before this time will not be parsed.
-S | --stop HH:MM : log lines after this time will not be parsed.
-t | --timezone +/-HH : set number of hours from GMT of the timezone.
Use this to adjust date/time of SquidAnalyzer Use this to adjust date/time of SquidAnalyzer
output when it is run on a different timezone output when it is run on a different timezone
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 start --no-year-stat : disable years statistics, reports will start
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 separate d Log files to parse can be given as command line arguments or as a comma separate d
list of file for the LogFile configuration directive. By default SquidAnalyer wi ll list of file for the LogFile configuration directive. By default SquidAnalyer wi ll
skipping to change at line 280 skipping to change at line 285
For example: For example:
CustomHeader <a href="http://my.isp.dom/"><img src="http://my.isp.dom/l ogo.png" title="My ISP link" border="0" width="100" height="110"></a> My ISP Com pany CustomHeader <a href="http://my.isp.dom/"><img src="http://my.isp.dom/l ogo.png" title="My ISP link" border="0" width="100" height="110"></a> My ISP Com pany
126,1 Bas 126,1 Bas
=item LogFile squid_access_log_file =item LogFile squid_access_log_file
Set the path to the Squid log file. This can be a comma separated list of files 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 files comes from differents to process several files at the same time. If the files comes from differents
Squid servers, they will be merges in a single reports. You can also add to the Squid servers, they will be merges in a single reports. You can also add to the
list a SquidGuard log file, SquidAnalyzer will atomatically detect the format. list a SquidGuard log file, SquidAnalyzer will automatically detect the format.
=item UseClientDNSName 0 =item UseClientDNSName 0
If you want to use DNS name instead of client Ip address as username enable If you want to use DNS name instead of client Ip address as username enable
this directive. When you don't have authentication, the username is set to this directive. When you don't have authentication, the username is set to
the client ip address, this allow you to use the DNS name instead. the client ip address, this allow you to use the DNS name instead.
Note that you must have a working DNS resolution and that it can really slow Note that you must have a working DNS resolution and that it can really slow
down the generation of reports. down the generation of reports.
=item DNSLookupTimeout 0.0001 =item DNSLookupTimeout 0.0001
skipping to change at line 304 skipping to change at line 309
will stop to lookup a DNS name after 0.0001 second (100 ms). will stop to lookup a DNS name after 0.0001 second (100 ms).
=item NetworkAlias network-aliases_file =item NetworkAlias network-aliases_file
Set path to the file containing network alias name. Network are Set path to the file containing network alias name. Network are
show as Ip addresses so if you want to display name instead show as Ip addresses so if you want to display name instead
create a file with this format: create a file 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.
=item UserAlias user-aliases_file =item 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 format: show username or computer name instead, create a file with this 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 addresses. See You can use regex to match and group some user login or ip addresses. See
user-aliases file for examples. user-aliases file for examples.
You can also replace default ip address by his DNS name by enabling
directive 'UseClientDNSName'.
=item AnonymizeLogin 0 =item 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.
=item OrderNetwork bytes|hits|duration =item OrderNetwork bytes|hits|duration
=item OrderUser bytes|hits|duration =item OrderUser bytes|hits|duration
skipping to change at line 380 skipping to change at line 386
sort the URL/Domain order by clicking on each column. This is useful when you sort the URL/Domain order by clicking on each column. This is useful when you
have set a high value to TopNumber. have set a high value to TopNumber.
=item QuietMode 0|1 =item 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.
=item CostPrice price/Mb =item 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 displayed no cost, this is the default value, the "Cost" column is not displayed
=item Currency currency_abreviation =item 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;
=item TopNumber number =item 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.
=item 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.
=item TopUrlUser =item TopUrlUser
Use this directive to show the top N users that look at an URL or a domain. 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. Set it to 0 to disable this feature. Default is top 10.
=item Exclude exclusion_file =item 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 the 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 valid regex. exclusion (USER, CLIENT or URI) and a space separated list of valid regex.
You can also use the NETWORK type to define network address with netmask You can also use the NETWORK type to define network address with netmask
using the CIDR notation: xxx.xxx.xxx.xxx/n 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 433 skipping to change at line 446
Used to set client ip addresses, network addresses or auth login Used to set client ip addresses, network addresses or auth login
to include into the report. All others will not be included. It to include into the report. All others will not be included. It
works as the opposite of the Include parameter. works as the opposite of the Include parameter.
You can define one by line inclusion by specifying first the type of the 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 regex. inclusion (USER or CLIENT) and a space separated list of valid regex.
You can also use the NETWORK type to define network address with netmask You can also use the NETWORK type to define network address with netmask
using the CIDR notation: xxx.xxx.xxx.xxx/n 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 485 skipping to change at line 498
Default: %y-%m-%d Default: %y-%m-%d
=item SiblingHit =item SiblingHit
Adds peer cache hit (CD_SIBLING_HIT) to be taken has local cache hit. 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 report Enabled by default, you must disabled it if you don't want to report
peer cache hit onto your stats. peer cache hit onto your stats.
=item TransfertUnit =item TransfertUnit
Allow to change the default unit used to display transfert size. Default Allow one to change the default unit used to display transfert size. Default
is BYTES, other possible values are KB, MB and GB. is BYTES, other possible values are KB, MB and GB.
=item MinPie =item MinPie
Minimum percentage of data in pie's graphs to not be placed in the others 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. item. Lower values will be summarized into the others item.
=item Locale =item Locale
Set this to your locale to display generated date in your language. Default Set this to your locale to display generated date in your language. Default
skipping to change at line 522 skipping to change at line 535
Set timezone to use when SquidAnalyzer is used in a different server than Set timezone to use when SquidAnalyzer is used in a different server than
the one running squid and there is a different timezone between these two the one running squid and there is a different timezone between these two
machines. The value must follow format: +/-HH. Default is to use local time. machines. The value must follow format: +/-HH. Default is to use local time.
For example: For example:
TimeZone +01 TimeZone +01
for a log file generated on zone Europe/Paris with UTC+0100 and parsed on a for a log file generated on zone Europe/Paris with UTC+0100 and parsed on a
computer with different timezone. computer with different timezone.
=item UseUrlPort
Enable this directive if you want to include port number into Url statistics.
Default is to remove the port information from the Url.
=item 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.
=item 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
=back =back
=head1 SUPPORT =head1 SUPPORT
=head2 Release annoucement =head2 Release announcement
Please follow us on twitter to receive release annoucement and latest news : htt ps://twitter.com/SquidAnalyzer Please follow us on twitter to receive release announcement and latest news : ht tps://twitter.com/SquidAnalyzer
=head2 Bugs and Feature requests =head2 Bugs and Feature requests
Please report any bugs, patches, discussion and feature request using tools on t he git repository at Please report any bugs, patches, discussion and feature request using tools on t he git repository at
https://github.com/darold/squidanalyzer. https://github.com/darold/squidanalyzer.
=head2 How to contribute ? =head2 How to contribute ?
Any contribution to build a better tool is welcome, you just have to send me you r ideas, features request or Any contribution to build a better tool is welcome, you just have to send me you r ideas, features request or
patches using the tools on the git repository at https://github.com/darold/squid analyzer patches using the tools on the git repository at https://github.com/darold/squid analyzer
You can also support the developper by donate some contribution by clicking on t he "Donate" button on the You can also support the developer by donate some contribution by clicking on th e "Donate" button on the
SquidAnalyzer web site at http://squidanalyzer.darold.net/ SquidAnalyzer web site at http://squidanalyzer.darold.net/
=head1 AUTHOR =head1 AUTHOR
Gilles DAROLD <gilles@darold.net> Gilles DAROLD <gilles@darold.net>
=head1 COPYRIGHT =head1 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. 21 change blocks. 
22 lines changed or deleted 52 lines changed or added

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