From: eldy <> Date: Fri, 7 Apr 2006 22:41:37 +0000 (+0000) Subject: Updated documentation X-Git-Tag: AWSTATS_6_6_BETA~51 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c2221b60d788c4e202733471dddc704a41fd1326;p=thirdparty%2FAWStats.git Updated documentation --- diff --git a/docs/awstats_config.html b/docs/awstats_config.html index 949a45e0..39189d29 100644 --- a/docs/awstats_config.html +++ b/docs/awstats_config.html @@ -34,7 +34,7 @@

AWStats configuration directives/options

-
Each directives available in the AWStats config file (.conf) is listed here (with examples and default values).
+
Each directive available in the AWStats config file (.conf) is listed here (with examples and default values).

Notes To include an environment variable in any parameter (AWStats will replace it with its value diff --git a/docs/awstats_faq.html b/docs/awstats_faq.html index ca6796bd..fc52959b 100644 --- a/docs/awstats_faq.html +++ b/docs/awstats_faq.html @@ -135,8 +135,8 @@ Sambar, Roxen, Resin, RealMedia server, Oracle9iAS, Lotus Notes/Domino, D

-FAQ-ABO150 : WHICH LOG FORMAT CAN AWSTATS ANALYZE ?
-AWStats setup knows predefined log format you can use to make AWStats config easier. However, +FAQ-ABO150 : WHICH LOG FORMATS CAN AWSTATS ANALYZE ?
+AWStats setup knows predefined log formats you can use to make AWStats config easier. However, you can define your own log format, that's the reason why AWStats can analyze nearly all web, wap and proxy server log files. Some FTP servers log files, Syslog or mail logs can also be analyzed.
The only requirement is "Your log file must contain required information".
@@ -190,7 +190,7 @@ But, you may find small documentation for other languages made by contributors o If your language is not in this list, you can translate it yourself. For this, find what is your 2 letter language code: here.
Once, you get it, for example "gl" for Galician, copy the file awstats-en.txt into awstats-gl.txt, -in langs directory and translate every sentences inside. You can do same for files inside +in langs directory and translate every sentence inside. You can do same for files inside tooltips_f, tooltips_m and tooltips_w sub-directories. Then send your translated file(s) to eldy@users.sourceforge.net.

@@ -210,7 +210,7 @@ I want to have AWStats statistics but i have no access to my server log file.
SOLUTION:
Because AWStats is a log analyzer, if you don't have any way to read your server log file, you have nothing to analyze and you should not be able to use AWStats. -However, this is a trick that you can use to have a log file be build. You must add +However, this is a trick that you can use to have a log file be built. You must add a tag to call a CGI script like pslogger into each of your web pages. This will allow you to have an artificial log file that can be analyzed by AWStats.
You can find a Perl version of CGI pslogger enhanced by AWStats author here @@ -579,7 +579,7 @@ c-ip
sc-bytes
-To have the change effective, stop your server, remove old log files and restart the server.
+To make the change effective, stop your server, remove old log files and restart the server.
Listen to streaming files and check that your new log file looks like this:
80.223.91.37 2002-10-08 14:18:58 mmst://mydomain.com/mystream 0 106 1 200 {F4A826EE-FA46-480F-A49B-76786320FC6B} 8.0.0.4477 fi-FI - - wmplayer.exe 8.0.0.4477 Windows_2000 5.1.0.2600 Pentium 0 0 20702 mms TCP Windows_Media_Audio_9 - - 277721 @@ -647,9 +647,9 @@ Now you can use AWStats as usual (run the update process and read statistics). SOLUTION:
-The AWStats config file give you all possible values for LogFormat parameter. +The AWStats config file gives you all the possible values for LogFormat parameter. To help you, this is some common cases of log file format, and -the corresponding value for LogFormat you must use in your AWStats config file:
+the corresponding value of LogFormat you must use in your AWStats config file:

If your log records are EXACTLY like this (NCSA combined/XLF/ELF log format):
62.161.78.73 - - [dd/mmm/yyyy:hh:mm:ss +0x00] "GET /page.html HTTP/1.1" 200 1234 "http://www.from.com/from.htm" "Mozilla/4.0 (compatible; MSIE 5.01; Windows NT 5.0)"
@@ -755,7 +755,7 @@ You must use : LogFormat="%host %other %logname %time1 %methodurl %other %cod Note: Browsers, OS's, Keywords and Referers features are not available with a such format.

-There is a lot of other possible log formats.
+There are a lot of other possible log formats.
You must use a personalized log format LogFormat ="..." as described in config file to support other various log formats.


@@ -1048,8 +1048,8 @@ AWStats does not count twice (by default) redirects made by rewrite rules that m log files but that are only one page "viewed".
Etc...

-If you want to check how serious is your log analyzer, try to parse the following log file. -It's a very common log file but results will show you how bad are most log analyzers (above +If you want to check how serious your log analyzer is, try to parse the following log file. +It's a very common log file but results will show you how bad most log analyzers are (above all commercial products):
@@ -1177,7 +1177,7 @@ where TZ is value of your signed timezone (+2 for Paris, -8 for ...)


-FAQ-COM320 : WHAT DOES MEAN "EU" (EUROPEAN COUNTRY)" IN GEOIP COUNTRY REPORTS ?
+FAQ-COM320 : WHAT DOES "EU" (EUROPEAN COUNTRY)" MEAN IN GEOIP COUNTRY REPORTS ?
PROBLEM:
I use the AWStats GeoIp country plugins to report countries according to geolocalisation of IP address. @@ -1201,23 +1201,23 @@ You must change your LogFile parameter the update (or use the -LogFile option on command line to overwrite LogFile parameter). The update process can only accept files in chronological order for a particular month, so if you have already processed a recent file and forgot to run update -on a log file that contains older data, you must before reset all -your statistics (see FAQ-COM500) and restart all the update processes +on a log file that contains older data, you must reset all of +your statistics (see FAQ-COM500) and restart all of the update processes for all past log files and in chronological order.
-However, there is a "tip" that allow you to rebuild only the month were you missed data:
+However, there is a "tip" that allows you to rebuild only the month were you missed data:
Imagine we are on 5th of July 2003, all your statistics are up to date except for the 10th of April 2003 (you forgot to run the update process for this day, so there is no visit for this day). You can :
- Reset the statistics for April only (this means remove the file awstats042003.[config.]txt as explained in FAQ-COM500),
-- Move the statistics history files for month after April (file awstats052003.[config.]txt, -awstats062003.[config.]txt,...) into a temp directory (so that it is no more in DirData -directory as if they were deleted).
-- Run update process on all log files for April (in chronological order). AWStats does not +- Move the statistics history files for the month after April (file awstats052003.[config.]txt, +awstats062003.[config.]txt,...) into a temp directory (so that it is no longer in the DirData +directory; as if they were deleted).
+- Run the update process on all log files for April (in chronological order). AWStats does not complain about "too old record" because there is no history files in DirData directory that contains compiled data more recent than records into log you process.
- Moved back the month history files you saved into your DirData directory.
-Your statistics are up to date and the missing days are no more missing.
+Your statistics are up to date and the missing days are no longer missing.


@@ -1234,7 +1234,7 @@ LogFile="/pathto/logresolvemerge.pl mylog*.log |"

Logresolvemerge is a tool provided with -AWStats (in tools directory) that merge several log files on the fly. It opens pointer on each files +AWStats (in tools directory) that merges several log files on the fly. It opens a pointer on each file and sends, line by line, the oldest record from this. Using such a tool as a pipe source for AWStats LogFile parameter is a very good solution because, it allows you to merge log files whatever their size with no memory use, no hard disk use (no temporary files built), it is fast, it prevents diff --git a/docs/awstats_setup.html b/docs/awstats_setup.html index 70315b17..0e1aeda2 100644 --- a/docs/awstats_setup.html +++ b/docs/awstats_setup.html @@ -2,48 +2,48 @@ - + AWStats Documentation - Setup page - - - - - -

- AWStats logfile analyzer 6.5 Documentation
+ + + + + + - + - +

+ AWStats logfile analyzer 6.5 Documentation

   
-
-
-

AWStats -Installation, Configuration and Reporting

-There are 3 steps to begin using AWStats:
+
+
+

AWStats +Installation, Configuration and Reporting

+There are 3 steps to begin using AWStats:

@@ -53,529 +53,529 @@ Before starting, check that your Perl version is at least 5.005_03 (or higher) b If not, you can install a recent Perl interpreter from ActivePerl (Win32) or Perl.com (Unix/Linux/Other).
-->
- -

I. Setup: Installation and configuration using -awstats_configure.pl

-

-A) Setup for an Apache or compatible web -server (on Unix/Linux, Windows, MacOS...)
-
-* Step 1:
-
-(if you use a package provided with a Linux distribution or Windows -installer, step 1 -might have already been done; if you don't know, you can run this step -again)
-
-After downloading and extracting the AWStats package, you should run -the awstats_configure.pl script to do + +

I. Setup: Installation and configuration using +awstats_configure.pl

+

+A) Setup for an Apache or compatible web +server (on Unix/Linux, Windows, MacOS...)
+
+* Step 1:
+
+(if you use a package provided with a Linux distribution or Windows +installer, step 1 +might have already been done; if you don't know, you can run this step +again)
+
+After downloading and extracting the AWStats package, you should run +the awstats_configure.pl script to do several setup actions. -You will find it in the AWStats tools directory (If using the -Windows installer, the script is +You will find it in the AWStats tools directory (If using the +Windows installer, the script is automatically launched):
perl awstats_configure.pl

    - This is what the script does/asks (you can do all these steps -manually instead of running awstats_configure.pl if you prefer):
    + This is what the script does/asks (you can do all these steps +manually instead of running awstats_configure.pl if you prefer):

    -A) awstats_configure.pl tries to determine your current log format from -your Apache web server -configuration file httpd.conf (it asks for the path if not found). +A) awstats_configure.pl tries to determine your current log format from +your Apache web server +configuration file httpd.conf (it asks for the path if not found). If you use a common log, awstats_configure.pl will -suggest changing it to the NCSA combined/XLF/ELF format (you -can use your own custom log -format but this predefined log format is often the best choice and -makes setup easier).
    -If you answer yes, awstats_configure.pl will modify your httpd.conf, -changing the -following directive:
    - from
    -CustomLog /yourlogpath/yourlogfile common

    -to
    +suggest changing it to the NCSA combined/XLF/ELF format (you +can use your own custom log +format but this predefined log format is often the best choice and +makes setup easier).
    +If you answer yes, awstats_configure.pl will modify your httpd.conf, +changing the +following directive:
    + from
    +CustomLog /yourlogpath/yourlogfile common

    +to
    CustomLog /yourlogpath/yourlogfile combined

    -See the Apache manual for more information on this directive (possibly -installed on your server as www.mysite.com/manual).
    -
    -B) awstats_configure.pl will then add, if not already present, the -following directives to your Apache configuration file -(note that the "/usr/local/awstats/wwwroot" path might differ according -to your distribution or OS:
    -
    -#
    -# Directives to add to your Apache conf file to allow use of AWStats as -a CGI.
    -# Note that path "/usr/local/awstats/" must reflect your AWStats -Installation path.
    -#
    -Alias /awstatsclasses "/usr/local/awstats/wwwroot/classes/"
    -Alias /awstatscss "/usr/local/awstats/wwwroot/css/"
    -Alias /awstatsicons "/usr/local/awstats/wwwroot/icon/"
    -ScriptAlias /awstats/ "/usr/local/awstats/wwwroot/cgi-bin/"
    -#
    -# This is to permit URL access to scripts/files in AWStats directory.
    -#
    -<Directory "/usr/local/awstats/wwwroot">
    -Options None
    -AllowOverride None
    -Order allow,deny
    -Allow from all
    -</Directory>

    -
    -C) if changes were made as indicated in parts A and B, -awstats_configure.pl restarts Apache to apply the changes.  To be -sure the log format change is effective, go to your homepage. This is -an example of the type of records you should see inserted in your new -log file after Apache -was restarted:
    -
    -62.161.78.75 - - [dd/mmm/yyyy:hh:mm:ss +0000] "GET / HTTP/1.1" 200 1234 -"http://www.from.com/from.html" "Mozilla/4.0 (compatible; MSIE 5.01; -Windows NT 5.0)"
    -
    -D) awstats_configure.pl will ask you for a name for the configuration -profile file. Enter an appropriate name such as that of your -web server or the virtual domain to be analyzed, i.e. mysite.
    -
    -awstats_configure.pl will create a new file called awstats.mysite.conf -by copying the template file awstats.model.conf. -The new file location is:
    +See the Apache manual for more information on this directive (possibly +installed on your server as www.mysite.com/manual).
    +
    +B) awstats_configure.pl will then add, if not already present, the +following directives to your Apache configuration file +(note that the "/usr/local/awstats/wwwroot" path might differ according +to your distribution or OS:
    +
    +#
    +# Directives to add to your Apache conf file to allow use of AWStats as +a CGI.
    +# Note that path "/usr/local/awstats/" must reflect your AWStats +Installation path.
    +#
    +Alias /awstatsclasses "/usr/local/awstats/wwwroot/classes/"
    +Alias /awstatscss "/usr/local/awstats/wwwroot/css/"
    +Alias /awstatsicons "/usr/local/awstats/wwwroot/icon/"
    +ScriptAlias /awstats/ "/usr/local/awstats/wwwroot/cgi-bin/"
    +#
    +# This is to permit URL access to scripts/files in AWStats directory.
    +#
    +<Directory "/usr/local/awstats/wwwroot">
    +Options None
    +AllowOverride None
    +Order allow,deny
    +Allow from all
    +</Directory>

    +
    +C) if changes were made as indicated in parts A and B, +awstats_configure.pl restarts Apache to apply the changes.  To be +sure the log format change is effective, go to your homepage. This is +an example of the type of records you should see inserted in your new +log file after Apache +was restarted:
    +
    +62.161.78.75 - - [dd/mmm/yyyy:hh:mm:ss +0000] "GET / HTTP/1.1" 200 1234 +"http://www.from.com/from.html" "Mozilla/4.0 (compatible; MSIE 5.01; +Windows NT 5.0)"
    +
    +D) awstats_configure.pl will ask you for a name for the configuration +profile file. Enter an appropriate name such as that of your +web server or the virtual domain to be analyzed, i.e. mysite.
    +
    +awstats_configure.pl will create a new file called awstats.mysite.conf +by copying the template file awstats.model.conf. +The new file location is:
    - For Linux/BSD/Unix users: /etc/awstats.
    -- For Mac OS X, Windows and other operating systems: the same directory -as awstats.pl -(cgi-bin).
    +- For Mac OS X, Windows and other operating systems: the same directory +as awstats.pl +(cgi-bin).

    E) awstats_configure.pl ends.

