UsageStatisticsPlugin

Statistics Reports

This plugins shows detailed usage statistics reports of TWiki content and users. Visit the following pages:

• Usage Statistics Overview - overview statistics by month
• Usage Statistics by User - statistics by user and month

Notes:

• Access to user statistice is restricted to administrators for privacy reasons.
• Statistics are derived from the TWiki logs.

Screenshots of Reports

Usage Statistics Overview		Usage Statistics by User
click on image to enlarge		click on image to enlarge

Syntax Rules

You can safely ignore this section unless you want to build your own reports.

The UsageStatisticsOverview and UsageStatisticsByUser pages embed the following variable to show usage statistics:

%USAGESTATISTICS{ action="..." ... }%

The action can be "overview", "user" or "monthlist".

Supported parameters for action="overview" to generate overview statistics:

Statistics of the current month are shown by default. If a selected month has no statistics, this message is shown: "No statistics are available for this month."

Supported parameters for action="user" to generate statistics by user:

Statistics of the current month are shown by default. If no user is specified, this message is shown: "Please specify a user." If a selected month has no statistics, this message is shown: "No statistics are available for this month."

Supported parameters for action="monthlist" to get list of months where statistics are available:

Plugin Installation & Configuration

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

• For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

• Or, follow these manual installation steps:
  • Download the ZIP file from the Plugins home (see below).
  • Unzip UsageStatisticsPlugin.zip in your twiki installation directory. Content:

    File:	Description:
    data/TWiki/UsageStatisticsPlugin.txt	Plugin topic
    data/TWiki/UsageStatisticsOverview.txt	Overview statistics topic
    data/TWiki/UsageStatisticsByUser.txt	User statistics topic
    lib/TWiki/Plugins/UsageStatisticsPlugin.pm	Plugin Perl module
    lib/TWiki/Plugins/UsageStatisticsPlugin/Core.pm	Plugin Perl class
    pub/TWiki/Plugins/UsageStatisticsPlugin/*.png	Screenshots

  • Set the ownership of the extracted directories and files to the webserver user.

• Plugin configuration and testing:
  • Run the configure script and enable the plugin in the Plugins section.
  • Test if the installation was successful: See UsageStatisticsOverview, UsageStatisticsByUser

Plugin Info

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Show detailed monthly usage statistics of TWiki content and users

• This plugin is sponsored by e-Ecosystems, Inc.

Related Topics: UsageStatisticsOverview, UsageStatisticsByUser, TWikiPlugins, UserDocumentationCategory, AdminDocumentationCategory