iwla

iwla Commit Details

Date:2022-06-23 21:21:18 (5 months 7 days ago)
Author:Grégory Soutadé
Branch:dev, master
Commit:b92a017dba61b4b2d11dc2bba468ffe80a69c5a1
Parents: 4d3c2107f0167466888e2fe10074605ce1cdd8b0
Message:Update documentation

Changes:
Mdocs/index.md (7 diffs)
Mdocs/main.md (1 diff)
Mdocs/modules.md (6 diffs)

File differences

docs/index.md
1111
1212
1313
14
14
1515
16
16
17
1718
1819
1920
......
121122
122123
123124
125
124126
125127
126128
......
214216
215217
216218
219
217220
218221
219222
......
318321
319322
320323
321
322
323324
324325
325
326
327
328
329
330
331
332
333
334
335326
336327
337328
......
788779
789780
790781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
791824
792825
793826
......
10891122
10901123
10911124
1092
1093
1125
10941126
10951127
10961128
......
11021134
11031135
11041136
1137
11051138
11061139
11071140
Usage
-----
./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]
./iwla [-c|--config-file file] [-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 : Configuration file to use (default conf.py)
-C : Clean output (database and HTML) before starting
-i : Read data from stdin instead of conf.analyzed_filename
-f : Analyse this log file, multiple files can be specified (comma separated). gz files are acceptedRead data from FILE instead of conf.analyzed_filename
-d : Loglevel in ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']
* plugins/display/track_users.py
* plugins/post_analysis/browsers.py
* plugins/post_analysis/feeds.py
* plugins/post_analysis/filter_users.py
* plugins/post_analysis/hours_stats.py
* plugins/post_analysis/ip_to_geo.py
* plugins/post_analysis/iptogeo.py
robot
hit_only
is_page
keep_requests
valid_visitors:
month_stats without robot and hit only visitors (if not conf.count_hit_only_visitors)
None
Conf values needed :
filtered_users : list of filters
filtered_ip : list of ip (string)
create_filtered_page*
Filter is a list of filter description combined by AND operator
Filter description is a list of 3 elements :
* Field to match in visits
* Operator '=', '==', '!=', '>', '>=', '<', '<=' for int value
* Operator '=', '==', '!=', 'in', 'match' for str value
* Target value
For easiest config, you can indicate both 'remote_addr' or 'ip' in field element
Output files :
OUTPUT_ROOT/year/month/index.html
OUTPUT_ROOT/year/month/filtered_users.html
None
plugins.post_analysis.filter_users
----------------------------------
Post analysis hook
Filter users with given user conditions
Plugin requirements :
None
Conf values needed :
filtered_users : list of filters
filtered_ip : list of ip (string)
create_filtered_page*
Filter is a list of filter description combined by AND operator
Filter description is a list of 3 elements :
* Field to match in visits
* Operator '=', '==', '!=', '>', '>=', '<', '<=' for int value
* Operator '=', '==', '!=', 'in', 'match' for str value
* Target value
For easiest config, you can indicate both 'remote_addr' or 'ip' in field element
Output files :
None
Statistics creation :
visits :
remote_addr =>
filtered
Statistics update :
visits :
remote_addr =>
keep_requests
Statistics deletion :
None
plugins.post_analysis.hours_stats
---------------------------------
None
Conf values needed :
page_to_hit_conf*
hit_to_page_conf*
None
Output files :
None
visits :
remote_addr =>
robot
keep_requests
Statistics deletion :
None
docs/main.md
1111
1212
1313
14
14
1515
16
16
17
1718
1819
1920
Usage
-----
./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]
./iwla [-c|--config-file file] [-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 : Configuration file to use (default conf.py)
-C : Clean output (database and HTML) before starting
-i : Read data from stdin instead of conf.analyzed_filename
-f : Analyse this log file, multiple files can be specified (comma separated). gz files are acceptedRead data from FILE instead of conf.analyzed_filename
-d : Loglevel in ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']
docs/modules.md
1919
2020
2121
22
2223
2324
2425
......
112113
113114
114115
116
115117
116118
117119
......
216218
217219
218220
219
220
221221
222222
223
224
225
226
227
228
229
230
231
232
233223
234224
235225
......
686676
687677
688678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
689721
690722
691723
......
9871019
9881020
9891021
990
991
1022
9921023
9931024
9941025
......
10001031
10011032
10021033
1034
10031035
10041036
10051037
* plugins/display/track_users.py
* plugins/post_analysis/browsers.py
* plugins/post_analysis/feeds.py
* plugins/post_analysis/filter_users.py
* plugins/post_analysis/hours_stats.py
* plugins/post_analysis/ip_to_geo.py
* plugins/post_analysis/iptogeo.py
robot
hit_only
is_page
keep_requests
valid_visitors:
month_stats without robot and hit only visitors (if not conf.count_hit_only_visitors)
None
Conf values needed :
filtered_users : list of filters
filtered_ip : list of ip (string)
create_filtered_page*
Filter is a list of filter description combined by AND operator
Filter description is a list of 3 elements :
* Field to match in visits
* Operator '=', '==', '!=', '>', '>=', '<', '<=' for int value
* Operator '=', '==', '!=', 'in', 'match' for str value
* Target value
For easiest config, you can indicate both 'remote_addr' or 'ip' in field element
Output files :
OUTPUT_ROOT/year/month/index.html
OUTPUT_ROOT/year/month/filtered_users.html
None
plugins.post_analysis.filter_users
----------------------------------
Post analysis hook
Filter users with given user conditions
Plugin requirements :
None
Conf values needed :
filtered_users : list of filters
filtered_ip : list of ip (string)
create_filtered_page*
Filter is a list of filter description combined by AND operator
Filter description is a list of 3 elements :
* Field to match in visits
* Operator '=', '==', '!=', '>', '>=', '<', '<=' for int value
* Operator '=', '==', '!=', 'in', 'match' for str value
* Target value
For easiest config, you can indicate both 'remote_addr' or 'ip' in field element
Output files :
None
Statistics creation :
visits :
remote_addr =>
filtered
Statistics update :
visits :
remote_addr =>
keep_requests
Statistics deletion :
None
plugins.post_analysis.hours_stats
---------------------------------
None
Conf values needed :
page_to_hit_conf*
hit_to_page_conf*
None
Output files :
None
visits :
remote_addr =>
robot
keep_requests
Statistics deletion :
None

Archive Download the corresponding diff file

Branches

Tags