-* Step 2:
-
-Once a configuration file has been created (by -awstats_configure.pl, by your package -installer or just by a manual copy of awstats.model.conf), it's -important to verify that the "MAIN PARAMETERS" -match your needs.  Open awstats.mysite.conf in -your favorite text editor (i.e. notepad.exe, vi, gedit, etc) - -don´t use a word processor - and make changes as required.
-
-Particular attention should be given to these parameters:
-- Verify the LogFile -value.  It should be the full path of your server log file (You -can also use a relative path from your awstats.pl directory, but a full -path avoids errors).
-- Verify the LogType -value.  It should be "W" for analyzing -web log files.
-- Check if LogFormat is -set to "1" (for "NCSA apache combined/ELF/XLF log format") -or use a custom log format if you don't use the combined log format.
-- Set the SiteDomain -parameter to the main domain name or the intranet web server name -used to reach the web site to analyze (Example: www.mysite.com). If -you have several -possible names for same site, use the main domain name and add the -others to the list in the HostAlias -parameter.
-- You can also change other parameters if you want. The full list is -described in Configurations/Directives -options page.
-
-Installation and configuration is finished. You can jump to the Process logs: Building/updating statistics -database section.
+* Step 2:
+
+Once a configuration file has been created (by +awstats_configure.pl, by your package +installer or just by a manual copy of awstats.model.conf), it's +important to verify that the "MAIN PARAMETERS" +match your needs.  Open awstats.mysite.conf in +your favorite text editor (i.e. notepad.exe, vi, gedit, etc) - +don´t use a word processor - and make changes as required.
+
+Particular attention should be given to these parameters:
+- Verify the LogFile +value.  It should be the full path of your server log file (You +can also use a relative path from your awstats.pl directory, but a full +path avoids errors).
+- Verify the LogType +value.  It should be "W" for analyzing +web log files.
+- Check if LogFormat is +set to "1" (for "NCSA apache combined/ELF/XLF log format") +or use a custom log format if you don't use the combined log format.
+- Set the SiteDomain +parameter to the main domain name or the intranet web server name +used to reach the web site to analyze (Example: www.mysite.com). If +you have several +possible names for same site, use the main domain name and add the +others to the list in the HostAlias +parameter.
+- You can also change other parameters if you want. The full list is +described in Configurations/Directives +options page.
+
+Installation and configuration is finished. You can jump to the Process logs: Building/updating statistics +database section.



