← Back to branch summary

~ubuntu-branches/ubuntu/lucid/awstats/lucid-updates

« back to all changes in this revision

Viewing changes to docs/awstats_faq.html

  • Committer: Bazaar Package Importer
  • Author(s): Nico Golde
  • Date: 2008-12-10 13:05:43 UTC
  • mfrom: (7.1.10 intrepid)
  • Revision ID: james.westby@ubuntu.com-20081210130543-2sh59pphufllknju
Tags: 6.7.dfsg-5.1
http://bugs.debian.org/495432
* Non-maintainer upload by the Security Team.
* Strip '"' characters during URL decoding, fixing a cross-site
  scripting attack (CVE-2008-3714; CVE-2008-5080; Closes: #495432).

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/awstats_faq.html
7
7
<meta name="title" content="AWStats Documentation - FAQs">
8
8
<title>AWStats Documentation - FAQs</title>
9
9
<link rel="stylesheet" href="styles.css" type="text/css">
10
 
<!-- $Revision: 1.172 $ - $Author: eldy $ - $Date: 2005/11/23 20:36:51 $ -->
 
10
<!-- $Revision: 1.178 $ - $Author: eldy $ - $Date: 2007/07/02 22:11:20 $ -->
11
11
</head>
12
12
 
13
13
<body topmargin=10 leftmargin=5>
20
20
<td bgcolor=#9999cc align=center><a href="/"><img src="images/awstats_logo4.png" border=0></a></td>
21
21
<td bgcolor=#9999cc align=center>
22
22
<br>
23
 
<font style="font: 16pt arial,helvetica,sans-serif" color=#EEEEFF><b>AWStats logfile analyzer 6.5 Documentation</b></font><br>
 
23
<font style="font: 16pt arial,helvetica,sans-serif" color=#EEEEFF><b>AWStats logfile analyzer 6.7 Documentation</b></font><br>
24
24
<br>
25
25
</td>
26
26
<td bgcolor=#9999cc align=center>
41
41
FAQ-ABO150 <a href="#LOGFORMAT">Which log format can AWStats analyze ?</a><br>
42
42
FAQ-ABO200 <a href="#LANG">Which languages are available ? How to add my own language ?</a><br>
43
43
FAQ-ABO250 <a href="#PHPNUKE">Can AWStats be integrated with PHP Nuke ?</a><br>
 
44
FAQ-ABO300 <a href="#ABOUTHISTORY">About AWStats history</a><br>
44
45
</ul>
45
46
<br>
46
47
 
135
136
<br>
136
137
 
137
138
<a name="LOGFORMAT"></a><br>
138
 
<b><u>FAQ-ABO150 : WHICH LOG FORMAT CAN AWSTATS ANALYZE ?</u></b><br>
139
 
AWStats setup knows predefined log format you can use to make AWStats config easier. However,
 
139
<b><u>FAQ-ABO150 : WHICH LOG FORMATS CAN AWSTATS ANALYZE ?</u></b><br>
 
140
AWStats setup knows predefined log formats you can use to make AWStats config easier. However,
140
141
you can define your own log format, that's the reason why AWStats can analyze nearly all web, wap
141
142
and proxy server log files. Some FTP servers log files, Syslog or mail logs can also be analyzed.<br>
142
143
The only requirement is "Your log file must contain required information".<br>
190
191
If your language is not in this list, you can translate it yourself. For this, find what is your
191
192
2 letter language code: <a href="http://www.oasis-open.org/cover/iso639a.html">here</a>.<br>
192
193
Once, you get it, for example "gl" for Galician, copy the file awstats-en.txt into awstats-<i>gl</i>.txt,
193
 
in langs directory and translate every sentences inside. You can do same for files inside
 
194
in langs directory and translate every sentence inside. You can do same for files inside
194
195
tooltips_f, tooltips_m and tooltips_w sub-directories. Then send your translated file(s) to eldy@users.sourceforge.net.<br>
195
196
<br>
196
197
 
199
200
The only plugin I know to integrate AWStats inside PHPNuke is here: <a href="http://phpnuke.org/modules.php?name=News&file=article&sid=7041">PhpNuke addon for AWStats</a><br>
200
201
<br>
201
202
 
 
203
<a name="ABOUTHISTORY"></a><br>
 
204
<b><u>FAQ-ABO300 : ABOUT AWSTATS HISTORY</u></b><br>
 
205
AWStats was initialy designed for my own use to track visitors on my personal web sites
 
206
(<a href="http://www.chiensderace.com" alt="Chiens De Race .com">www.chiensderace.com</a>, <a href="http://www.chatsderace.com" alt="Chats De Race .com">www.chatsderace.com</a>, <a href="http://www.lesbonnesannonces.com" alt="Petites annonces LesBonnesAnnonces.com">www.lesbonnesannonces.com</a> and <a href="http://www.destailleur.fr" alt="Site personnel Laurent Destailleur">www.destailleur.fr</a>)<br>
 
207
Then I decided to put it on sourceforge in year 2000. Then a lot of new versions were
 
208
development to add enhancements until today. See changelog for full history of changes.<br>
 
209
<br>
 
210
 
202
211
 
203
212
<hr><br>
204
213
 
210
219
<font class=CSolution>SOLUTION:</font><br>
211
220
Because AWStats is a log analyzer, if you don't have any way to read your server log file,
212
221
you have nothing to analyze and you should not be able to use AWStats.
213
 
However, this is a trick that you can use to have a log file be build. You must add
 
222
However, this is a trick that you can use to have a log file be built. You must add
214
223
a tag to call a CGI script like pslogger into each of your web pages. This will
215
224
allow you to have an artificial log file that can be analyzed by AWStats.<br>
216
225
You can find a Perl version of CGI pslogger enhanced by AWStats author <a href="/files/pslogger.pl">here</a>
579
588
<br>sc-bytes
580
589
</td></tr></table>
581
590
<br>
582
 
To have the change effective, stop your server, remove old log files and restart the server.<br>
 
591
To make the change effective, stop your server, remove old log files and restart the server.<br>
583
592
Listen to streaming files and check that your new log file looks like this:<br>
584
593
<table width="95%" border=1 cellpadding=0 cellspacing=0 bgcolor=#F4F4F4 class=CFAQ><tr class=CFAQ><td class=CFAQ>
585
594
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
656
Which value do I have to put in the LogFormat parameter to make AWStats working with my log
648
657
file format ?<br>
649
658
<font class=CSolution>SOLUTION:</font><br>
650
 
The AWStats config file give you all possible values for LogFormat parameter.
 
659
The AWStats config file gives you all the possible values for LogFormat parameter.
651
660
To help you, this is some common cases of log file format, and
652
 
the corresponding value for LogFormat you must use in your AWStats config file:<br>
 
661
the corresponding value of LogFormat you must use in your AWStats config file:<br>
653
662
<hr>
654
663
<u>If your log records are EXACTLY like this (<b>NCSA combined/XLF/ELF</b> log format):</u><br>
655
664
<i>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)"</i><br>
755
764
Note: Browsers, OS's, Keywords and Referers features are not available with a such format.<br>
756
765
 
