From ce1aa2d7c67d2372fb6a5264b5e1415525703446 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9gory=20Soutad=C3=A9?= Date: Thu, 8 Jan 2015 21:08:30 +0100 Subject: [PATCH] Update documentation --- docs/index.md | 389 ++++++++++++++++++++++++++++++++---------------- docs/modules.md | 389 ++++++++++++++++++++++++++++++++---------------- 2 files changed, 514 insertions(+), 264 deletions(-) diff --git a/docs/index.md b/docs/index.md index 6b8c2b1..357218c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -91,17 +91,21 @@ Plugins Optional configuration values ends with *. * iwla.py - * plugins/display/all_visits.py - * plugins/display/referers.py * plugins/display/top_downloads.py + * plugins/display/all_visits.py * plugins/display/top_hits.py - * plugins/display/top_pages.py + * plugins/display/browsers.py + * plugins/display/referers.py + * plugins/display/operating_systems.py * plugins/display/top_visitors.py * plugins/display/referers_diff.py - * plugins/post_analysis/referers.py - * plugins/post_analysis/reverse_dns.py + * plugins/display/top_pages.py * plugins/post_analysis/top_downloads.py * plugins/post_analysis/top_hits.py + * plugins/post_analysis/browsers.py + * plugins/post_analysis/referers.py + * plugins/post_analysis/operating_systems.py + * plugins/post_analysis/reverse_dns.py * plugins/post_analysis/top_pages.py * plugins/pre_analysis/page_to_hit.py * plugins/pre_analysis/robots.py @@ -193,6 +197,34 @@ iwla None +plugins.display.top_downloads +----------------------------- + + Display hook + + Create TOP downloads page + + Plugin requirements : + post_analysis/top_downloads + + Conf values needed : + max_downloads_displayed* + create_all_downloads_page* + + Output files : + OUTPUT_ROOT/year/month/top_downloads.html + OUTPUT_ROOT/year/month/index.html + + Statistics creation : + None + + Statistics update : + None + + Statistics deletion : + None + + plugins.display.all_visits -------------------------- @@ -220,6 +252,62 @@ plugins.display.all_visits None +plugins.display.top_hits +------------------------ + + Display hook + + Create TOP hits page + + Plugin requirements : + post_analysis/top_hits + + Conf values needed : + max_hits_displayed* + create_all_hits_page* + + Output files : + OUTPUT_ROOT/year/month/top_hits.html + OUTPUT_ROOT/year/month/index.html + + Statistics creation : + None + + Statistics update : + None + + Statistics deletion : + None + + +plugins.display.browsers +------------------------ + + Display hook + + Create browsers page + + Plugin requirements : + post_analysis/browsers + + Conf values needed : + max_browsers_displayed* + create_browsers_page* + + Output files : + OUTPUT_ROOT/year/month/browsers.html + OUTPUT_ROOT/year/month/index.html + + Statistics creation : + None + + Statistics update : + None + + Statistics deletion : + None + + plugins.display.referers ------------------------ @@ -251,78 +339,20 @@ plugins.display.referers None -plugins.display.top_downloads ------------------------------ +plugins.display.operating_systems +--------------------------------- Display hook - Create TOP downloads page + Add operating systems statistics Plugin requirements : - post_analysis/top_downloads + post_analysis/operating_systems Conf values needed : - max_downloads_displayed* - create_all_downloads_page* + create_families_page* Output files : - OUTPUT_ROOT/year/month/top_downloads.html - OUTPUT_ROOT/year/month/index.html - - Statistics creation : - None - - Statistics update : - None - - Statistics deletion : - None - - -plugins.display.top_hits ------------------------- - - Display hook - - Create TOP hits page - - Plugin requirements : - post_analysis/top_hits - - Conf values needed : - max_hits_displayed* - create_all_hits_page* - - Output files : - OUTPUT_ROOT/year/month/top_hits.html - OUTPUT_ROOT/year/month/index.html - - Statistics creation : - None - - Statistics update : - None - - Statistics deletion : - None - - -plugins.display.top_pages -------------------------- - - Display hook - - Create TOP pages page - - Plugin requirements : - post_analysis/top_pages - - Conf values needed : - max_pages_displayed* - create_all_pages_page* - - Output files : - OUTPUT_ROOT/year/month/top_pages.html OUTPUT_ROOT/year/month/index.html Statistics creation : @@ -387,6 +417,122 @@ plugins.display.referers_diff None +plugins.display.top_pages +------------------------- + + Display hook + + Create TOP pages page + + Plugin requirements : + post_analysis/top_pages + + Conf values needed : + max_pages_displayed* + create_all_pages_page* + + Output files : + OUTPUT_ROOT/year/month/top_pages.html + OUTPUT_ROOT/year/month/index.html + + Statistics creation : + None + + Statistics update : + None + + Statistics deletion : + None + + +plugins.post_analysis.top_downloads +----------------------------------- + + Post analysis hook + + Count TOP downloads + + Plugin requirements : + None + + Conf values needed : + None + + Output files : + None + + Statistics creation : + None + + Statistics update : + month_stats: + top_downloads => + uri => count + + Statistics deletion : + None + + +plugins.post_analysis.top_hits +------------------------------ + + Post analysis hook + + Count TOP hits + + Plugin requirements : + None + + Conf values needed : + None + + Output files : + None + + Statistics creation : + None + + Statistics update : + month_stats: + top_hits => + uri => count + + Statistics deletion : + None + + +plugins.post_analysis.browsers +------------------------------ + + Post analysis hook + + Detect browser information from requests + + Plugin requirements : + None + + Conf values needed : + None + + Output files : + None + + Statistics creation : + visits : + remote_addr => + browser + + month_stats : + browsers => + browser => count + + Statistics update : + None + + Statistics deletion : + None + + plugins.post_analysis.referers ------------------------------ @@ -409,16 +555,51 @@ plugins.post_analysis.referers Statistics update : month_stats : referers => - pages - hits + pages => count + hits => count robots_referers => - pages - hits + pages => count + hits => count search_engine_referers => - pages - hits + pages => count + hits => count key_phrases => - phrase + phrase => count + + Statistics deletion : + None + + +plugins.post_analysis.operating_systems +--------------------------------------- + + Post analysis hook + + Detect operating systems from requests + + Plugin requirements : + None + + Conf values needed : + None + + Output files : + None + + Statistics creation : + visits : + remote_addr => + operating_system + + month_stats : + operating_systems => + operating_system => count + + os_families => + family => count + + Statistics update : + None Statistics deletion : None @@ -453,62 +634,6 @@ plugins.post_analysis.reverse_dns None -plugins.post_analysis.top_downloads ------------------------------------ - - Post analysis hook - - Count TOP downloads - - Plugin requirements : - None - - Conf values needed : - None - - Output files : - None - - Statistics creation : - None - - Statistics update : - month_stats: - top_downloads => - uri - - Statistics deletion : - None - - -plugins.post_analysis.top_hits ------------------------------- - - Post analysis hook - - Count TOP hits - - Plugin requirements : - None - - Conf values needed : - None - - Output files : - None - - Statistics creation : - None - - Statistics update : - month_stats: - top_hits => - uri - - Statistics deletion : - None - - plugins.post_analysis.top_pages ------------------------------- @@ -531,7 +656,7 @@ plugins.post_analysis.top_pages Statistics update : month_stats: top_pages => - uri + uri => count Statistics deletion : None diff --git a/docs/modules.md b/docs/modules.md index 7cf4999..c948786 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -1,15 +1,19 @@ * iwla.py - * plugins/display/all_visits.py - * plugins/display/referers.py * plugins/display/top_downloads.py + * plugins/display/all_visits.py * plugins/display/top_hits.py - * plugins/display/top_pages.py + * plugins/display/browsers.py + * plugins/display/referers.py + * plugins/display/operating_systems.py * plugins/display/top_visitors.py * plugins/display/referers_diff.py - * plugins/post_analysis/referers.py - * plugins/post_analysis/reverse_dns.py + * plugins/display/top_pages.py * plugins/post_analysis/top_downloads.py * plugins/post_analysis/top_hits.py + * plugins/post_analysis/browsers.py + * plugins/post_analysis/referers.py + * plugins/post_analysis/operating_systems.py + * plugins/post_analysis/reverse_dns.py * plugins/post_analysis/top_pages.py * plugins/pre_analysis/page_to_hit.py * plugins/pre_analysis/robots.py @@ -101,6 +105,34 @@ iwla None +plugins.display.top_downloads +----------------------------- + + Display hook + + Create TOP downloads page + + Plugin requirements : + post_analysis/top_downloads + + Conf values needed : + max_downloads_displayed* + create_all_downloads_page* + + Output files : + OUTPUT_ROOT/year/month/top_downloads.html + OUTPUT_ROOT/year/month/index.html + + Statistics creation : + None + + Statistics update : + None + + Statistics deletion : + None + + plugins.display.all_visits -------------------------- @@ -128,6 +160,62 @@ plugins.display.all_visits None +plugins.display.top_hits +------------------------ + + Display hook + + Create TOP hits page + + Plugin requirements : + post_analysis/top_hits + + Conf values needed : + max_hits_displayed* + create_all_hits_page* + + Output files : + OUTPUT_ROOT/year/month/top_hits.html + OUTPUT_ROOT/year/month/index.html + + Statistics creation : + None + + Statistics update : + None + + Statistics deletion : + None + + +plugins.display.browsers +------------------------ + + Display hook + + Create browsers page + + Plugin requirements : + post_analysis/browsers + + Conf values needed : + max_browsers_displayed* + create_browsers_page* + + Output files : + OUTPUT_ROOT/year/month/browsers.html + OUTPUT_ROOT/year/month/index.html + + Statistics creation : + None + + Statistics update : + None + + Statistics deletion : + None + + plugins.display.referers ------------------------ @@ -159,78 +247,20 @@ plugins.display.referers None -plugins.display.top_downloads ------------------------------ +plugins.display.operating_systems +--------------------------------- Display hook - Create TOP downloads page + Add operating systems statistics Plugin requirements : - post_analysis/top_downloads + post_analysis/operating_systems Conf values needed : - max_downloads_displayed* - create_all_downloads_page* + create_families_page* Output files : - OUTPUT_ROOT/year/month/top_downloads.html - OUTPUT_ROOT/year/month/index.html - - Statistics creation : - None - - Statistics update : - None - - Statistics deletion : - None - - -plugins.display.top_hits ------------------------- - - Display hook - - Create TOP hits page - - Plugin requirements : - post_analysis/top_hits - - Conf values needed : - max_hits_displayed* - create_all_hits_page* - - Output files : - OUTPUT_ROOT/year/month/top_hits.html - OUTPUT_ROOT/year/month/index.html - - Statistics creation : - None - - Statistics update : - None - - Statistics deletion : - None - - -plugins.display.top_pages -------------------------- - - Display hook - - Create TOP pages page - - Plugin requirements : - post_analysis/top_pages - - Conf values needed : - max_pages_displayed* - create_all_pages_page* - - Output files : - OUTPUT_ROOT/year/month/top_pages.html OUTPUT_ROOT/year/month/index.html Statistics creation : @@ -295,6 +325,122 @@ plugins.display.referers_diff None +plugins.display.top_pages +------------------------- + + Display hook + + Create TOP pages page + + Plugin requirements : + post_analysis/top_pages + + Conf values needed : + max_pages_displayed* + create_all_pages_page* + + Output files : + OUTPUT_ROOT/year/month/top_pages.html + OUTPUT_ROOT/year/month/index.html + + Statistics creation : + None + + Statistics update : + None + + Statistics deletion : + None + + +plugins.post_analysis.top_downloads +----------------------------------- + + Post analysis hook + + Count TOP downloads + + Plugin requirements : + None + + Conf values needed : + None + + Output files : + None + + Statistics creation : + None + + Statistics update : + month_stats: + top_downloads => + uri => count + + Statistics deletion : + None + + +plugins.post_analysis.top_hits +------------------------------ + + Post analysis hook + + Count TOP hits + + Plugin requirements : + None + + Conf values needed : + None + + Output files : + None + + Statistics creation : + None + + Statistics update : + month_stats: + top_hits => + uri => count + + Statistics deletion : + None + + +plugins.post_analysis.browsers +------------------------------ + + Post analysis hook + + Detect browser information from requests + + Plugin requirements : + None + + Conf values needed : + None + + Output files : + None + + Statistics creation : + visits : + remote_addr => + browser + + month_stats : + browsers => + browser => count + + Statistics update : + None + + Statistics deletion : + None + + plugins.post_analysis.referers ------------------------------ @@ -317,16 +463,51 @@ plugins.post_analysis.referers Statistics update : month_stats : referers => - pages - hits + pages => count + hits => count robots_referers => - pages - hits + pages => count + hits => count search_engine_referers => - pages - hits + pages => count + hits => count key_phrases => - phrase + phrase => count + + Statistics deletion : + None + + +plugins.post_analysis.operating_systems +--------------------------------------- + + Post analysis hook + + Detect operating systems from requests + + Plugin requirements : + None + + Conf values needed : + None + + Output files : + None + + Statistics creation : + visits : + remote_addr => + operating_system + + month_stats : + operating_systems => + operating_system => count + + os_families => + family => count + + Statistics update : + None Statistics deletion : None @@ -361,62 +542,6 @@ plugins.post_analysis.reverse_dns None -plugins.post_analysis.top_downloads ------------------------------------ - - Post analysis hook - - Count TOP downloads - - Plugin requirements : - None - - Conf values needed : - None - - Output files : - None - - Statistics creation : - None - - Statistics update : - month_stats: - top_downloads => - uri - - Statistics deletion : - None - - -plugins.post_analysis.top_hits ------------------------------- - - Post analysis hook - - Count TOP hits - - Plugin requirements : - None - - Conf values needed : - None - - Output files : - None - - Statistics creation : - None - - Statistics update : - month_stats: - top_hits => - uri - - Statistics deletion : - None - - plugins.post_analysis.top_pages ------------------------------- @@ -439,7 +564,7 @@ plugins.post_analysis.top_pages Statistics update : month_stats: top_pages => - uri + uri => count Statistics deletion : None