]> git.ipfire.org Git - thirdparty/AWStats.git/commitdiff
Updated documentation.
authoreldy <>
Sun, 4 Jan 2004 21:28:24 +0000 (21:28 +0000)
committereldy <>
Sun, 4 Jan 2004 21:28:24 +0000 (21:28 +0000)
docs/awstats_benchmark.html
docs/awstats_config.html
wwwroot/cgi-bin/awstats.model.conf

index cf07bafe0de6608362b94e57bd3deaf22292d8a5..b73a04efa2de73869417bbaad52bc50f40754872 100644 (file)
@@ -41,12 +41,12 @@ AWStats speed depends on AWStats version and options/setup you use in configurat
 
 <br>
 <br>
-<b><u>This is benchmark results with AWStats version 5.3 and a common configuration:</u></b><br>
+<b><u>This is benchmark results with AWStats version 6.0 and a common configuration:</u></b><br>
 <br>
-HARDWARE: Athlon 1 GHz / 128Mb<br>
-SOFTWARE: Windows 2000 / Perl 5.8 (Standard Perl)<br>
+HARDWARE: Athlon 1 GHz / 256MB<br>
+SOFTWARE: Windows 2000 / Perl 5.8 (Cygwin Perl)<br>
 CONFIG OPTIONS: Default values were used: <a href="awstats_config.html#LogFormat">LogFormat</a>=1, <a href="awstats_config.html#DNSLookup">DNSLookup</a>=0, <a href="awstats_config.html#URLWithQuery">URLWithQuery</a>=0, <a href="awstats_config.html#URLReferrerWithQuery">URLReferrerWithQuery</a>=0, <a href="awstats_config.html#URLWithAnchor">URLWithAnchor</a>=0, No plugins<br>
-AVERAGE SPEED: <b>4500</b> lines by seconds<br>
+AVERAGE SPEED: <b>5200</b> lines by seconds<br>
 Other times for different kind of web sites sizes are shown later in this page...<br>
 
 <br>
@@ -73,19 +73,19 @@ Take a look at the following chart to:<br>
 <b><u>This is examples of frequency/parameters you should use to have a good use of AWStats:</u></b><br>
 <br>
 <table border=1 cellspacing=0 cellpadding=2 style="font: 12px; arial,verdana">
-<tr bgcolor=#EEEEEE><td rowspan=2>Your Web site traffic</td><td colspan=3>Recommended values for parameters</td><td rowspan=2>Recommended update frequency<br>(Rotate log delay)</td><td rowspan=2>Memory required**</td><td rowspan=2>Duration***</td></tr>
+<tr bgcolor=#EEEEEE><td rowspan=2>Your Web site traffic</td><td rowspan=2>Perl distrib</td><td colspan=3>Values for parameters</td><td rowspan=2>Recommended update frequency<br>(Rotate log delay)</td><td rowspan=2>Memory required**</td><td rowspan=2>Update process duration***</td></tr>
 <tr bgcolor=#EEEEEE><td>DNSLookup*</td><td>URLWithQuery</td><td>URLReferrerWithQuery</td></tr>
-<tr><td rowspan=2>     0 -     1,000 visits/month</td><td>1</td><td>0 or 1</td><td>0 or 1</td><td>Once a day<br>Log files are 0-1 MB<br>2000 lines to process</td><td>4 MB free</td><td>2mn</td></tr>
-<tr>                                                <td>0 (or 2)</td><td>0 or 1</td><td>0 or 1</td><td>Once a day<br>Log files are 0-1 MB<br>2000 lines to process</td><td>4 MB free</td><td>1s</td></tr>
-<tr><td rowspan=2> 1,000 -    10,000 visits/month</td><td>1</td><td>0 or 1</td><td>0 or 1</td><td>Once a day<br>Log files are 1-10 MB<br>2000-20000 lines</td><td>4-8 MB free</td><td>2-10mn</td></tr>
-<tr>                                                <td>0 (or 2)</td><td>0 or 1</td><td>0 or 1</td><td>Once a day<br>Log files are 1-10 MB<br>2000-20000 lines</td><td>4-8 MB free</td><td>1-10s</td></tr>
-<tr><td rowspan=2>10,000 -    100,000 visits/month</td><td>1</td><td>0 or 1</td><td>0 or 1</td><td>Every 12 hours<br>Log files are 5-50 MB<br>10000-100000 lines</td><td>8-16 MB free</td><td>5-50mn</td></tr>
-<tr>                                                <td>0 (or 2)</td><td>0 or 1</td><td>0 or 1</td><td>Every 12 hours<br>Log Files are 5-50 MB<br>10000-100000 lines</td><td>8-16 MB free</td><td>5-50s</td></tr>
-<tr><td rowspan=2>100,000 -   500,000 visits/month</td><td>1</td><td>0</td><td>0 or 1</td><td>Every hour<br>Log Files are 4-16 MB<br>10000-50000 lines</td><td>16-64 MB free</td><td>5-25mn</td></tr>
-<tr>                                                <td>0 (or 2)</td><td>0</td><td>0 or 1</td><td>Every hour<br>Log Files are 4-16 MB<br>10000-50000 lines</td><td>16-64 MB free</td><td>5-25s</td></tr>
-<tr><td>         500,000 - 2,000,000 visits/month</td><td>0 (or 2)</td><td>0</td><td>0</td><td>Every hour<br>Log Files are 16-64 MB<br>50000-200000 lines</td><td>64-256 MB free</td><td>25-120s</td></tr>
-<tr><td>       2,000,000 - 4,000,000 visits/month</td><td>0 (or 2)</td><td>0</td><td>0</td><td>Every hour<br>Log Files are 64-128 MB<br>200000-400000 lines</td><td>256-512 MB free</td><td>120-240s</td></tr>
-<tr><td>      +4,000,000 visits/month</td><td colspan=6>AWStats is not a good choice for such web sites. Try a tool with less features but faster like "row counter log analyzers" like <a href="http://www.analog.cx">Analog</a> (Can try also <a href="http://www.mrunix.net/webalizer/">Webalizer</a>)</td></tr>
+<tr><td rowspan=2>     0 -     1,000 visits/month</td><td rowspan=2>Your choice</td><td>0 (or 2)</td><td>0 or 1</td><td>0 or 1</td><td>Once a day<br>Log files are 0-1 MB<br>2000 lines to process</td><td>4 MB free</td><td>1s</td></tr>
+<tr>                                                                                <td>1</td><td>0 or 1</td><td>0 or 1</td><td>Once a day<br>Log files are 0-1 MB<br>2000 lines to process</td><td>4 MB free</td><td>2mn</td></tr>
+<tr><td rowspan=2> 1,000 -    10,000 visits/month</td><td rowspan=2>Your choice</td><td>0 (or 2)</td><td>0 or 1</td><td>0 or 1</td><td>Once a day<br>Log files are 1-10 MB<br>2000-20000 lines</td><td>4-8 MB free</td><td>1s-10s</td></tr>
+<tr>                                                                                <td>1</td><td>0 or 1</td><td>0 or 1</td><td>Once a day<br>Log files are 1-10 MB<br>2000-20000 lines</td><td>4-8 MB free</td><td>2mn-10mn</td></tr>
+<tr><td rowspan=2>10,000 -    100,000 visits/month</td><td rowspan=2>Your choice</td><td>0 (or 2)</td><td>0 or 1</td><td>0 or 1</td><td>One a day<br>Log Files are 10-100 MB<br>20000-200000 lines</td><td>8-32 MB free</td><td>10s-120s</td></tr>
+<tr>                                                                                 <td>1</td><td>0 or 1</td><td>0 or 1</td><td>Once a day<br>Log files are 10-100 MB<br>20000-200000 lines</td><td>8-32 MB free</td><td>10mn-50mn</td></tr>
+<tr><td rowspan=2>100,000 -   500,000 visits/month</td><td rowspan=2>Your choice</td><td>0 (or 2)</td><td>0</td><td>0 or 1</td><td>Every 6 hours<br>Log Files are 24-96 MB<br>50000-300000 lines</td><td>16-92 MB free</td><td>30s-3mn</td></tr>
+<tr>                                                                                 <td>1</td><td>0</td><td>0 or 1</td><td>Every 6 hours<br>Log Files are 24-96 MB<br>50000-300000 lines</td><td>16-92 MB free</td><td>15mn-60mn</td></tr>
+<tr><td>         500,000 - 2,000,000 visits/month</td><td>See next section on pb with ActiveState</td><td>0 (or 2)</td><td>0</td><td>0</td><td>Every 6 hours<br>Log Files are 96-384 MB<br>300000-1200000 lines</td><td>64-256 MB free</td><td>3mn-12mn</td></tr>
+<tr><td>       2,000,000 - 4,000,000 visits/month</td><td>See next section on pb with ActiveState</td><td>0 (or 2)</td><td>0</td><td>0</td><td>Every 6 hours<br>Log Files are 384-768 MB<br>1200000-2400000 lines</td><td>256-512 MB free</td><td>12mn-24mn</td></tr>
+<tr><td>      +4,000,000 visits/month</td><td>See next section on pb with ActiveState</td><td colspan=6>AWStats is not a good choice for such web sites. Try a tool with less features but faster like "row counter log analyzers" like <a href="http://www.analog.cx">Analog</a> (Can try also <a href="http://www.mrunix.net/webalizer/">Webalizer</a>)</td></tr>
 </table>
 * You should set <a href="awstats_config.html#DNSLookup">DNSLookup</a> parameter to 0 (or 2) if<br>
 &nbsp;&nbsp; &nbsp;&nbsp; - reverse DNS lookup is already done in your log file,<br>
