Update ChangeLog and Documentation

This commit is contained in:
Grégory Soutadé 2020-04-15 14:44:11 +02:00
parent e71f1de7dc
commit 954b4972a9
4 changed files with 87 additions and 18 deletions

View File

@ -1,12 +1,23 @@
v0.5 (25/05/2017) v0.5 (15/04/2020)
** User ** ** User **
Add --dry-run (-D) argument Add --dry-run (-D) argument
Add more rules for robot detection :
More than ten 404 pages viewed
No page and no Hit
Pages without hit
New format for (not_)viewed pages/hits and bandwidth that are now recorded by day (in a dictionnary were only element 0 is initialized). Element 0 is the total. WARNING : not backward compatible with previous databases.
Sync data with awstat (develop branch : 7.7+)
Make backup before compressing (low memory servers)
Add top_pages_diff plugin
Add IP exclusion feature
** Dev ** ** Dev **
Use cPickle instead of pickle Use cPickle instead of pickle
Don't save all robots requests (only first pass is kept) which allow to save a large amount of memory/disk space Don't save all robots requests (only first pass is kept) which allow to save a large amount of memory/disk space
Add one more rule to robot detection : more than ten 404 pages viewed Handle URLs with empty referer
Don't try to find search engine on robots
** Bugs ** ** Bugs **
Fix KeyError : geo attribute can not exists
Call post hook plugins even in display only mode
v0.4 (29/01/2017) v0.4 (29/01/2017)
** User ** ** User **

View File

@ -11,7 +11,7 @@ Nevertheless, iwla is only focused on HTTP logs. It uses data (robots definition
Usage Usage
----- -----
./iwla [-c|--clean-output] [-i|--stdin] [-f FILE|--file FILE] [-d LOGLEVEL|--log-level LOGLEVEL] [-r|--reset year/month] [-z|--dont-compress] [-p] ./iwla [-c|--clean-output] [-i|--stdin] [-f FILE|--file FILE] [-d LOGLEVEL|--log-level LOGLEVEL] [-r|--reset year/month] [-z|--dont-compress] [-p] [-D|--dry-run]
-c : Clean output (database and HTML) before starting -c : Clean output (database and HTML) before starting
-i : Read data from stdin instead of conf.analyzed_filename -i : Read data from stdin instead of conf.analyzed_filename
@ -20,7 +20,8 @@ Usage
-r : Reset analysis to a specific date (month/year) -r : Reset analysis to a specific date (month/year)
-z : Don't compress databases (bigger but faster, not compatible with compressed databases) -z : Don't compress databases (bigger but faster, not compatible with compressed databases)
-p : Only generate display -p : Only generate display
-d : Dry run (don't write/update files to disk)
Basic usage Basic usage
----------- -----------
@ -113,6 +114,7 @@ Optional configuration values ends with *.
* plugins/display/top_downloads_diff.py * plugins/display/top_downloads_diff.py
* plugins/display/top_downloads.py * plugins/display/top_downloads.py
* plugins/display/top_hits.py * plugins/display/top_hits.py
* plugins/display/top_pages_diff.py
* plugins/display/top_pages.py * plugins/display/top_pages.py
* plugins/display/top_visitors.py * plugins/display/top_visitors.py
* plugins/display/track_users.py * plugins/display/track_users.py
@ -145,7 +147,8 @@ iwla
analyzed_filename analyzed_filename
domain_name domain_name
locales_path locales_path
compress_output_files* compress_output_files
excluded_ip
Output files : Output files :
DB_ROOT/meta.db DB_ROOT/meta.db
@ -189,11 +192,11 @@ iwla
remote_addr => remote_addr =>
remote_addr remote_addr
remote_ip remote_ip
viewed_pages viewed_pages{0..31} # 0 contains total
viewed_hits viewed_hits{0..31} # 0 contains total
not_viewed_pages not_viewed_pages{0..31}
not_viewed_hits not_viewed_hits{0..31}
bandwidth bandwidth{0..31}
last_access last_access
requests => requests =>
[fields_from_format_log] [fields_from_format_log]
@ -573,6 +576,32 @@ plugins.display.top_hits
None None
plugins.display.top_pages_diff
------------------------------
Display hook
Enlight new and updated pages in in top_pages.html
Plugin requirements :
display/top_pages
Conf values needed :
None
Output files :
None
Statistics creation :
None
Statistics update :
None
Statistics deletion :
None
plugins.display.top_pages plugins.display.top_pages
------------------------- -------------------------

View File

@ -12,6 +12,7 @@
* plugins/display/top_downloads_diff.py * plugins/display/top_downloads_diff.py
* plugins/display/top_downloads.py * plugins/display/top_downloads.py
* plugins/display/top_hits.py * plugins/display/top_hits.py
* plugins/display/top_pages_diff.py
* plugins/display/top_pages.py * plugins/display/top_pages.py
* plugins/display/top_visitors.py * plugins/display/top_visitors.py
* plugins/display/track_users.py * plugins/display/track_users.py
@ -44,7 +45,8 @@ iwla
analyzed_filename analyzed_filename
domain_name domain_name
locales_path locales_path
compress_output_files* compress_output_files
excluded_ip
Output files : Output files :
DB_ROOT/meta.db DB_ROOT/meta.db
@ -88,11 +90,11 @@ iwla
remote_addr => remote_addr =>
remote_addr remote_addr
remote_ip remote_ip
viewed_pages viewed_pages{0..31} # 0 contains total
viewed_hits viewed_hits{0..31} # 0 contains total
not_viewed_pages not_viewed_pages{0..31}
not_viewed_hits not_viewed_hits{0..31}
bandwidth bandwidth{0..31}
last_access last_access
requests => requests =>
[fields_from_format_log] [fields_from_format_log]
@ -472,6 +474,32 @@ plugins.display.top_hits
None None
plugins.display.top_pages_diff
------------------------------
Display hook
Enlight new and updated pages in in top_pages.html
Plugin requirements :
display/top_pages
Conf values needed :
None
Output files :
None
Statistics creation :
None
Statistics update :
None
Statistics deletion :
None
plugins.display.top_pages plugins.display.top_pages
------------------------- -------------------------

View File

@ -51,7 +51,8 @@ Conf values needed :
analyzed_filename analyzed_filename
domain_name domain_name
locales_path locales_path
compress_output_files* compress_output_files
excluded_ip
Output files : Output files :
DB_ROOT/meta.db DB_ROOT/meta.db