plugin:statdisplay
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:statdisplay [2014-11-18 11:20] – [Analysis Progress] 194.187.247.26 | plugin:statdisplay [2024-01-08 16:13] (current) – Aleksandr | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Statdisplay | + | ====== Statdisplay |
---- plugin ---- | ---- plugin ---- | ||
- | description: | + | description: |
author | author | ||
email : gohr@cosmocode.de | email : gohr@cosmocode.de | ||
- | type : syntax | + | type : syntax, CLI |
- | lastupdate : 2014-04-18 | + | lastupdate : 2022-12-12 |
- | compatible : Binky,Adora Belle | + | compatible : Greebo, Hogfather, Igor |
- | depends | + | depends |
conflicts | conflicts | ||
similar | similar | ||
Line 18: | Line 18: | ||
---- | ---- | ||
+ | [[https:// | ||
The statdisplay plugin displays various statistics computed using a log file (NCSA combined i.e. like Apache) of all access to DokuWiki pages. The logfile can be read from an Apache log file, or if not available, generated using the [[logstats]] plugin. | The statdisplay plugin displays various statistics computed using a log file (NCSA combined i.e. like Apache) of all access to DokuWiki pages. The logfile can be read from an Apache log file, or if not available, generated using the [[logstats]] plugin. | ||
Line 27: | Line 28: | ||
===== Installation ===== | ===== Installation ===== | ||
- | Install | + | Search and install |
===== Log Analysis ===== | ===== Log Analysis ===== | ||
- | Once installed and configured through the Configuration Manager, it will automatically start to analyze the log file. To limit the time and memory consumption of the log analysis, this is done in chunks of maximum | + | Once installed and configured through the Configuration Manager, it will automatically start to analyze the log file. To limit the time and memory consumption of the log analysis, this is done in chunks of a maximum |
- | ===== Limitations ===== | + | Note: it is important to adjust the number of lines to analyze in the config through the lines parameter. If your wiki has many accesses, the default of 500 may be too low to effectively analyze your logs. |
- | There is a bug in the current DokuWiki release (Adora Belle) that will prevent the log analyser from running when email subscriptions are enabled (disabled by default). If you are using email subscriptions you can upgrade | + | ==== Command Line Interface ==== |
+ | |||
+ | The command line interface allows you to quickly catch up with an existing | ||
+ | |||
+ | $> ./bin/plugin.php statdisplay parse --lines 4000 | ||
+ | |||
+ | Increasing the number of lines analysed at once can increase the effectiveness when running from command line. When the parameter is not given the one from the config is used. | ||
+ | |||
+ | You can also use the CLI to completely reindex your log file (this throws away all previously analyzed data). | ||
+ | |||
+ | $> ./bin/plugin.php statdisplay parse --clear --lines 4000 | ||
+ | |||
+ | |||
+ | ===== Limitations ===== | ||
The plugin tries to limit it's memory usage as far as possible. The log file is only read line-by-line. However all aggregated data is held inside a single memory structure. If you have a lot of accesses, or are running the plugin over a very long period of time, you may need to increase the memory size limit in your php.ini file. | The plugin tries to limit it's memory usage as far as possible. The log file is only read line-by-line. However all aggregated data is held inside a single memory structure. If you have a lot of accesses, or are running the plugin over a very long period of time, you may need to increase the memory size limit in your php.ini file. | ||
+ | |||
+ | ==== Update frequency ==== | ||
+ | |||
+ | The chunksize that is read is determined by the number in the configuration. This also determinates that the plugin waits for about this number of accesses before another chunk is read. You may want to raise this number for wikis with many active users or lower it for wikis with few active users. | ||
===== Syntax ===== | ===== Syntax ===== | ||
Line 52: | Line 70: | ||
{{statdisplay> | {{statdisplay> | ||
- | {{statdisplay> | + | |
==== Access Summary ==== | ==== Access Summary ==== | ||
Line 111: | Line 129: | ||
==== Top Referrers ==== | ==== Top Referrers ==== | ||
- | Show were people came from this month: | + | Show where people came from this month: |
{{statdisplay> | {{statdisplay> |
plugin/statdisplay.1416306047.txt.gz · Last modified: 2014-11-18 11:20 by 194.187.247.26