Differences

This shows you the differences between two versions of the page.

--- plugin:statdisplay [2015-06-24 13:38] – [Access Summary] 192.166.53.201
+++ plugin:statdisplay [2024-01-08 16:13] (current) – Aleksandr
@@ Line 1: / Line 1: @@
-====== Statdisplay plugin ======
+====== Statdisplay Plugin ======
 ---- plugin ----
-description: Displays various statistics and bar graphs computed using a log file of all access to DokuWiki pages.
+description: Displays various statistics and bar graphs computed using a log file of all access to DokuWiki pages
 author     : Andreas Gohr
 email      : gohr@cosmocode.de
-type       : syntax
+type       : syntax, CLI
-lastupdate : 2015-02-26
+lastupdate : 2022-12-12
-compatible : Binky,Adora Belle
+compatible : Greebo, Hogfather, Igor
-depends    : logstats
+depends    :
 conflicts  :
 similar    : statistics, stats
@@ Line 18: / Line 18: @@
 ----
-[[http://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ http://cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]
+[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ https://www.cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode 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 28: / Line 28: @@
 ===== Installation =====
-Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.
+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
 ===== 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 10000 lines per run. The log file analysis is triggered through DokuWiki's indexer mechanism - there is no need to trigger anything manually.
+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 number of lines per run. The log file analysis is triggered through DokuWiki's [[:taskrunner]] mechanism - there is no need to trigger anything manually.
-===== 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 your ''lib/exe/indexer.php'' file with the one found [[https://raw.github.com/splitbrain/dokuwiki/46a853c3756aa4abe582ccb0de6f4e1f4b2035c4/lib/exe/indexer.php|here]].
+==== Command Line Interface ====
+The command line interface allows you to quickly catch up with an existing log file. Run it like this in your DokuWiki directory:
+    $> ./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.
+==== 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 =====
@@ Line 53: / Line 70: @@
   {{statdisplay>progress bar}}
-==== Access Summary ====
-{{statdisplay>traffic by user}}
+==== Access Summary ====
 Gives a summary table over all accesses that were ever logged: