1 rizwank 1.1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 <html>
3 <head>
4 <meta name="description" content="AWStats Documentation - Using the Extra Sections features">
5 <meta name="keywords" content="awstats, awstat, extra, section, sections, feature, features, report, extrasection">
6 <meta name="robots" content="index,follow">
7 <meta name="title" content="AWStats Documentation - Using the Extra Sections features">
8 <title>AWStats Documentation - Using the Extra Sections features</title>
9 <link rel="stylesheet" href="styles.css" type="text/css">
10 <!-- $Revision: 1.21 $ - $Author: eldy $ - $Date: 2004/12/18 22:04:21 $ -->
11 </head>
12
13 <body topmargin=10 leftmargin=5>
14
15
16 <table style="font: 10pt arial,helvetica,verdana" cellpadding=0 cellspacing=0 border=0 bgcolor=#FFFFFF width=100%>
17
18 <!-- Large -->
19 <tr style="font: 10pt arial,helvetica,verdana">
20 <td bgcolor=#9999cc align=center><a href="/"><img src="images/awstats_logo4.png" border=0></a></td>
21 <td bgcolor=#9999cc align=center>
22 rizwank 1.1 <br>
23 <font style="font: 16pt arial,helvetica,sans-serif" color=#EEEEFF><b>AWStats logfile analyzer 6.3 Documentation</b></font><br>
24 <br>
25 </td>
26 <td bgcolor=#9999cc align=center>
27
28 </td>
29 </tr>
30
31 </table>
32
33
34 <br><br><H1 style="font: 26px arial,helvetica,sans-serif">Adding extra reports using the ExtraSection feature</H1>
35
36 <br>
37 The AWStats ExtraSection features are powerfull setup options to allow you to add your own
38 report not provided by default with AWStats. You can use it to build special reports, like
39 number of sales for a particular product, marketing reports, counting for a particular
40 user or agent, etc...<br>
41 <br>
42
43 rizwank 1.1 <br><br>
44 <u><b>Explanation on how to add/edit an Extra report in your config file</b></u><br>
45 Take a look inside the AWStats config file to find the following part:<br>
46 <i>
47 #-----------------------------------------------------------------------------<br>
48 # EXTRA SECTIONS<br>
49 #-----------------------------------------------------------------------------<br>
50 <br>
51 </i>
52 Read all explanation in config file after this point, they will explain you
53 how to add an Extra report by adding an ExtraSection configuration in your config file,<br>
54 or just click <a href="#extraconfig">here</a> to jump to a copy of this explanation.<br>
55 Note that following examples is often a precious tutorial, so see next paragraph for this...<br>
56
57 <br><br>
58 <u><b>Some examples of ExtraSection setup you can follow to build your own personalized reports:</b></u><br>
59 <br>
60 <li><a href="#productorders">Example 1: Tracking Product orders</a><br>
61 <li><a href="#bugzilla">Example 2: Tracking Bugzilla most frequently viewed bugs</a><br>
62 <li><a href="#awredir">Example 3: Tracking Exit clicks</a><br>
63 <li><a href="#aborted">Example 4: Tracking aborted download</a><br>
64 rizwank 1.1 <li><a href="#domainaliases">Example 5: Tracking most requested domain aliases</a><br>
65 <li><a href="#level2dir">Example 6: List of top level 2 path under a directory /mydir</a><br>
66 <br>
67 <br>
68
69 <br>
70 <br><a name="productorders"><H2 style="font: 18px arial,helvetica,sans-serif color: #606060"><u>Example 1: Tracking Product orders</u></H2></a>
71 Image your web site is an e-store that sells 80 different products. Each of them has an id.
72 Imagine each time, someone make an order for product 49, the order.cgi script or order2.cgi script
73 is called with, in URL query parameter, the id of the product, meanings that you get in your log
74 file a hit that looks like this:<br>
75 <i>GET /cgi-bin/order.cgi?productid=49&session=A0B1C2</i>
76 <br>
77 So this is how you need to setup your ExtraSection to track your product orders:<br>
78 <i>
79 <br>ExtraSectionName1="Product orders"
80 <br>ExtraSectionCodeFilter1="200 304"
81 <br>ExtraSectionCondition1="URL,\/cgi\-bin\/order\.cgi|URL,\/cgi\-bin\/order2\.cgi"
82 <br>ExtraSectionFirstColumnTitle1="Product ID"
83 <br>ExtraSectionFirstColumnValues1="QUERY_STRING,productid=([^&]+)"
84 <br>ExtraSectionFirstColumnFormat1="%s"
85 rizwank 1.1 <br>ExtraSectionStatTypes1=PL
86 <br>ExtraSectionAddAverageRow1=0
87 <br>ExtraSectionAddSumRow1=1
88 <br>MaxNbOfExtra1=100
89 <br>MinHitExtra1=1
90 </i>
91 <br>
92
93
94 <br>
95 <br><a name="bugzilla"><H2 style="font: 18px arial,helvetica,sans-serif color: #606060"><u>Example 2: Tracking Bugzilla most frequently viewed bugs</u></H2></a>
96 This is an example on how to setup your ExtraSection:<br>
97 <i>
98 <br>ExtraSectionName1="Bugzilla: Most frequently viewed bugs"
99 <br>ExtraSectionCodeFilter1="200 304"
100 <br>ExtraSectionCondition1="URL,\/bugzilla\/show_bug\.cgi"
101 <br>ExtraSectionFirstColumnTitle1="Bug ID"
102 <br>ExtraSectionFirstColumnValues1="QUERY_STRING,id=([^&]+)"
103 <br>ExtraSectionFirstColumnFormat1="<a href='/bugzilla/show_bug.cgi?id=%s' target=new>%s</a>"
104 <br>ExtraSectionStatTypes1=PL
105 <br>ExtraSectionAddAverageRow1=0
106 rizwank 1.1 <br>ExtraSectionAddSumRow1=1
107 <br>MaxNbOfExtra1=500
108 <br>MinHitExtra1=1
109 </i>
110 <br>
111
112
113 <br>
114 <br><a name="awredir"><H2 style="font: 18px arial,helvetica,sans-serif color: #606060"><u>Example 3: Tracking Exit clicks</u></H2></a>
115 AWStats shows you naturally the exit pages. However, you don't know where you visitor go
116 after exiting your site since clicking on a link that point to an external link will log
117 the viewed page on the external server and not on yours.
118 If you want to track this, you can, using the ExtraSection and the <b>awredir.pl</b> tool
119 (provided with AWStats).<br>
120 This tools must be used as a CGI wrapper. When called on 'A HREF' link, it returns to
121 browser a redirector to tell it to show the required page.
122 So, to use this script, you must replace HTML href tags that points to external web sites
123 onto your HTML pages from<br>
124 <i><a href="http://externalsite/pagelinked">Link</a><br></i>
125 to<br>
126 <i><a href="http://yoursite/cgi-bin/awredir.pl?url=http://externalsite/pagelinked">Link</a><br></i>
127 rizwank 1.1 <br>
128 For your web visitor, there is no difference. However this allow you to track
129 clicks done on links onto your web pages that point to external web sites,
130 because an entry will be seen in your own server log like this record:<br>
131 <i>
132 80.1.2.3 - - [01/Jan/2001:16:00:00 -0300] "GET /cgi-bin/awredir.pl?url=http://externalsite/pagelinked HTTP/1.1" 302 70476 "http://yoursite/pagewithlink.html" "FireBird/0.7"<br>
133 </i>
134 <br>
135 Then, you can add in AWStats a chart to track all call to <i>awredir.pl</i> with
136 keys values taken from the "url=" parameter. You will get in an independant chart, counting
137 all external pages viewed by your visitor after exiting your site.<br>
138 This is for this how you must setup your ExtraSection:<br>
139 <i>
140 <br>ExtraSectionName1="Redirected Hit"
141 <br>ExtraSectionCodeFilter1="302"
142 <br>ExtraSectionCondition1="URL,\/cgi\-bin\/awredir\.pl"
143 <br>ExtraSectionFirstColumnTitle1="Url"
144 <br>ExtraSectionFirstColumnValues1="QUERY_STRING,url=([^&]+)"
145 <br>ExtraSectionStatTypes1=HL
146 <br>MaxNbOfExtra1=500
147 <br>MinHitExtra1=1
148 rizwank 1.1 <br>ExtraSectionAddSumRow1=1
149 </i>
150 <br><br>
151
152
153 <br><a name="aborted"><H2 style="font: 18px arial,helvetica,sans-serif color: #606060"><u>Example 4: Tracking aborted download</u></H2></a>
154 Aborted downloads are reported in a log file by a 206 error, so this is how you need to setup your ExtraSection to add a chart for a such tracking:<br>
155 <i>
156 <br>ExtraSectionName1="List of aborted download"
157 <br>ExtraSectionCodeFilter1="206"
158 <br>ExtraSectionCondition1=""
159 <br>ExtraSectionFirstColumnTitle1="URL"
160 <br>ExtraSectionFirstColumnValues1="URL,(.*)"
161 <br>ExtraSectionStatTypes1=PHK
162 <br>MaxNbOfExtra1=100
163 <br>MinHitExtra1=1
164 </i>
165 <br><br>
166
167
168 <br><a name="domainaliases"><H2 style="font: 18px arial,helvetica,sans-serif color: #606060"><u>Example 5: Tracking most requested domain aliases</u></H2></a>
169 rizwank 1.1 You have one website, but this web site has several domains named (for example the same site domain.com can be
170 reached with urls domain.com,www.domain.com,www.otherdomainname.com,www.againadomainname.org,...).
171 You want to know which domain alias is the most used.<br>
172 <br>
173 The first thing to do is to be sure the domain alias is recorded inside your log file.
174 If you use Apache, you must use a personalized Apache log file that contains the <i>%V</i> tag.
175 For example you can add in your Apache httpd.conf file a new Apache log format (This is
176 the Apache directive, not AWStats, to define an Apache log format that contains
177 the virtual domain):<br>
178 <i>LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\" %V" combinedv</i><br>
179 Then check that your Apache CustomLog directives are defined like this:<br>
180 <i>CustomLog pathtoyourlog/yourlog.log combinedv</i><br>
181 <br>
182 After restarting Apache, your log format should look like this<br>
183 66.130.77.181 - - [09/Aug/2004:03:01:05 +0200] "GET /index.php HTTP/1.1" 200 1473 "-" "Firefox 1.0" www.otherdomainname.com<br>
184 <br>
185
186 When your web server log file contains the domain alias, you can now setup AWStats
187 to use it. For this use a personalised AWStats log format and use the <i>%extra1</i> tag at
188 the same place that the domain alias is. For example, for your combinedv Apache log format,
189 we will use:<br>
190 rizwank 1.1 <i>LogFormat="%host %other %logname %time1 %methodurl %code %bytesd %refererquot %uaquot %extra1"</i><br>
191 <br>
192 Every tag defined by name <i>extraZ</i> (Z is a number, you can use as many tags as you need)
193 can be used in any ExtraSection to extract the parameter. You can use the name <i>extraZ</i> as
194 a criteria in the <i>ExtraSectionFirstColumnValuesX</i> parameter (X is number of the extra report, you can
195 add as many report as you need) to tell AWStats to use value in log file at the place of
196 the tag, as the key for your report. For example:<br>
197 <i>
198 <br>ExtraSectionName1="Domains aliases"
199 <br>ExtraSectionCodeFilter1="200 304"
200 <br>ExtraSectionCondition1=""
201 <br>ExtraSectionFirstColumnTitle1="Domain alias"
202 <br>ExtraSectionFirstColumnValues1="extra1,([^&]+)"
203 <br>ExtraSectionFirstColumnFormat1="%s"
204 <br>ExtraSectionStatTypes1=HL
205 <br>ExtraSectionAddAverageRow1=0
206 <br>ExtraSectionAddSumRow1=1
207 <br>MaxNbOfExtra1=20
208 <br>MinHitExtra1=1
209 </i>
210 <br><br>
211 rizwank 1.1 And result will be:
212 <style type="text/css">
213 <!--
214 .aws_bodyl { }
215 .aws_border { background-color: #CCCCDD; padding: 1px 1px 1px 1px; margin-top: 0; margin-bottom: 0; }
216 .aws_title { font: 13px verdana, arial, helvetica, sans-serif; font-weight: bold; background-color: #CCCCDD; text-align: center; margin-top: 0; margin-bottom: 0; padding: 1px 1px 1px 1px; color: #000000; }
217 .aws_blank { font: 13px verdana, arial, helvetica, sans-serif; background-color: #CCCCDD; text-align: center; margin-bottom: 0; padding: 1px 1px 1px 1px; }
218 .aws_data {
219 background-color: #FFFFFF;
220 border-top-width: 1px;
221 border-left-width: 0px;
222 border-right-width: 0px;
223 border-bottom-width: 0px;
224 }
225 .aws_formfield { font: 13px verdana, arial, helvetica; }
226 .aws_button {
227 font-family: arial,verdana,helvetica, sans-serif;
228 font-size: 12px;
229 border: 1px solid #ccd7e0;
230 background-image : url(/awstatsicons/other/button.gif);
231 }
232 rizwank 1.1 th { border-color: #ECECEC; border-left-width: 0px; border-right-width: 1px; border-top-width: 0px; border-bottom-width: 1px; padding: 1px 2px 1px 1px; font: 11px verdana, arial, helvetica, sans-serif; text-align:center; color: #000000; }
233 th.aws { border-color: #ECECEC; border-left-width: 0px; border-right-width: 1px; border-top-width: 0px; border-bottom-width: 1px; padding: 1px 2px 1px 1px; font-size: 13px; font-weight: bold; }
234 td.aws { border-color: #ECECEC; border-left-width: 0px; border-right-width: 1px; border-top-width: 0px; border-bottom-width: 1px; font: 11px verdana, arial, helvetica, sans-serif; text-align:left; color: #000000; padding: 0px;}
235 td.awsm { border-left-width: 0px; border-right-width: 0px; border-top-width: 0px; border-bottom-width: 0px; font: 11px verdana, arial, helvetica, sans-serif; text-align:left; color: #000000; padding: 0px; }
236 //-->
237 </style>
238 <a name="extra6"> </a><br /><table class="aws_border" border="0" cellpadding="2" cellspacing="0" width="100%">
239 <tr><td class="aws_title" width="70%">Domains aliases</td><td class="aws_blank"> </td></tr>
240 <tr><td colspan="2">
241 <table class="aws_data" border="1" bordercolor="#ECECEC" cellpadding="2" cellspacing="0" width="100%">
242 <tr bgcolor="#ECECEC"><th>Domain alias</th><th align="center" bgcolor="#66F0FF" width="80">Hits</th><th width="120" align="center">Last visit</th></tr>
243 <tr><td class="aws">www.domain.com</td><td align="center">1757131</td><td align="center">08 August 2004 - 13:01</td></tr>
244 <tr><td class="aws">www.otherdomainname.com</td><td align="center">98518</td><td align="center">08 August 2004 - 12:54</td></tr>
245 <tr><td class="aws">domain.com</td><td align="center">19107</td><td align="center">08 August 2004 - 12:42</td></tr>
246 <tr><td class="aws">www.againadomainname.org</td><td align="center">7609</td><td align="center">08 August 2004 - 11:56</td></tr>
247 <tr><td class="aws"><b>Total</b></td><td align="center">1883986</td><td> </td></tr>
248 </table></td></tr></table><br />
249
250
251
252
253 rizwank 1.1 <br><a name="level2dir"><H2 style="font: 18px arial,helvetica,sans-serif color: #606060"><u>Example 6: List of top level 2 path under a directory /mydir</u></H2></a>
254 So this is how you need to setup your ExtraSection to add a chart for a such tracking:<br>
255 <i>
256 <br>ExtraSectionName1="List of top level 2 path under /mydir"
257 <br>ExtraSectionCodeFilter1="200 304"
258 <br>ExtraSectionCondition1="URL,^\/mydir\/.*"
259 <br>ExtraSectionFirstColumnTitle1="Directory name"
260 <br>ExtraSectionFirstColumnValues1="URL,^\/mydir\/([\w]+)\/"
261 <br>ExtraSectionStatTypes1=PHK
262 <br>MaxNbOfExtra1=50
263 <br>MinHitExtra1=1
264 </i>
265 <br><br>
266
267
268 <br><br>
269 There is a lot of other possible use for Extra Sections ...<br>
270 <br>
271
272 <br>
273 <br>
274 rizwank 1.1 <br>
275
276
277 <a name="extraconfig"></a>
278 <br>
279 <u><b>The following explanation is same than the one found in AWStats config file:</b></u><br>
280 <br>#-----------------------------------------------------------------------------
281 <br># EXTRA SECTIONS
282 <br>#-----------------------------------------------------------------------------
283 <br># You can define your own charts, you choose here what are rows and columns
284 <br># keys. This feature is particularly usefull for marketing purpose, tracking
285 <br># products orders for example.
286 <br># For this, edit all parameters of Extra section. Each set of parameter is a
287 <br># different chart. For several charts, duplicate section changing the number.
288 <br># Note: Each Extra section reduces AWStats speed by 8%.
289 <br>#
290 <br># WARNING: A wrong setup of Extra section might result in too large arrays
291 <br># that will consume all your memory, making AWStats unusable after several
292 <br># updates, so be sure to setup it correctly.
293 <br># In most cases, you don't need this feature.
294 <br>#
295 rizwank 1.1 <br># ExtraSectionNameX is title of your personalized chart.
296 <br># ExtraSectionCodeFilterX is list of codes the record code field must match.
297 <br># Put an empty string for no test on code.
298 <br># ExtraSectionConditionX are conditions you can use to count or not the hit,
299 <br># Use one of the field condition (URL,QUERY_STRING,REFERER,UA,HOST)
300 <br># and a regex to match, after a coma. Use "|" for "OR".
301 <br># ExtraSectionFirstColumnTitleX is the first column title of the chart.
302 <br># ExtraSectionFirstColumnValuesX is a Regex string to tell AWStats in which
303 <br># field to extract value from (URL,QUERY_STRING,REFERER,UA,HOST)
304 <br># and how to extract the value (using regex syntax). Each different value
305 <br># found will appear in first column of report on a different row. Be sure
306 <br># that list of different possible values will not grow indefinitely.
307 <br># ExtraSectionFirstColumnFormatX is the string used to write value.
308 <br># ExtraSectionStatTypesX are things you want to count. You can use standard
309 <br># code letters (P for pages,H for hits,B for bandwidth,L for last access).
310 <br># ExtraSectionAddAverageRowX add a row at bottom of chart with average values.
311 <br># ExtraSectionAddSumRowX add a row at bottom of chart with sum values.
312 <br># MaxNbOfExtraX is maximum number of rows shown in chart.
313 <br># MinHitExtraX is minimum number of hits required to be shown in chart.
314
315 <br><br>
316 rizwank 1.1 Warning: the ExtraSectionConditionX MUST use regex values since AWStats 6.0.<br>
317 ExtraSectionFirstColumnValuesX also need REGEX value for all AWStats versions.<br>
318 See examples for syntax use.<br>
319 <br>
320
321
322
323
324 <br>
325 <hr>
326
327 <script language=javascript>
328 var date='$Date: 2004/12/18 22:04:21 $';
329 document.writeln("Last revision: "+date);
330 </script>
331
332 </body>
333 </html>
|
Return to
awstats_extra.html
CVS log
Up to [RizwankCVS] / geekymedia_web / awstats-6.3 / docs