-B) Setup for Microsoft's IIS server
-
-* Step 1:
-
-Configure IIS to log in the "Extended W3C log format" (You can -still use -your own custom log format but setup is easier if you use the standard -extended format). To do so, start the IIS management console snap-in, -select the -appropriate web site and open its -Properties. Choose "W3C Extended Log Format", then Properties, then the -Tab "Extended Properties" and -uncheck everything under Extended -Properties. -Once they are all cleared, check just the following fields:
+B) Setup for Microsoft's IIS server
+
+* Step 1:
+
+Configure IIS to create logs in the "Extended W3C log format" (You can +still use +your own custom log format but setup is easier if you use the standard +extended format). To do so, start the IIS management console snap-in, +select the +appropriate web site and open its +Properties. Choose "W3C Extended Log Format", then Properties, then the +Tab "Extended Properties" and +uncheck everything under Extended +Properties. +Once they are all cleared, check just the following fields:
-date
-time
-c-ip
-cs-username
-cs-method
-cs-uri-stem
-cs-uri-query
-sc-status
-sc-bytes
-cs-version
-cs(User-Agent)
-cs(Referer)
+date
+time
+c-ip
+cs-username
+cs-method
+cs-uri-stem
+cs-uri-query
+sc-status
+sc-bytes
+cs-version
+cs(User-Agent)
+cs(Referer)
-
-To be sure the log format change is effective, you must stop IIS, -backup (if desired) and remove all old log files, restart IIS and go to -your homepage. This is an example of the type of records you should -find in the -new log file:
+
+To be sure the log format change is effective, you must stop IIS, +backup it up (if you desire) and remove all of the old log files, restart IIS and go to +your homepage. This is an example of the type of records you should +find in the +new log file:
-2000-07-19 14:14:14 62.161.78.73 - GET / 200 1234 HTTP/1.1 -Mozilla/4.0+(compatible;+MSIE+5.01;+Windows+NT+5.0) -http://www.from.com/from.htm +2000-07-19 14:14:14 62.161.78.73 - GET / 200 1234 HTTP/1.1 +Mozilla/4.0+(compatible;+MSIE+5.01;+Windows+NT+5.0) +http://www.from.com/from.htm

