Tags:
create new tag
, view all tags

UsageStatisticsPlugin

Show detailed monthly usage statistics of TWiki content and users

Statistics Reports

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

TIP 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
stats-overview-thumb.png   stats-users-thumb.png
click on image to enlarge   click on image to enlarge

Syntax Rules

TIP 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:

Parameter Description Default
action="overview" Generate overview statistics none
month="2011-04" Month, format YYYY-MM current month

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:

Parameter Description Default
action="user" Generate statistics by user none
user="..." WikiName of user none
month="2011-04" Month, format YYYY-MM current month

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:

Parameter Description Default
action="monthlist" Get list of months that have statistics logs none
reverse="on" Reverse the list, e.g. newest months first. "off"
format="..." Format for each month. $month expands to the month, format YYYY-MM "$month"
separator="..." Separator between months. "$n" (newline)

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 Info

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

Plugin Author: TWiki:Main.PeterThoeny
Copyright: © 2011 e-Ecosystems Inc
© 2011-2013 TWiki:TWiki.TWikiContributor
License: GPL (GNU General Public License)
Sponsor: e-Ecosystems, Inc
Plugin Version: 2013-09-15
2013-04-11: TWikibug:Item7154: Minor doc fixes
2013-04-11: TWikibug:Item7154: Doc enhancements; document File::Temp dependency; add twisties
2011-07-15: TWikibug:Item6764: Minor fix to remove warning message in error log
2011-07-10: TWikibug:Item6725: Change global package variables from "use vars" to "our"
2011-04-23: TWikibug:Item6686: Initial version
TWiki Dependency: $TWiki::Plugins::VERSION 1.2 (TWiki-4.3)
CPAN Dependencies: CPAN:File::Temp > = 0.18
Other Dependencies: none
Perl Version: 5.005
Benchmarks: GoodStyle nn%, FormattedSearch nn%, UsageStatisticsPlugin nn%
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/UsageStatisticsPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/UsageStatisticsPluginDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/UsageStatisticsPluginAppraisal

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

Topic attachments
I Attachment History Action Size Date Who Comment
Unknown file formatmd5 UsageStatisticsPlugin.md5 r6 r5 r4 r3 r2 manage 0.2 K 2013-09-15 - 22:04 PeterThoeny  
Compressed Zip archivetgz UsageStatisticsPlugin.tgz r6 r5 r4 r3 r2 manage 330.1 K 2013-09-15 - 22:03 PeterThoeny  
Compressed Zip archivezip UsageStatisticsPlugin.zip r6 r5 r4 r3 r2 manage 332.9 K 2013-09-15 - 22:03 PeterThoeny  
Unknown file formatEXT UsageStatisticsPlugin_installer r1 manage 3.9 K 2013-09-15 - 22:03 PeterThoeny  
Edit | Attach | Watch | Print version | History: r7 < r6 < r5 < r4 < r3 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r7 - 2013-10-16 - PeterThoeny
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2016 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.