iwla

iwla Git Source Tree

Root/docs/modules.md

1iwla
2----
3
4 Main class IWLA
5 Parse Log, compute them, call plugins and produce output
6 For now, only HTTP log are valid
7
8 Plugin requirements :
9 None
10
11 Conf values needed :
12 analyzed_filename
13 domain_name
14 locales_path
15 compress_output_files*
16
17 Output files :
18 DB_ROOT/meta.db
19 DB_ROOT/year/month/iwla.db
20 OUTPUT_ROOT/index.html
21 OUTPUT_ROOT/year/month/index.html
22
23 Statistics creation :
24
25 meta :
26 last_time
27 start_analysis_time
28 stats =>
29 year =>
30 month =>
31 viewed_bandwidth
32 not_viewed_bandwidth
33 viewed_pages
34 viewed_hits
35 nb_visits
36 nb_visitors
37
38 month_stats :
39 viewed_bandwidth
40 not_viewed_bandwidth
41 viewed_pages
42 viewed_hits
43 nb_visits
44
45 days_stats :
46 day =>
47 viewed_bandwidth
48 not_viewed_bandwidth
49 viewed_pages
50 viewed_hits
51 nb_visits
52 nb_visitors
53
54 visits :
55 remote_addr =>
56 remote_addr
57 remote_ip
58 viewed_pages
59 viewed_hits
60 not_viewed_pages
61 not_viewed_hits
62 bandwidth
63 last_access
64 requests =>
65 [fields_from_format_log]
66 extract_request =>
67 extract_uri
68 extract_parameters*
69 extract_referer* =>
70 extract_uri
71 extract_parameters*
72 robot
73 hit_only
74 is_page
75
76 valid_visitors:
77 month_stats without robot and hit only visitors (if not conf.count_hit_only_visitors)
78
79 Statistics update :
80 None
81
82 Statistics deletion :
83 None
84
85
86plugins.display.all_visits
87--------------------------
88
89 Display hook
90
91 Create All visits page
92
93 Plugin requirements :
94 None
95
96 Conf values needed :
97 display_visitor_ip*
98
99 Output files :
100 OUTPUT_ROOT/year/month/all_visits.html
101 OUTPUT_ROOT/year/month/index.html
102
103 Statistics creation :
104 None
105
106 Statistics update :
107 None
108
109 Statistics deletion :
110 None
111
112
113plugins.display.referers
114------------------------
115
116 Display hook
117
118 Create Referers page
119
120 Plugin requirements :
121 post_analysis/referers
122
123 Conf values needed :
124 max_referers_displayed*
125 create_all_referers_page*
126 max_key_phrases_displayed*
127 create_all_key_phrases_page*
128
129 Output files :
130 OUTPUT_ROOT/year/month/referers.html
131 OUTPUT_ROOT/year/month/key_phrases.html
132 OUTPUT_ROOT/year/month/index.html
133
134 Statistics creation :
135 None
136
137 Statistics update :
138 None
139
140 Statistics deletion :
141 None
142
143
144plugins.display.top_downloads
145-----------------------------
146
147 Display hook
148
149 Create TOP downloads page
150
151 Plugin requirements :
152 post_analysis/top_downloads
153
154 Conf values needed :
155 max_downloads_displayed*
156 create_all_downloads_page*
157
158 Output files :
159 OUTPUT_ROOT/year/month/top_downloads.html
160 OUTPUT_ROOT/year/month/index.html
161
162 Statistics creation :
163 None
164
165 Statistics update :
166 None
167
168 Statistics deletion :
169 None
170
171
172plugins.display.top_hits
173------------------------
174
175 Display hook
176
177 Create TOP hits page
178
179 Plugin requirements :
180 post_analysis/top_hits
181
182 Conf values needed :
183 max_hits_displayed*
184 create_all_hits_page*
185
186 Output files :
187 OUTPUT_ROOT/year/month/top_hits.html
188 OUTPUT_ROOT/year/month/index.html
189
190 Statistics creation :
191 None
192
193 Statistics update :
194 None
195
196 Statistics deletion :
197 None
198
199
200plugins.display.top_pages
201-------------------------
202
203 Display hook
204
205 Create TOP pages page
206
207 Plugin requirements :
208 post_analysis/top_pages
209
210 Conf values needed :
211 max_pages_displayed*
212 create_all_pages_page*
213
214 Output files :
215 OUTPUT_ROOT/year/month/top_pages.html
216 OUTPUT_ROOT/year/month/index.html
217
218 Statistics creation :
219 None
220
221 Statistics update :
222 None
223
224 Statistics deletion :
225 None
226
227
228plugins.display.top_visitors
229----------------------------
230
231 Display hook
232
233 Create TOP visitors block
234
235 Plugin requirements :
236 None
237
238 Conf values needed :
239 display_visitor_ip*
240
241 Output files :
242 OUTPUT_ROOT/year/month/index.html
243
244 Statistics creation :
245 None
246
247 Statistics update :
248 None
249
250 Statistics deletion :
251 None
252
253
254plugins.display.referers_diff
255-----------------------------
256
257 Display hook
258
259 Enlight new and updated key phrases in in all_key_phrases.html
260
261 Plugin requirements :
262 display/referers
263
264 Conf values needed :
265 None
266
267 Output files :
268 None
269
270 Statistics creation :
271 None
272
273 Statistics update :
274 None
275
276 Statistics deletion :
277 None
278
279
280plugins.post_analysis.referers
281------------------------------
282
283 Post analysis hook
284
285 Extract referers and key phrases from requests
286
287 Plugin requirements :
288 None
289
290 Conf values needed :
291 domain_name
292
293 Output files :
294 None
295
296 Statistics creation :
297 None
298
299 Statistics update :
300 month_stats :
301 referers =>
302 pages
303 hits
304 robots_referers =>
305 pages
306 hits
307 search_engine_referers =>
308 pages
309 hits
310 key_phrases =>
311 phrase
312
313 Statistics deletion :
314 None
315
316
317plugins.post_analysis.reverse_dns
318---------------------------------
319
320 Post analysis hook
321
322 Replace IP by reverse DNS names
323
324 Plugin requirements :
325 None
326
327 Conf values needed :
328 reverse_dns_timeout*
329
330 Output files :
331 None
332
333 Statistics creation :
334 None
335
336 Statistics update :
337 valid_visitors:
338 remote_addr
339 dns_name_replaced
340 dns_analyzed
341
342 Statistics deletion :
343 None
344
345
346plugins.post_analysis.top_downloads
347-----------------------------------
348
349 Post analysis hook
350
351 Count TOP downloads
352
353 Plugin requirements :
354 None
355
356 Conf values needed :
357 None
358
359 Output files :
360 None
361
362 Statistics creation :
363 None
364
365 Statistics update :
366 month_stats:
367 top_downloads =>
368 uri
369
370 Statistics deletion :
371 None
372
373
374plugins.post_analysis.top_hits
375------------------------------
376
377 Post analysis hook
378
379 Count TOP hits
380
381 Plugin requirements :
382 None
383
384 Conf values needed :
385 None
386
387 Output files :
388 None
389
390 Statistics creation :
391 None
392
393 Statistics update :
394 month_stats:
395 top_hits =>
396 uri
397
398 Statistics deletion :
399 None
400
401
402plugins.post_analysis.top_pages
403-------------------------------
404
405 Post analysis hook
406
407 Count TOP pages
408
409 Plugin requirements :
410 None
411
412 Conf values needed :
413 None
414
415 Output files :
416 None
417
418 Statistics creation :
419 None
420
421 Statistics update :
422 month_stats:
423 top_pages =>
424 uri
425
426 Statistics deletion :
427 None
428
429
430plugins.pre_analysis.page_to_hit
431--------------------------------
432
433 Pre analysis hook
434 Change page into hit and hit into page into statistics
435
436 Plugin requirements :
437 None
438
439 Conf values needed :
440 page_to_hit_conf*
441 hit_to_page_conf*
442
443 Output files :
444 None
445
446 Statistics creation :
447 None
448
449 Statistics update :
450 visits :
451 remote_addr =>
452 is_page
453
454 Statistics deletion :
455 None
456
457
458plugins.pre_analysis.robots
459---------------------------
460
461 Pre analysis hook
462
463 Filter robots
464
465 Plugin requirements :
466 None
467
468 Conf values needed :
469 page_to_hit_conf*
470 hit_to_page_conf*
471
472 Output files :
473 None
474
475 Statistics creation :
476 None
477
478 Statistics update :
479 visits :
480 remote_addr =>
481 robot
482
483 Statistics deletion :
484 None
485
486

Archive Download this file

Branches

Tags