@@ -94,38 +94,46 @@ Note: Country report can works without reverse DNS lookup if plugin 'geoip' is e
 ** This is free memory required for update process (in MB), this is not hardware memory installed !<br>
 Warning: If you use the <a href="awstats_config.html#URLWithQuery">URLWithQuery</a> or <a href="awstats_config.html#URLReferrerWithQuery">URLReferrerWithQuery</a> option, or forget
 to complete correctly <a href="awstats_config.html#URLQuerySeparators">URLQuerySeparators</a> for some sites, this value can be dramatically increased.<br>
-*** Duration is with Athlon 1GHz/128Mb, Standard Perl 5.8 and LogFormat=1.<br>
+*** Duration with DNSLookup set to 1 is very long because of DNS lookup whatever is speed of your computer.
+Duration with DNSLookup set to 0 (or 2) is with Athlon 1GHz/256MB, Cygwin Perl 5.8 and LogFormat=1.<br>
 
 <br>
 <br>
 <a name="ADVICES"></a><b><u>SOME IMPORTANT ADVICES FOR A GOOD USE OF AWSTATS:</u></b><br>
 <br>
 <img src="images/star.png"><img src="images/star.png"><img src="images/star.png"><img src="images/star.png">
-- Check that <a href="awstats_config.html#DNSLookup">DNSLookup</a> is disabled in AWStats (DNSLookup must
-be set to 0, or 2 to only use a DNS file resolver). Note that you still can have a 'Country' report
-without DNS lookup enabled. For this you must enable the 'geoip' plugin. Without this plugin, 'Country'
-report will works only if hosts addresses in your log file are already resolved (need to setup your web
-server to do so, your web server will be slowed). With DNSLookup enabled, log analyze speed is decreased
-by 40 to 100 times.<br>
+- Check that <a href="awstats_config.html#DNSLookup">DNSLookup</a> is disabled in AWStats (DNSLookup should not
+be set to 1). <b>If you need a 'Country' report, you should prefer using the 'geoip' or 'geoipfree' plugin
+instead of DNS lookup</b>. Those plugins allow you to have more accurate results, faster with no network queries (With
+DNSLookup enabled, log analyze speed is decreased by 40 to 100 times, so use it only if required).
+Note that without DNS lookup and without the 'geoip' plugins, 'Country' report might work but results will be
+less accurate than the 'geoip' usage and it works only if hosts addresses in your log file are already resolved
+(need to setup your web server to do so, your web server will be slowed).<br>
 <img src="images/star.png"><img src="images/star.png"><img src="images/star.png"><img src="images/star.png">
 - Use carefully parameters <a href="awstats_config.html#URLWithQuery">URLWithQuery</a>, <a href="awstats_config.html#URLReferrerWithQuery">URLReferrerWithQuery</a> and <a href="awstats_config.html#URLWithAnchor">URLWithAnchor</a>
 (Let them set to 0 if you don't know what they means) and check your web site URLs' syntax to know if you don't need to complete the parameter <a href="awstats_config.html#URLQuerySeparators">URLQuerySeparators</a>.
-If you really need to use <a href="awstats_config.html#URLWithQuery">URLWithQuery</a>=1, check that <a href="awstats_config.html#URLWithQueryWithoutFollowingParameters">URLWithQueryWithoutFollowingParameters</a> is set properly.<br>
+If you really need to use <a href="awstats_config.html#URLWithQuery">URLWithQuery</a>=1, check that
+<a href="awstats_config.html#URLWithQueryWithOnlyFollowingParameters">URLWithQueryWithOnlyFollowingParameters</a> or
+<a href="awstats_config.html#URLWithQueryWithoutFollowingParameters">URLWithQueryWithoutFollowingParameters</a>
+are set properly.<br>
 <img src="images/star.png"><img src="images/star.png"><img src="images/star.png"><img src="images/star.png">
-- Be sure that your <a href="awstats_config.html#HostAliases">HostAliases</a> parameter list is complete.<br>
-<img src="images/star.png"><img src="images/star.png"><img src="images/star.png"><img src="images/star.png">
-- Rotate your log (See <a href="awstats_faq.html#ROTATE">FAQ-SET500</a>) and launch AWStats more often (from crontab or a scheduler, See <a href="awstats_faq.html#CRONTAB">FAQ-SET550</a>).
- The more often you
-launch AWStats, the less AWStats has new lines in log to process. This solve also the ActiveState memory problem (see next advice).<br>
+- Use <b>last Perl version</b> (For example Perl 5.8 is 5% faster than 5.6) and, more important, <b>for large log files,
+use standard Perl distribution instead of ActiveState</b>. This is because ActiveState 5.006 (and may be also
+other versions), has very important memory hole problem making speed of analysis slower and slower
+reaching 0 lines/seconds and using all your memory. You can see the decrease by adding the -showsteps option
+on command line. The speed should be constant to value given in top of this page, even for
+several Gigabytes log files !<br>
 <img src="images/star.png"><img src="images/star.png"><img src="images/star.png">
-- Use last Perl version (For example 5.8 is 5% faster than 5.6) and, more important, use standard Perl distribution instead of ActiveState (For example Standard Perl 5.8 Win32 binary is 25% faster than
-ActiveState. And ActiveState 5.006, and may be other versions, have important memory problems making speed of analysis slower and slower when analysing more and more lines).<br>
+- <b>Rotate your log</b> (See <a href="awstats_faq.html#ROTATE">FAQ-SET500</a>) and launch AWStats more often (from crontab or a scheduler, See <a href="awstats_faq.html#CRONTAB">FAQ-SET550</a>).
+The more often you launch AWStats, the less AWStats has new lines in log to process.
+This can also solve the ActiveState memory problem (see next advice).<br>
+<img src="images/star.png"><img src="images/star.png">
+- Be sure that your <a href="awstats_config.html#HostAliases">HostAliases</a> parameter list is complete.<br>
+<img src="images/star.png"><img src="images/star.png">
+- Use <b>last AWStats version</b> (For example AWStats 6.0 is 15% faster than 5.9).<br>
 <img src="images/star.png"><img src="images/star.png">
-- Use last AWStats version.<br>
-<img src="images/star.png">
-- If you use Apache and don't rotate your logs (not the best way of working), set <a href="awstats_config.html#PurgeLogFile">PurgeLogFile</a> to 1 (By default, to avoid bad surprise,
-<a href="awstats_config.html#PurgeLogFile">PurgeLogFile</a> is 0 in configure file, but you can set it to 1 to ask AWStats
-to purge the log file after processing it, this increase speed for next run).<br>
+- For geeks users, you can also recompile your Perl with differents options.
+For example, it seems that the "use64bitint=define usemymalloc=y" can increase speed by 10%.
 <br>
 
 <hr>