757
766
<hr>
758
 
<u>There is a lot of other possible log formats.</u><br>
 
767
<u>There are a lot of other possible log formats.</u><br>
759
768
You must use a personalized log format LogFormat ="..." as described in config file to
760
769
support other various log formats.<br>
761
770
<br><br>
915
924
<a name="SCREENSIZE"></a><br>
916
925
<b><u>FAQ-COM142 : HOW TO GET THE SCREEN SIZE AND BROWSER CAPABILITIES REPORT WORKING ?</u></b><br>
917
926
<font class=CProblem>PROBLEM:</font><br>
918
 
I see in the AWStats features list that it can report the screen size used by visitors and also if its browser
919
 
support Flash, java, etc... How can I do that ?<br>
 
927
I see in the AWStats features list that it can report the screen size used by visitors and other browsers' informations,
 
928
(like if browser support Flash, Java, Javascript, PDF, MAcromedia, Audio plugins, etc...). How can I do that ?<br>
920
929
<font class=CSolution>SOLUTION:</font><br>
921
 
AWStats is a log analyzer, so to report the screen size of your visitor, we need to have information inside the log file.
922
 
For this, the only way to do that is to add some HTML tags inside some of your pages (the home page is enoough to
923
 
get screen size use ratios). This tag will add call to a javascript that ask your browser to call of an URL that
924
 