-* Step 2:
-
-Copy the contents of the AWStats provided cgi-bin folder from where -your AWStats package put it on your local hard -drive -to your server's cgi-bin -directory (this includes awstats.pl, awstats.model.conf, -and the lang, lib and plugins sub-directories).
-
-* Step 3:
-
-Move AWStats icon sub-directories and its content into a -directory readable by your -web server, for example C:\yourwwwroot\icon.
-
-* Step 4:
-
-Create a configuration file by copying awstats.model.conf to a -new file named awstats.mysite.conf -where "mysite" is a -value of your choice but usually is the domain or virtual host name. -This new file must be saved in the same directory as awstats.pl (i.e. -cgi-bin).
-
-* Step 5:
-
-Edit your new awstats.mysite.conf -file to match your specific environment:
-- Change the LogFile value -to the -full path of your web server log file (You -can also use a relative path from your awstats.pl (cgi-bin) directory).
-- Change the LogType value -to -"W" for analyzing -web log files.
-- Change the LogFormat to -2 if you are using the "Extended W3C log format" described in -step 1; in the case of a custom format, list the IIS fields -being logged, for example:
-LogFormat="date time c-ip cs-username cs-method cs-uri-stem -cs-uri-query sc-status sc-bytes cs-version cs(User-Agent) cs(Referer)"
-- Change the DirIcons -parameter -to reflect relative path of icon directory.
-- Set the SiteDomain -parameter to the main domain name or the intranet -web server name used to reach the web site being analyzed (Example: -www.mydomain.com).
-- Set the AllowToUpdateStatsFromBrowser -parameter to 1 if you don't have command line access and have only cgi -access.
-- Review and change other parameters if appropriate.
-
-Installation and configuration is finished. You can jump to the Process logs: Building/Updating statistics -database section.
-
-C) Setup for other web servers
-
-The setup process is similar to the setup for Apache or IIS.
-Use LogFormat to value "3" -if you have WebStar native log format, use -a personalized LogFormat -if your log format is other.
-
-D) Setup for other Internet servers, i.e. FTP, Mail, Streaming media
-
-The setup process for other file formats is described in the relevant -FAQ topics:  -FAQ-COM090: FTP  -FAQ-COM100: Mail and FAQ-COM110: Streaming media.
-
+* Step 2:
+
+Copy the contents of the AWStats provided cgi-bin folder, from where +the AWStats package put it on your local hard +drive, +to your server's cgi-bin +directory (this includes awstats.pl, awstats.model.conf, +and the lang, lib and plugins sub-directories).
+
+* Step 3:
+
+Move AWStats icon sub-directories and its content into a +directory readable by your +web server, for example C:\yourwwwroot\icon.
+
+* Step 4:
+
+Create a configuration file by copying awstats.model.conf to a +new file named awstats.mysite.conf +where "mysite" is a +value of your choice but usually is the domain or virtual host name. +This new file must be saved in the same directory as awstats.pl (i.e. +cgi-bin).
+
+* Step 5:
+
+Edit your new awstats.mysite.conf +file to match your specific environment:
+- Change the LogFile value +to the +full path of your web server log file (You +can also use a relative path from your awstats.pl (cgi-bin) directory).
+- Change the LogType value +to +"W" for analyzing +web log files.
+- Change the LogFormat to +2 if you are using the "Extended W3C log format" described in +step 1; in the case of a custom format, list the IIS fields +being logged, for example:
+LogFormat="date time c-ip cs-username cs-method cs-uri-stem +cs-uri-query sc-status sc-bytes cs-version cs(User-Agent) cs(Referer)"
+- Change the DirIcons +parameter +to reflect relative path of icon directory.
+- Set the SiteDomain +parameter to the main domain name or the intranet +web server name used to reach the web site being analyzed (Example: +www.mydomain.com).
+- Set the AllowToUpdateStatsFromBrowser +parameter to 1 if you don't have command line access and have only cgi +access.
+- Review and change other parameters if appropriate.
+
+Installation and configuration is finished. You can jump to the Process logs: Building/Updating statistics +database section.
+
+C) Setup for other web servers
+
+The setup process is similar to the setup for Apache or IIS.
+Use LogFormat to value "3" +if you have WebStar native log format. +Use a personalized LogFormat +if your log format is other.
+
+D) Setup for other Internet servers, i.e. FTP, Mail, Streaming media
+
+The setup process for other file formats is described in the relevant +FAQ topics:  +FAQ-COM090: FTP  +FAQ-COM100: Mail and FAQ-COM110: Streaming media.
+

