iwla

iwla Git Source Tree

Root/docs/modules.md

Source at commit 2180f9e7d4003ca4adb58c1da7bf3aa1f85023af created 6 years 8 months ago.
By Gregory Soutade, Update doc
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_visitors
145----------------------------
146
147 Display hook
148
149 Create TOP visitors block
150
151 Plugin requirements :
152 None
153
154 Conf values needed :
155 display_visitor_ip*
156
157 Output files :
158 OUTPUT_ROOT/year/month/index.html
159
160 Statistics creation :
161 None
162
163 Statistics update :
164 None
165
166 Statistics deletion :
167 None
168
169
170plugins.display.top_pages
171-------------------------
172
173 Display hook
174
175 Create TOP pages page
176
177 Plugin requirements :
178 post_analysis/top_pages
179
180 Conf values needed :
181 max_pages_displayed*
182 create_all_pages_page*
183
184 Output files :
185 OUTPUT_ROOT/year/month/top_pages.html
186 OUTPUT_ROOT/year/month/index.html
187
188 Statistics creation :
189 None
190
191 Statistics update :
192 None
193
194 Statistics deletion :
195 None
196
197
198plugins.display.top_hits
199------------------------
200
201 Display hook
202
203 Create TOP hits page
204
205 Plugin requirements :
206 post_analysis/top_hits
207
208 Conf values needed :
209 max_hits_displayed*
210 create_all_hits_page*
211
212 Output files :
213 OUTPUT_ROOT/year/month/top_hits.html
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_downloads
227-----------------------------
228
229 Display hook
230
231 Create TOP downloads page
232
233 Plugin requirements :
234 post_analysis/top_downloads
235
236 Conf values needed :
237 max_downloads_displayed*
238 create_all_downloads_page*
239
240 Output files :
241 OUTPUT_ROOT/year/month/top_downloads.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.pre_analysis.page_to_hit
255--------------------------------
256
257 Pre analysis hook
258 Change page into hit and hit into page into statistics
259
260 Plugin requirements :
261 None
262
263 Conf values needed :
264 page_to_hit_conf*
265 hit_to_page_conf*
266
267 Output files :
268 None
269
270 Statistics creation :
271 None
272
273 Statistics update :
274 visits :
275 remote_addr =>
276 is_page
277
278 Statistics deletion :
279 None
280
281
282plugins.pre_analysis.robots
283---------------------------
284
285 Pre analysis hook
286
287 Filter robots
288
289 Plugin requirements :
290 None
291
292 Conf values needed :
293 page_to_hit_conf*
294 hit_to_page_conf*
295
296 Output files :
297 None
298
299 Statistics creation :
300 None
301
302 Statistics update :
303 visits :
304 remote_addr =>
305 robot
306
307 Statistics deletion :
308 None
309
310
311plugins.post_analysis.referers
312------------------------------
313
314 Post analysis hook
315
316 Extract referers and key phrases from requests
317
318 Plugin requirements :
319 None
320
321 Conf values needed :
322 domain_name
323
324 Output files :
325 None
326
327 Statistics creation :
328 None
329
330 Statistics update :
331 month_stats :
332 referers =>
333 pages
334 hits
335 robots_referers =>
336 pages
337 hits
338 search_engine_referers =>
339 pages
340 hits
341 key_phrases =>
342 phrase
343
344 Statistics deletion :
345 None
346
347
348plugins.post_analysis.top_pages
349-------------------------------
350
351 Post analysis hook
352
353 Count TOP pages
354
355 Plugin requirements :
356 None
357
358 Conf values needed :
359 None
360
361 Output files :
362 None
363
364 Statistics creation :
365 None
366
367 Statistics update :
368 month_stats:
369 top_pages =>
370 uri
371
372 Statistics deletion :
373 None
374
375
376plugins.post_analysis.reverse_dns
377---------------------------------
378
379 Post analysis hook
380
381 Replace IP by reverse DNS names
382
383 Plugin requirements :
384 None
385
386 Conf values needed :
387 reverse_dns_timeout*
388
389 Output files :
390 None
391
392 Statistics creation :
393 None
394
395 Statistics update :
396 valid_visitors:
397 remote_addr
398 dns_name_replaced
399 dns_analyzed
400
401 Statistics deletion :
402 None
403
404
405plugins.post_analysis.top_hits
406------------------------------
407
408 Post analysis hook
409
410 Count TOP hits
411
412 Plugin requirements :
413 None
414
415 Conf values needed :
416 None
417
418 Output files :
419 None
420
421 Statistics creation :
422 None
423
424 Statistics update :
425 month_stats:
426 top_hits =>
427 uri
428
429 Statistics deletion :
430 None
431
432
433plugins.post_analysis.top_downloads
434-----------------------------------
435
436 Post analysis hook
437
438 Count TOP downloads
439
440 Plugin requirements :
441 None
442
443 Conf values needed :
444 None
445
446 Output files :
447 None
448
449 Statistics creation :
450 None
451
452 Statistics update :
453 month_stats:
454 top_downloads =>
455 uri
456
457 Statistics deletion :
458 None
459
460

Archive Download this file

Branches

Tags