includes in its parameters, the screen size resolution and other informations about browser capabilities.<br>
 
930
AWStats is a log analyzer, so to report the screen size of your visitor, we need to have information inside the log file itself.
 
931
For this, the only way to do that, is to add some HTML tags inside some of your pages (the home page is enough to
 
932
get use ratios). This tag will add call to a javascript that ask your browser to get a virtual URL that
 
933
includes, in its parameters, the screen size resolution and all other informations about browser capabilities (Flash, Java, Javascript, PDF, Macromedia, Audio plgins...).<br>
925
934
<br>
926
935
This is the code you must add (at bottom of your home page for example) :<br>
927
936
<table border=1 cellpadding=1 cellspacing=0 bgcolor=#F4F4F4 width="95%" class=CFAQ><tr class=CFAQ><td class=CFAQ>
1048
1057
log files but that are only one page "viewed".<br>
1049
1058
Etc...<br>
1050
1059
<br>
1051
 
If you want to check how serious is your log analyzer, try to parse the following log file.
1052
 
It's a very common log file but results will show you how bad are most log analyzers (above
 
1060
If you want to check how serious your log analyzer is, try to parse the following log file.
 
1061
It's a very common log file but results will show you how bad most log analyzers are (above
1053
1062
all commercial products):<br>
1054
1063
<table width="95%" border=1 cellpadding=0 cellspacing=0><tr class=CFAQ><td class=CFAQ>
1055
1064
<i><font style="font: 8px verdana,arial,helvetica">
1177
1186
<br>
1178
1187
 
1179
1188
<a name="GEOIPEU"></a><br>
1180
 
<b><u>FAQ-COM320 : WHAT DOES MEAN "EU" (EUROPEAN COUNTRY)" IN GEOIP COUNTRY REPORTS ?</u></b><br>
 
1189
<b><u>FAQ-COM320 : WHAT DOES "EU" (EUROPEAN COUNTRY)" MEAN IN GEOIP COUNTRY REPORTS ?</u></b><br>
1181
1190
<font class=CProblem>PROBLEM:</font><br>
1182
1191
I use the <a href="awstats_contrib.html#geoip">AWStats GeoIp country plugins</a> to report countries according
1183
1192
to geolocalisation of IP address.
1201
1210
the update (or use the -LogFile option on command line to overwrite <a href="awstats_config.html#LogFile">LogFile</a> parameter).
1202
1211
The update process can only accept files in chronological order for a particular month, so if you
1203
1212
have already processed a recent file and forgot to run update
1204
 
on a log file that contains older data, you must before reset all
1205
 
your statistics (see <a href="#FAQ-COM500">FAQ-COM500</a>) and restart all the update processes
 
1213
on a log file that contains older data, you must reset all of
 
1214
your statistics (see <a href="#FAQ-COM500">FAQ-COM500</a>) and restart all of the update processes
1206
1215
for all past log files and in chronological order.<br>
1207
 
However, there is a "tip" that allow you to rebuild only the month were you missed data:<br>
 
1216
However, there is a "tip" that allows you to rebuild only the month were you missed data:<br>
1208
1217
Imagine we are on 5th of July 2003, all your statistics are up to date except for the 10th of
1209
1218
April 2003 (you forgot to run the update process for this day, so there is no visit for this
1210
1219
day). You can :<br>
1211
1220
- Reset the statistics for April only (this means remove the file <i>awstats042003.[config.]txt</i>
1212
1221
as explained in <a href="#FAQ-COM500">FAQ-COM500</a>),<br>
1213
 
- Move the statistics history files for month after April (file <i>awstats052003.[config.]txt</i>,
1214
 
<i>awstats062003.[config.]txt</i>,...) into a temp directory (so that it is no more in DirData
1215
 
directory as if they were deleted).<br>
1216
 
- Run update process on all log files for April (in chronological order). AWStats does not
 