- -

II. Process logs: Building/updating statistics database

-

-* Update from command line (recommanded):
-
-The first log analysis should be done -manually from the command line since the -process may be long and it's easier to solve problems when you can see -the -command output (if you don't -have Command Line access, skip to Step 2). The -AWStats create (and update) statistics database command is:
-
+ +

II. Process logs: Building/updating statistics database

+

+* Update from command line (recommanded):
+
+The first log analysis should be done +manually from the command line since the +process may be long and it's easier to solve problems when you can see +the +command output (if you don't +have Command Line access, skip to Step 2). The +AWStats create (and update) statistics database command is:
+
perl awstats.pl -config=mysite -update -
-
-where mysite must -be substituted with the domain/virtual host name you selected earlier -during AWStats configuration.
-
-AWStats will read the configuration file awstats.mysite.conf -(or if -not found, awstats.conf) -and create/update its database with all summary information issued from -analyzed log file.
-
-AWStats statistics database files are saved in directory defined by the -DirData parameter in -configuration file.
-When the create/update is finished, you should see a similar result on -your screen:
-
+
+
+where mysite must +be substituted with the domain/virtual host name you selected earlier +during AWStats configuration.
+
+AWStats will read the configuration file awstats.mysite.conf +(or if +not found, awstats.conf) +and create/update its database with all summary information issued from +analyzed log file.
+
+AWStats statistics database files are saved in directory defined by the +DirData parameter in +configuration file.
+When the create/update is finished, you should see a similar result on +your screen:
+
-Update for config "/etc/awstats/awstats.mysite.conf"
+Update for config "/etc/awstats/awstats.mysite.conf"
With data in log file "/pathtoyourlog/yourlog.log"...
Phase 1 : First bypass old records, searching new record...
Searching new records from beginning of log file...
-Phase 2 : Now process new records (Flush history on disk after 20000 -hosts)...
+Phase 2 : Now process new records (Flush history on disk after 20000 +hosts)...
Jumped lines in file: 0
Parsed lines in file: 225730
 Found 122 dropped records,
 Found 87 corrupted records,
 Found 0 old records,
