iwla

iwla Git Source Tree

Root/docs/modules.md

Source at commit 4e02325733e5e8e4f5de2f0046e721f8da7abfff created 6 years 10 months ago.
By Gregory Soutade, Initial commit
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.top_downloads
87-----------------------------
88
89 Display hook
90
91 Create TOP downloads page
92
93 Plugin requirements :
94 post_analysis/top_downloads
95
96 Conf values needed :
97 max_downloads_displayed*
98 create_all_downloads_page*
99
100 Output files :
101 OUTPUT_ROOT/year/month/top_downloads.html
102 OUTPUT_ROOT/year/month/index.html
103
104 Statistics creation :
105 None
106
107 Statistics update :
108 None
109
110 Statistics deletion :
111 None
112
113
114plugins.display.all_visits
115--------------------------
116
117 Display hook
118
119 Create All visits page
120
121 Plugin requirements :
122 None
123
124 Conf values needed :
125 display_visitor_ip*
126
127 Output files :
128 OUTPUT_ROOT/year/month/all_visits.html
129 OUTPUT_ROOT/year/month/index.html
130
131 Statistics creation :
132 None
133
134 Statistics update :
135 None
136
137 Statistics deletion :
138 None
139
140
141plugins.display.top_hits
142------------------------
143
144 Display hook
145
146 Create TOP hits page
147
148 Plugin requirements :
149 post_analysis/top_hits
150
151 Conf values needed :
152 max_hits_displayed*
153 create_all_hits_page*
154
155 Output files :
156 OUTPUT_ROOT/year/month/top_hits.html
157 OUTPUT_ROOT/year/month/index.html
158
159 Statistics creation :
160 None
161
162 Statistics update :
163 None
164
165 Statistics deletion :
166 None
167
168
169plugins.display.referers
170------------------------
171
172 Display hook
173
174 Create Referers page
175
176 Plugin requirements :
177 post_analysis/referers
178
179 Conf values needed :
180 max_referers_displayed*
181 create_all_referers_page*
182 max_key_phrases_displayed*
183 create_all_key_phrases_page*
184
185 Output files :
186 OUTPUT_ROOT/year/month/referers.html
187 OUTPUT_ROOT/year/month/key_phrases.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_visitors
201----------------------------
202
203 Display hook
204
205 Create TOP visitors block
206
207 Plugin requirements :
208 None
209
210 Conf values needed :
211 display_visitor_ip*
212
213 Output files :
214 OUTPUT_ROOT/year/month/index.html
215
216 Statistics creation :
217 None
218
219 Statistics update :
220 None
221
222 Statistics deletion :
223 None
224
225
226plugins.display.top_pages
227-------------------------
228
229 Display hook
230
231 Create TOP pages page
232
233 Plugin requirements :
234 post_analysis/top_pages
235
236 Conf values needed :
237 max_pages_displayed*
238 create_all_pages_page*
239
240 Output files :
241 OUTPUT_ROOT/year/month/top_pages.html
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.post_analysis.top_downloads
255-----------------------------------
256
257 Post analysis hook
258
259 Count TOP downloads
260
261 Plugin requirements :
262 None
263
264 Conf values needed :
265 None
266
267 Output files :
268 None
269
270 Statistics creation :
271 None
272
273 Statistics update :
274 month_stats:
275 top_downloads =>
276 uri
277
278 Statistics deletion :
279 None
280
281
282plugins.post_analysis.top_hits
283------------------------------
284
285 Post analysis hook
286
287 Count TOP hits
288
289 Plugin requirements :
290 None
291
292 Conf values needed :
293 None
294
295 Output files :
296 None
297
298 Statistics creation :
299 None
300
301 Statistics update :
302 month_stats:
303 top_hits =>
304 uri
305
306 Statistics deletion :
307 None
308
309
310plugins.post_analysis.referers
311------------------------------
312
313 Post analysis hook
314
315 Extract referers and key phrases from requests
316
317 Plugin requirements :
318 None
319
320 Conf values needed :
321 domain_name
322
323 Output files :
324 None
325
326 Statistics creation :
327 None
328
329 Statistics update :
330 month_stats :
331 referers =>
332 pages
333 hits
334 robots_referers =>
335 pages
336 hits
337 search_engine_referers =>
338 pages
339 hits
340 key_phrases =>
341 phrase
342
343 Statistics deletion :
344 None
345
346
347plugins.post_analysis.reverse_dns
348---------------------------------
349
350 Post analysis hook
351
352 Replace IP by reverse DNS names
353
354 Plugin requirements :
355 None
356
357 Conf values needed :
358 reverse_dns_timeout*
359
360 Output files :
361 None
362
363 Statistics creation :
364 None
365
366 Statistics update :
367 valid_visitors:
368 remote_addr
369 dns_name_replaced
370 dns_analyzed
371
372 Statistics deletion :
373 None
374
375
376plugins.post_analysis.top_pages
377-------------------------------
378
379 Post analysis hook
380
381 Count TOP pages
382
383 Plugin requirements :
384 None
385
386 Conf values needed :
387 None
388
389 Output files :
390 None
391
392 Statistics creation :
393 None
394
395 Statistics update :
396 month_stats:
397 top_pages =>
398 uri
399
400 Statistics deletion :
401 None
402
403
404plugins.pre_analysis.page_to_hit
405--------------------------------
406
407 Pre analysis hook
408 Change page into hit and hit into page into statistics
409
410 Plugin requirements :
411 None
412
413 Conf values needed :
414 page_to_hit_conf*
415 hit_to_page_conf*
416
417 Output files :
418 None
419
420 Statistics creation :
421 None
422
423 Statistics update :
424 visits :
425 remote_addr =>
426 is_page
427
428 Statistics deletion :
429 None
430
431
432plugins.pre_analysis.robots
433---------------------------
434
435 Pre analysis hook
436
437 Filter robots
438
439 Plugin requirements :
440 None
441
442 Conf values needed :
443 page_to_hit_conf*
444 hit_to_page_conf*
445
446 Output files :
447 None
448
449 Statistics creation :
450 None
451
452 Statistics update :
453 visits :
454 remote_addr =>
455 robot
456
457 Statistics deletion :
458 None
459
460

Archive Download this file

Branches

Tags