1222
- Move the statistics history files for the month after April (file <i>awstats052003.[config.]txt</i>,
 
1223
<i>awstats062003.[config.]txt</i>,...) into a temp directory (so that it is no longer in the DirData
 
1224
directory; as if they were deleted).<br>
 
1225
- Run the update process on all log files for April (in chronological order). AWStats does not
1217
1226
complain about "too old record" because there is no history files in DirData directory
1218
1227
that contains compiled data more recent than records into log you process.<br>
1219
1228
- Moved back the month history files you saved into your DirData directory.<br>
1220
 
Your statistics are up to date and the missing days are no more missing.<br>
 
1229
Your statistics are up to date and the missing days are no longer missing.<br>
1221
1230
<br>
1222
1231
 
1223
1232
<a name="MULTILOG"></a><br>
1234
1243
</td></tr></table>
1235
1244
<br>
1236
1245
<a href="awstats_tools.html#logresolvemerge">Logresolvemerge</a> is a tool provided with
1237
 
AWStats (in tools directory) that merge several log files on the fly. It opens pointer on each files
 
1246
AWStats (in tools directory) that merges several log files on the fly. It opens a pointer on each file
1238
1247
and sends, line by line, the oldest record from this. Using such a tool as a pipe source for AWStats <a href="awstats_config.html#LogFile">LogFile</a>
1239
1248
parameter is a very good solution because, it allows you to merge log files whatever their size
1240
1249
with no memory use, no hard disk use (no temporary files built), it is fast, it prevents
1285
1294
with all charts with data for a particular day only and want one report for each day of month.<br>
1286
1295
<font class=CSolution>SOLUTION:</font><br>
1287
1296
<b>If you use version 6.5 or higher:</b><br>
1288
 
What you can do is rerun the update process by adding the parameter -databasebreak=hour or -databasebreak=day.
1289
 
No option is same than -databasebreak=month, the default and old behaviour of AWStats.<br>
1290
 
Using this hidden option will ask AWStats to build a different database file for each break,
1291
 
this means that several reports are done for each hour or day.<br>
1292
 
To call a report add same option -databasebreak=hour or -databasebreak=day with option -output
1293
 
when AWStats report is staticaly built from command line or add &amp;databasebreak=hour or
1294
 
&amp;databasebreak=day if AWStats is called as a CGI.<br>
 
1297
<u>To build statistics:</u><br>
 
1298
What you can do is rerun the update process by adding the parameter <i>-databasebreak=hour</i> or <i>-databasebreak=day</i>.
 
1299
Providing no option is similar than using <i>-databasebreak=month</i>, the default and old behaviour of AWStats.<br>
 
1300
Using this hidden option will ask AWStats to build a different database file for each break entity,
 
1301
this means that several reports are done for each hour or day, depending on option used.<br>
 
1302
<u>To read a report:</u><br>
 
1303
Add same option <i>-databasebreak=hour</i> or <i>-databasebreak=day</i> with <i>-output</i> option
 
1304
when AWStats report is staticaly built from command line, or add <i>&amp;databasebreak=hour</i> or
 
1305
<i>&amp;databasebreak=day</i> if AWStats is called as a CGI.
 
1306
Also, complete options month and year used to choose month and year of report with other option
 
1307
<i>day</i> (when databasebreak option is 'day' or 'hour') and <i>hour</i> (only when databasebreak is 'hour')<br>
 
1308
So use <i>-day=XX</i> and/or <i>-hour=XX</i> when AWStats is run from command line. Use <i>&amp;day=XX</i> and/or <i>&amp;hour=XX</i>
 
1309
if AWStats is called as a CGI.<br> 
1295
1310
This feature is recent so may have results not completely reliable, that's why it is not yet
1296
1311
fully documented.<br>
1297
1312
<b>If you use version 6.4 or older:</b><br>
1689
1704
<hr>
1690
1705
 
1691
1706
<script language=javascript>
1692
 
        var date='$Date: 2005/11/23 20:36:51 $';
 
1707
        var date='$Date: 2007/07/02 22:11:20 $';
1693
1708
        document.writeln("Last revision: "+date);
1694
1709
</script>
1695
1710