- Found 225521 new qualified records.
+ Found 225521 new qualified records.

-Dropped records are records discarded because they were not -"user HTTP requests" or were requests matching AWStats filters (See the -SkipHosts, -SkipUserAgents, -SkipFiles, OnlyHosts, -OnlyUserAgents and OnlyFiles parameters). -If you want to see which lines were dropped, you can add the -showdropped -option on the command line.
-
-Corrupted records are records that does not match log format -defined by "LogFormat" parameter in AWStats configuration file. -All web servers will typically have a few corrupted records -(<5%) even when everything works correctly. -This can result for several reasons: 1) Web server internal bugs, -2) bad requests made by buggy browsers, 3) a dirty web server shutdown, -such as unplugging the server... 
-
-If all your lines are corrupted and the LogFormat parameter in -AWStats configuration file is -correct, there may be a setup problem with your web server log format. -Don't forget that -your LogFormat parameter -in the AWStats configuration file MUST match -the log file format you analyze.  If you want to see which lines -are corrupted, you can add the -showcorrupted -option on the command line.
-
-Old records are simply records that were already processed by a -previous update session. -Although it is not necessary to purge your log file after -each update process, it is highly recommended that you do so as often -as possible.
-
-New records are records in your log file that were successfully -used to build/update the statistics database.
-
-Note: A log analysis process might be slow (one second for each 4500 -lines of your -logfile with an Athlon 1Ghz, plus DNS resolution time for each -different -IP -address in your logfile if DNSLookup -is set to 1 and not already done in your log file).  See the Benchmarks page for more detailed -information.
-
- - -
-* Update from a browser:
-
-AWStats statistics can also be updated from a browser, providing -real-time statistics, by clicking -the "Update now" link that appears when AWStats is used as a CGI (The -URL is described in the next -section 'Run reports: Building and reading reports').
+Dropped records are records discarded because they were not +"user HTTP requests" or were requests matching AWStats filters (See the +SkipHosts, +SkipUserAgents, +SkipFiles, OnlyHosts, +OnlyUserAgents and OnlyFiles parameters). +If you want to see which lines were dropped, you can add the -showdropped +option on the command line.
+
+Corrupted records are records that do not match the log format +defined by the "LogFormat" parameter in the AWStats configuration file. +All web servers will typically have a few corrupted records +(<5%) even when everything works correctly. +This can result for several reasons: 1) Web server internal bugs, +2) bad requests made by buggy browsers, 3) a dirty web server shutdown, +such as unplugging the server... 
+
+If all of your lines are corrupted and the LogFormat parameter in +AWStats configuration file is +correct, then there may be a setup problem with your web server log format. +Don't forget that +your LogFormat parameter +in the AWStats configuration file MUST match +the log file format you analyze.  If you want to see which lines +are corrupted, you can add the -showcorrupted +option on the command line.
+
+Old records are simply records that were already processed by a +previous update session. +Although it is not necessary to purge your log file after +each update process, it is highly recommended that you do so as often +as possible.
+
+New records are records in your log file that were successfully +used to build/update the statistics database.
+
+Note: A log analysis process might be slow (one second for each 4500 +lines of your +logfile with an Athlon 1Ghz, plus DNS resolution time for each +different +IP +address in your logfile if DNSLookup +is set to 1 and not already done in your log file).  See the Benchmarks page for more detailed +information.
+
+ + +
+* Update from a browser:
+
+AWStats statistics can also be updated from a browser, providing +real-time statistics, by clicking +the "Update now" link that appears when AWStats is used as a CGI (The +URL is described in the next +section 'Run reports: Building and reading reports').

Warning!!
-To enable this link, the configuration file parameter AllowToUpdateStatsFromBrowser -must be set to 1 (The link is not enabled by -default).
-Using the on-line update does not prevent you from running the update -process automatically on a scheduled basis (the command is same as that -of the first update process above).
+To enable this link, the configuration file parameter AllowToUpdateStatsFromBrowser +must be set to 1 (The link is not enabled by +default).
+Using the on-line update does not prevent you from running the update +process automatically on a scheduled basis (the command is same as that +of the first update process above).
For this, you have two choices:
-- Include the update command in your logrotate process. See FAQ-COM120 for details.
-- Or add instructions in your crontab (Unix/Linux) or your task -scheduler (Windows), to regularly launch the Awstats update -process. See FAQ-COM130 for -details.
-
-See the AWStats Benchmarks page -for -the recommended update/logrotate frequency.
+- Include the update command in your logrotate process. See FAQ-COM120 for details.
+- Or add instructions in your crontab (Unix/Linux) or your task +scheduler (Windows), to regularly launch the Awstats update +process. See FAQ-COM130 for +details.
+
+See the AWStats Benchmarks page +for +the recommended update/logrotate frequency.


- -

