From 8299a7d785c09ba1b668d96704f2bcef410014d4 Mon Sep 17 00:00:00 2001 From: Gregory Soutade Date: Wed, 31 Dec 2014 14:09:12 +0100 Subject: [PATCH] Update doc --- docs/index.md | 209 ++++++++++++++++++++++++------------------- docs/modules.md | 209 ++++++++++++++++++++++++------------------- iwla.py | 2 +- tools/extract_doc.py | 7 ++ 4 files changed, 244 insertions(+), 183 deletions(-) diff --git a/docs/index.md b/docs/index.md index 9fa98a3..2ed12ff 100644 --- a/docs/index.md +++ b/docs/index.md @@ -110,6 +110,7 @@ iwla DB_ROOT/meta.db DB_ROOT/year/month/iwla.db OUTPUT_ROOT/index.html + OUTPUT_ROOT/year/_stats.html OUTPUT_ROOT/year/month/index.html Statistics creation : @@ -175,6 +176,32 @@ iwla None +plugins.display.top_visitors +---------------------------- + + Display hook + + Create TOP visitors block + + Plugin requirements : + None + + Conf values needed : + display_visitor_ip* + + Output files : + OUTPUT_ROOT/year/month/index.html + + Statistics creation : + None + + Statistics update : + None + + Statistics deletion : + None + + plugins.display.all_visits -------------------------- @@ -233,32 +260,6 @@ plugins.display.referers None -plugins.display.top_visitors ----------------------------- - - Display hook - - Create TOP visitors block - - Plugin requirements : - None - - Conf values needed : - display_visitor_ip* - - Output files : - OUTPUT_ROOT/year/month/index.html - - Statistics creation : - None - - Statistics update : - None - - Statistics deletion : - None - - plugins.display.top_pages ------------------------- @@ -287,34 +288,6 @@ plugins.display.top_pages 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_downloads ----------------------------- @@ -343,47 +316,46 @@ plugins.display.top_downloads None -plugins.pre_analysis.page_to_hit --------------------------------- +plugins.display.top_hits +------------------------ - Pre analysis hook - Change page into hit and hit into page into statistics + Display hook + + Create TOP hits page Plugin requirements : - None + post_analysis/top_hits Conf values needed : - page_to_hit_conf* - hit_to_page_conf* + max_hits_displayed* + create_all_hits_page* Output files : - None + OUTPUT_ROOT/year/month/top_hits.html + OUTPUT_ROOT/year/month/index.html Statistics creation : None Statistics update : - visits : - remote_addr => - is_page + None Statistics deletion : None -plugins.pre_analysis.robots ---------------------------- +plugins.display.referers_diff +----------------------------- - Pre analysis hook + Display hook - Filter robots + Enlight new and updated key phrases in in all_key_phrases.html Plugin requirements : - None + display/referers Conf values needed : - page_to_hit_conf* - hit_to_page_conf* + None Output files : None @@ -392,9 +364,36 @@ plugins.pre_analysis.robots None Statistics update : - visits : - remote_addr => - robot + None + + Statistics deletion : + None + + +plugins.post_analysis.reverse_dns +--------------------------------- + + Post analysis hook + + Replace IP by reverse DNS names + + Plugin requirements : + None + + Conf values needed : + reverse_dns_timeout* + + Output files : + None + + Statistics creation : + None + + Statistics update : + valid_visitors: + remote_addr + dns_name_replaced + dns_analyzed Statistics deletion : None @@ -465,18 +464,18 @@ plugins.post_analysis.top_pages None -plugins.post_analysis.reverse_dns ---------------------------------- +plugins.post_analysis.top_downloads +----------------------------------- Post analysis hook - Replace IP by reverse DNS names + Count TOP downloads Plugin requirements : None Conf values needed : - reverse_dns_timeout* + None Output files : None @@ -485,10 +484,9 @@ plugins.post_analysis.reverse_dns None Statistics update : - valid_visitors: - remote_addr - dns_name_replaced - dns_analyzed + month_stats: + top_downloads => + uri Statistics deletion : None @@ -522,18 +520,19 @@ plugins.post_analysis.top_hits None -plugins.post_analysis.top_downloads ------------------------------------ +plugins.pre_analysis.robots +--------------------------- - Post analysis hook + Pre analysis hook - Count TOP downloads + Filter robots Plugin requirements : None Conf values needed : - None + page_to_hit_conf* + hit_to_page_conf* Output files : None @@ -542,9 +541,37 @@ plugins.post_analysis.top_downloads None Statistics update : - month_stats: - top_downloads => - uri + visits : + remote_addr => + robot + + Statistics deletion : + None + + +plugins.pre_analysis.page_to_hit +-------------------------------- + + Pre analysis hook + Change page into hit and hit into page into statistics + + Plugin requirements : + None + + Conf values needed : + page_to_hit_conf* + hit_to_page_conf* + + Output files : + None + + Statistics creation : + None + + Statistics update : + visits : + remote_addr => + is_page Statistics deletion : None diff --git a/docs/modules.md b/docs/modules.md index 5067afb..2a028ee 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -18,6 +18,7 @@ iwla DB_ROOT/meta.db DB_ROOT/year/month/iwla.db OUTPUT_ROOT/index.html + OUTPUT_ROOT/year/_stats.html OUTPUT_ROOT/year/month/index.html Statistics creation : @@ -83,6 +84,32 @@ iwla None +plugins.display.top_visitors +---------------------------- + + Display hook + + Create TOP visitors block + + Plugin requirements : + None + + Conf values needed : + display_visitor_ip* + + Output files : + OUTPUT_ROOT/year/month/index.html + + Statistics creation : + None + + Statistics update : + None + + Statistics deletion : + None + + plugins.display.all_visits -------------------------- @@ -141,32 +168,6 @@ plugins.display.referers None -plugins.display.top_visitors ----------------------------- - - Display hook - - Create TOP visitors block - - Plugin requirements : - None - - Conf values needed : - display_visitor_ip* - - Output files : - OUTPUT_ROOT/year/month/index.html - - Statistics creation : - None - - Statistics update : - None - - Statistics deletion : - None - - plugins.display.top_pages ------------------------- @@ -195,34 +196,6 @@ plugins.display.top_pages 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_downloads ----------------------------- @@ -251,47 +224,46 @@ plugins.display.top_downloads None -plugins.pre_analysis.page_to_hit --------------------------------- +plugins.display.top_hits +------------------------ - Pre analysis hook - Change page into hit and hit into page into statistics + Display hook + + Create TOP hits page Plugin requirements : - None + post_analysis/top_hits Conf values needed : - page_to_hit_conf* - hit_to_page_conf* + max_hits_displayed* + create_all_hits_page* Output files : - None + OUTPUT_ROOT/year/month/top_hits.html + OUTPUT_ROOT/year/month/index.html Statistics creation : None Statistics update : - visits : - remote_addr => - is_page + None Statistics deletion : None -plugins.pre_analysis.robots ---------------------------- +plugins.display.referers_diff +----------------------------- - Pre analysis hook + Display hook - Filter robots + Enlight new and updated key phrases in in all_key_phrases.html Plugin requirements : - None + display/referers Conf values needed : - page_to_hit_conf* - hit_to_page_conf* + None Output files : None @@ -300,9 +272,36 @@ plugins.pre_analysis.robots None Statistics update : - visits : - remote_addr => - robot + None + + Statistics deletion : + None + + +plugins.post_analysis.reverse_dns +--------------------------------- + + Post analysis hook + + Replace IP by reverse DNS names + + Plugin requirements : + None + + Conf values needed : + reverse_dns_timeout* + + Output files : + None + + Statistics creation : + None + + Statistics update : + valid_visitors: + remote_addr + dns_name_replaced + dns_analyzed Statistics deletion : None @@ -373,18 +372,18 @@ plugins.post_analysis.top_pages None -plugins.post_analysis.reverse_dns ---------------------------------- +plugins.post_analysis.top_downloads +----------------------------------- Post analysis hook - Replace IP by reverse DNS names + Count TOP downloads Plugin requirements : None Conf values needed : - reverse_dns_timeout* + None Output files : None @@ -393,10 +392,9 @@ plugins.post_analysis.reverse_dns None Statistics update : - valid_visitors: - remote_addr - dns_name_replaced - dns_analyzed + month_stats: + top_downloads => + uri Statistics deletion : None @@ -430,18 +428,19 @@ plugins.post_analysis.top_hits None -plugins.post_analysis.top_downloads ------------------------------------ +plugins.pre_analysis.robots +--------------------------- - Post analysis hook + Pre analysis hook - Count TOP downloads + Filter robots Plugin requirements : None Conf values needed : - None + page_to_hit_conf* + hit_to_page_conf* Output files : None @@ -450,9 +449,37 @@ plugins.post_analysis.top_downloads None Statistics update : - month_stats: - top_downloads => - uri + visits : + remote_addr => + robot + + Statistics deletion : + None + + +plugins.pre_analysis.page_to_hit +-------------------------------- + + Pre analysis hook + Change page into hit and hit into page into statistics + + Plugin requirements : + None + + Conf values needed : + page_to_hit_conf* + hit_to_page_conf* + + Output files : + None + + Statistics creation : + None + + Statistics update : + visits : + remote_addr => + is_page Statistics deletion : None diff --git a/iwla.py b/iwla.py index 0e56c96..493ab19 100755 --- a/iwla.py +++ b/iwla.py @@ -130,7 +130,7 @@ class IWLA(object): ANALYSIS_CLASS = 'HTTP' API_VERSION = 1 - IWLA_VERSION = '0.2' + IWLA_VERSION = '0.2-dev' def __init__(self, logLevel): self.meta_infos = {} diff --git a/tools/extract_doc.py b/tools/extract_doc.py index eee534b..46220eb 100755 --- a/tools/extract_doc.py +++ b/tools/extract_doc.py @@ -2,11 +2,18 @@ import sys +excludes = ['istats_diff.py'] + filename = sys.argv[1] if filename.endswith('__init__.py'): sys.exit(0) +for e in excludes: + if filename.endswith(e): + sys.stderr.write('\tSkip %s\n' % (filename)) + sys.exit(0) + package_name = filename.replace('/', '.').replace('.py', '') sys.stdout.write('%s' % (package_name)) sys.stdout.write('\n')