====== Statistics Plugin ======

---- plugin ----
description: Log and analyze access statistics
author     : Andreas Gohr
email      : andi@splitbrain.org
type       : admin, action
lastupdate : 2008-06-15
compatible : 2008-05-05
depends    : 
conflicts  : 
similar    : 
tags       : statistics, analytics, logging
----

This plugin provides logging and statistics on views and visitors of your wiki. The statistics are not very wiki centric but are more close to what you'd expect from a typical web statistics package. It should be most useful to people using [[DokuWiki]] as their blog or homepage.

:!: This plugin needs a MySQL database. You need at least MySQL 4.1, MySQL 5.0 or higher is recommended.

The following statistics are currently provided:

  * Popular Pages
    * the most viewed pages in the selected time frame
  * Incoming Links
    * the top referrers in the selected time frame
  * New Incoming Links
    * the top referrers which were not seen before the selected time frame
  * Outgoing Links
    * the most clicked outgoing links in the selected time frame
  * Search Phrases
    * the top search phrases people used in search engines to find your wiki in the selected time frame
  * Search Words
    * the top search keywords people used in search engines to find your wiki in the selected time frame
  * Search Engines
    * the most used search engines to find your wiki in the selected time frame
  * Browsers
    * the most used browsers to view your wiki in the selected time frame
  * Operating Systems
    * the most used operating systems used by your visitors in the selected time frame
  * Countries
    * where your visitors came from in the selected time frame
  * Resolution
    * the screen resolution used by your visitors in the seleceted time frame

For many of these stats, graphical diagrams are provided as well.

===== Download =====

  * {{http://dev.splitbrain.org/download/snapshots/statistics-plugin-latest.tgz}}

Alternatively you can check out the plugin from my [[darcs]] repository with

  darcs get http://dev.splitbrain.org/darcs/dwplugins/statistics

==== Changes ====

{{rss>http://dev.splitbrain.org/darcsweb/darcsweb.cgi?r=dwplugins/statistics;a=rss}}

===== Installing =====

  - Install the plugin through the [[plugin:Plugin]] Manager or manually.
  - Create the needed MySQL tables with the provided ''db.sql'' file
  - Configure the database access through the [[plugin:config|Config Manager]]

To create the needed MySQL tables you can 

  * either use phpmyadmin's import function 
     * Select the database that is used by your dokuwiki and chose "Import" from the top-menu, then upload the file.
  * import manually using mysql in your shell 

**Method 1**
<code>
# mysql -u db_user -p your_dokuwiki_database < /full/path/to/db.sql
</code>
**Method 2**
<code>
# mysql -u db_user -p your_dokuwiki_database
Enter password:
[...]
Type 'help;' or '\h' for help. Type '\c' to clear the buffer.

mysql> \. /full/path/to/db.sql
</code>

===== Upgrading =====

Upgrades may require database upgrades. Check the provided db.sql file. Updates statements are marked with their dates. Execute them on your database to upgrade it.

===== Acknowledgments =====

  * Country resolution is provided by [[http://www.hostip.info|hostip.info]]
  * OS, Browser and Search Engine lookup tables come from [[http://awstats.sourceforge.net/|awstats]]
  * Graphs are created by [[http://www.zackbloom.org/|Zack Bloom's Advanced Graphing Class]] ([[http://www.splitbrain.org/blog/2006-10/07-php_graphing_library|modified for PHP4]])

===== Known limitations =====

  * Currently only users with JavaScript enabled are logged
    * this can be easily fixed by placing some %%<noscript>%% code in the template, I just need to investigate that
    * when fixed, stats about search bots could be added
  * some more wiki specific data would be nice (edits, minor edits, internal searchs)
  * the search word parsing is a bit flaky ("don't" is two words)


===== Request =====

>Nice plugin...is there anyway to put the statistics on the a non admin page so users can view them?
>Thanks!
>[[austen.heinz@gmail.com|Austen]]