III. Run reports: Building and reading reports

-

-To see the analysis results, you have several options depending on your -security policy.
-
-Note: you must have created a statistics data base for the analysis -period by processing your -log files before you try to create reports.  See the previous -section.
-
-1. The first option is to build the main reports, in a static HTML -page, -from the command line, -using the following syntax (skip to the second option if you only have -CGI access):
-
+ +

III. Run reports: Building and reading reports

+

+To see the analysis results, you have several options depending on your +security policy.
+
+Note: you must have created a statistics data base for the analysis +period by processing your +log files before you try to create reports.  See the previous +section.
+
+1. The first option is to build the main reports, in a static HTML +page, +from the command line, +using the following syntax (skip to the second option if you only have +CGI access):
+
-perl awstats.pl -config=mysite -output -staticlinks -> awstats.mysite.html +perl awstats.pl -config=mysite -output -staticlinks +> awstats.mysite.html
-
-where mysite must -be substituted with the domain/virtual host name you selected earlier -during AWStats configuration.
-
-To create specific individual reports, specify the report name on the -command -line as follows¹:
+
+where mysite must +be substituted with the domain/virtual host name you selected earlier +during AWStats configuration.
+
+To create specific individual reports, specify the report name on the +command +line as follows¹:
-perl awstats.pl -config=mysite -output=alldomains --staticlinks > awstats.mysite.alldomains.html
-perl awstats.pl -config=mysite -output=allhosts --staticlinks > awstats.mysite.allhosts.html
-perl awstats.pl -config=mysite -output=lasthosts --staticlinks > awstats.mysite.lasthosts.html
-perl awstats.pl -config=mysite -output=unknownip --staticlinks > awstats.mysite.unknownip.html
-perl awstats.pl -config=mysite -output=alllogins --staticlinks > awstats.mysite.alllogins.html
-perl awstats.pl -config=mysite -output=lastlogins --staticlinks > awstats.mysite.lastlogins.html
-perl awstats.pl -config=mysite -output=allrobots --staticlinks > awstats.mysite.allrobots.html
-perl awstats.pl -config=mysite -output=lastrobots --staticlinks > awstats.mysite.lastrobots.html
-perl awstats.pl -config=mysite -output=urldetail --staticlinks > awstats.mysite.urldetail.html
-perl awstats.pl -config=mysite -output=urlentry --staticlinks > awstats.mysite.urlentry.html
-perl awstats.pl -config=mysite -output=urlexit --staticlinks > awstats.mysite.urlexit.html
-perl awstats.pl -config=mysite -output=browserdetail --staticlinks > awstats.mysite.browserdetail.html
-perl awstats.pl -config=mysite -output=osdetail --staticlinks > awstats.mysite.osdetail.html
-perl awstats.pl -config=mysite -output=unknownbrowser --staticlinks > awstats.mysite.unknownbrowser.html
-perl awstats.pl -config=mysite -output=unknownos --staticlinks > awstats.mysite.unknownos.html
-perl awstats.pl -config=mysite -output=refererse --staticlinks > awstats.mysite.refererse.html
-perl awstats.pl -config=mysite -output=refererpages --staticlinks > awstats.mysite.refererpages.html
-perl awstats.pl -config=mysite -output=keyphrases --staticlinks > awstats.mysite.keyphrases.html
-perl awstats.pl -config=mysite -output=keywords --staticlinks > awstats.mysite.keywords.html
-perl awstats.pl -config=mysite -output=errors404 --staticlinks > awstats.mysite.errors404.html
+perl awstats.pl -config=mysite -output=alldomains +-staticlinks > awstats.mysite.alldomains.html
+perl awstats.pl -config=mysite -output=allhosts +-staticlinks > awstats.mysite.allhosts.html
+perl awstats.pl -config=mysite -output=lasthosts +-staticlinks > awstats.mysite.lasthosts.html
+perl awstats.pl -config=mysite -output=unknownip +-staticlinks > awstats.mysite.unknownip.html
+perl awstats.pl -config=mysite -output=alllogins +-staticlinks > awstats.mysite.alllogins.html
+perl awstats.pl -config=mysite -output=lastlogins +-staticlinks > awstats.mysite.lastlogins.html
+perl awstats.pl -config=mysite -output=allrobots +-staticlinks > awstats.mysite.allrobots.html
+perl awstats.pl -config=mysite -output=lastrobots +-staticlinks > awstats.mysite.lastrobots.html
+perl awstats.pl -config=mysite -output=urldetail +-staticlinks > awstats.mysite.urldetail.html
+perl awstats.pl -config=mysite -output=urlentry +-staticlinks > awstats.mysite.urlentry.html
+perl awstats.pl -config=mysite -output=urlexit +-staticlinks > awstats.mysite.urlexit.html
+perl awstats.pl -config=mysite -output=browserdetail +-staticlinks > awstats.mysite.browserdetail.html
+perl awstats.pl -config=mysite -output=osdetail +-staticlinks > awstats.mysite.osdetail.html
+perl awstats.pl -config=mysite -output=unknownbrowser +-staticlinks > awstats.mysite.unknownbrowser.html
+perl awstats.pl -config=mysite -output=unknownos +-staticlinks > awstats.mysite.unknownos.html
+perl awstats.pl -config=mysite -output=refererse +-staticlinks > awstats.mysite.refererse.html
+perl awstats.pl -config=mysite -output=refererpages +-staticlinks > awstats.mysite.refererpages.html
+perl awstats.pl -config=mysite -output=keyphrases +-staticlinks > awstats.mysite.keyphrases.html
+perl awstats.pl -config=mysite -output=keywords +-staticlinks > awstats.mysite.keywords.html
+perl awstats.pl -config=mysite -output=errors404 +-staticlinks > awstats.mysite.errors404.html
-
-¹If you prefer, you can use the awstats_buildstaticpages -tool to -build all these pages in one command, or to generate PDF files.
-
-Notes:
-
-a) You can also add a filter on the following reports: urldetail, -urlentry, urlexit, allhosts, refererpages.  The filter -can be a regexp (regular expression) on the full key you want AWStats -to report on and is appended to the output +
+¹If you prefer, you can use the awstats_buildstaticpages +tool to +build all these pages in one command, or to generate PDF files.
+
+Notes:
+
+a) You can also add a filter on the following reports: urldetail, +urlentry, urlexit, allhosts, refererpages.  The filter +can be a regexp (regular expression) on the full key you want AWStats +to report on and is appended to the output parameter separated by a ":".
-
-For example, to output the urldetail report, including only pages which -contain /news in their URL, you +
+For example, to output the urldetail report, including only pages which +contain /news in their URL, you can use the following command line:
-perl awstats.pl -config=mysite -output=urldetail:/news --staticlinks > awstats.mysite.urldetailwithfilter.html +perl awstats.pl -config=mysite -output=urldetail:/news +-staticlinks > awstats.mysite.urldetailwithfilter.html
-
-b) If you want to build a report for a particular month, add -the options -month=MM -year=YYYY where MM is the month -expressed as two digits, i.e. 03, and year is the four digit -year.  To build a -report for a full year, add the options -month=all -year=YYYY -(warning: this is often resource intensive and might use a lot of -memory -and CPU.  Unix/Linux like operating systems might benefit from use -of the "nice" command.)
-
-
-2) The second option is to dynamically view your statistics from a -browser.  To do this, use the URL:
+
+b) If you want to build a report for a particular month, add +the options -month=MM -year=YYYY where MM is the month +expressed as two digits, i.e. 03, and year is the four digit +year.  To build a +report for a full year, add the options -month=all -year=YYYY +(warning: this is often resource intensive and might use a lot of +memory +and CPU.  Unix/Linux like operating systems might benefit from use +of the "nice" command.)
+
+
+2) The second option is to dynamically view your statistics from a +browser.  To do this, use the URL:
-http://www.myserver.mydomain/awstats/awstats.pl?config=mysite +http://www.myserver.mydomain/awstats/awstats.pl?config=mysite
-
-where mysite specifies the configuration -file to -use (AWStats will use the file awstats.mysite.conf).
-
-All output command line options (except -staticlinks) are -also available when using AWStats with a browser. Just use them as URL -parameters: change "-option" to -"&option", i.e.  http://www.myserver.mydomain/awstats/awstats.pl?month=MM&year=YYYY&output=unknownos
-
-Reports are generated in real time from the statistics data -base.  If this is slow, or putting too much load on your server, -consider generating static reports instead.
-
-If the AllowToUpdateStatsFromBrowser -parameter is set to 1 in AWStats configuration file, -you will also be able to run the update process from your browser. Just -click on the link "Update now".
-
+
+where mysite specifies the configuration +file to +use (AWStats will use the file awstats.mysite.conf).
+
+All output command line options (except -staticlinks) are +also available when using AWStats with a browser. Just use them as URL +parameters: change "-option" to +"&option", i.e.  http://www.myserver.mydomain/awstats/awstats.pl?month=MM&year=YYYY&output=unknownos
+
+Reports are generated in real time from the statistics data +base.  If this is slow, or putting too much load on your server, +consider generating static reports instead.
+
+If the AllowToUpdateStatsFromBrowser +parameter is set to 1 in AWStats configuration file, +you will also be able to run the update process from your browser. Just +click on the link "Update now".
+


- diff --git a/docs/awstats_tools.html b/docs/awstats_tools.html index 52d559c7..c693fb6b 100644 --- a/docs/awstats_tools.html +++ b/docs/awstats_tools.html @@ -130,7 +130,7 @@ All those tools are available in tools directory of AWStats distribution.
OF DISK SPACE AT ALL) and without loading files into memory (NO NEED
OF MORE MEMORY). Choose of output records is done on the fly.
-
So logresolvemerge is particularly usefull when you want to output several +
So logresolvemerge is particularly useful when you want to output several
and/or large log files in a fast process, with no use of disk or
more memory and in a chronological order through a pipe (to be used by a log
analyzer. @@ -144,7 +144,7 @@ All those tools are available in tools directory of AWStats distribution.
can't run this tool on Win or Unix platforms.

WARNING: Because of important memory holes in ActiveState Perl version, use -
another Perl interpreter if you need to process large lof files. +
another Perl interpreter if you need to process large log files.

Now supports/detects:
Automatic detection of log format