index ea3720db05364048b9f44f6902cf03d5e7adf6b1..cf6c266e52b8ede97128819c9de91fee1d8b2899 100644 (file)
@@ -1012,9 +1012,9 @@ when reading it), follow the example:<br>
 <br># particular parameter because it does not identify the page or because it's
 <br># a random ID changing for each access even if URL points to same page. In
 <br># such cases, it is higly recommanded to ask AWStats to keep only parameters
-<br># you need (if you know them) before counting, manipulating and storing it.
+<br># you need (if you know them) before counting, manipulating and storing URL.
 <br># Enter here list of wanted parameters. For example, with "param", one hit on
-<br># /mypage.cgi?param=abc&id=Yo4UomP9d and /mypage.cgi?param=abc&id=Mu8fdxl3r
+<br># /mypage.cgi?param=abc&id=Yo4UomP9d  and  /mypage.cgi?param=abc&id=Mu8fdxl3r
 <br># will be reported as 2 hits on /mypage.cgi?param=abc
 <br># This parameter is not used when URLWithQuery is 0 and can't be used with
 <br># URLWithQueryWithoutFollowingParameters.
@@ -1033,10 +1033,10 @@ when reading it), follow the example:<br>
 <br># particular parameter because it does not identify the page or because it's
 <br># a random ID changing for each access even if URL points to same page. In
 <br># such cases, it is higly recommanded to ask AWStats to remove such parameters
-<br># from the URL before counting, manipulating and storing it. Enter here list
-<br># of all non wanted parameters. For example if you enter "id", one hit on
-<br># /mypage.cgi?p=abc&id=Yo4UomP9d and /mypage.cgi?p=abc&id=Mu8fdxl3r
-<br># will be reported as 2 hits on /mypage.cgi?p=abc
+<br># from the URL before counting, manipulating and storing URL. Enter here list
+<br># of all non wanted parameters. For example, if you enter "id", one hit on
+<br># /mypage.cgi?param=abc&id=Yo4UomP9d  and  /mypage.cgi?param=abc&id=Mu8fdxl3r
+<br># will be reported as 2 hits on /mypage.cgi?param=abc
 <br># This parameter is not used when URLWithQuery is 0 and can't be used with
 <br># URLWithQueryWithOnlyFollowingParameters.
 <br># Change : Effective for new updates only
@@ -1088,7 +1088,7 @@ when reading it), follow the example:<br>
 <a name="DebugMessages"><b>DebugMessages</b></a><br>
 <b>Version : </b>5.2+<br>
 <br># AWStat can be run with debug=x parameter to ouput various informations
-<br># to help in debugging or solving troubles. If you wand (in most cases for 
+<br># to help in debugging or solving troubles. If you want (in most cases for 
 <br># security reasons) to disable debugging, set this parameter to 0.
 <br># Possible values: 0 or 1
 <br># Default: 1
index 12480815087c979d707dff7bda7fe985386d7473..fe7b66a4f70a31fbd6e9213fb4e2bc984e4d3d83 100644 (file)
@@ -625,9 +625,9 @@ URLWithQuery=0
 # particular parameter because it does not identify the page or because it's
 # a random ID changing for each access even if URL points to same page. In
 # such cases, it is higly recommanded to ask AWStats to keep only parameters
-# you need (if you know them) before counting, manipulating and storing it.
+# you need (if you know them) before counting, manipulating and storing URL.
 # Enter here list of wanted parameters. For example, with "param", one hit on
-# /mypage.cgi?param=abc&id=Yo4UomP9d and /mypage.cgi?param=abc&id=Mu8fdxl3r
+# /mypage.cgi?param=abc&id=Yo4UomP9d  and  /mypage.cgi?param=abc&id=Mu8fdxl3r
 # will be reported as 2 hits on /mypage.cgi?param=abc
 # This parameter is not used when URLWithQuery is 0 and can't be used with
 # URLWithQueryWithoutFollowingParameters.
@@ -643,10 +643,10 @@ URLWithQueryWithOnlyFollowingParameters=""
 # particular parameter because it does not identify the page or because it's
 # a random ID changing for each access even if URL points to same page. In
 # such cases, it is higly recommanded to ask AWStats to remove such parameters
-# from the URL before counting, manipulating and storing it. Enter here list
+# from the URL before counting, manipulating and storing URL. Enter here list
 # of all non wanted parameters. For example if you enter "id", one hit on
-# /mypage.cgi?p=abc&id=Yo4UomP9d and /mypage.cgi?p=abc&id=Mu8fdxl3r
-# will be reported as 2 hits on /mypage.cgi?p=abc
+# /mypage.cgi?param=abc&id=Yo4UomP9d  and  /mypage.cgi?param=abc&id=Mu8fdxl3r
+# will be reported as 2 hits on /mypage.cgi?param=abc
 # This parameter is not used when URLWithQuery is 0 and can't be used with
 # URLWithQueryWithOnlyFollowingParameters.
 # Change : Effective for new updates only
@@ -896,7 +896,7 @@ ShowAuthenticatedUsers=0
 # Default: HBL, Possible codes: HBL
 ShowRobotsStats=HBL
 # Show worms chart\r
-# Default: 0 (See also LevelForWormsDetection if set), Possible codes: HBL\r
+# Default: 0 (If set to 1, see also LevelForWormsDetection), Possible codes: HBL\r
 ShowWormsStats=0\r
 # Show email senders chart (For use when analyzing mail log files)
 # Default: 0, Possible codes: HBML
@@ -923,7 +923,7 @@ ShowOSStats=1
 # Default: 1, Possible codes: None
 ShowBrowsersStats=1
 # Show screen size chart
-# Default: 0 (See also MiscTrackerUrl if set to 1), Possible codes: None
+# Default: 0 (If set to 1, see also MiscTrackerUrl), Possible codes: None
 ShowScreenSizeStats=0
 # Show origin chart
 # Default: PH, Possible codes: PH