dev_essential1Add my vote for this tag development1Add my vote for this tag performance1Add my vote for this tag plugin1Add my vote for this tag create new tag
, view all tags

Plugin Benchmark Add-On

This is a small script to measure the performance of a Plugin. Plugin authors can use it to measure and document the TWiki:Plugins/Benchmark numbers.


  • Specify Plugin name and other topics to benchmark. The first parameter is the Plugin name, followed by topic names. The TWiki web is assumed unless specified.


  • Before running the benchmarks, disable mod_perl or SpeedyCGI in case used
  • Run the script on the web server's shell where TWiki is installed
  • Measure when there is no load on the server
  • All Plugins are automatically disabled except for the DefaultPlugin and the specified Plugin. The 'default' TWiki skin is enabled.

Running the script:

  • Choose a topic that renders your plugin variables. That may be the plugin topic, or an example topic.
  • Go to your bin directory and call (for instance):
  • % ./pluginbenchmark TablePlugin GoodStyle FormattedSearch Main.TWikiUsers

Example output

% ./pluginbenchmark SpreadSheetPlugin FormattedSearch GoodStyle
TWiki Plugin benchmark tool. Time::HiRes is used.
Measuring, please be patient...
Topic:                          Without:  With:     Percent:
------------------------------  --------  --------  --------
TWiki.SpreadSheetPlugin            0.481     0.506       95%
TWiki.FormattedSearch              1.677     1.694       99%
TWiki.GoodStyle                    0.301     0.304       99%

Add-On Installation Instructions

Instructions for TWiki plugin authors:

  • Download the ZIP file from the Add-on Home (see below)
  • Unzip PluginBenchmarkAddOn.zip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/PluginBenchmarkAddOn.txt Add-on topic
    data/TWiki/PluginBenchmarkAddOn.txt,v Plugin topic repository
    bin/pluginbenchmark Benchmark utility script
  • Install CPAN:Time::HiRes if needed:
    • Run the pluginbenchmark utility from the shell without parameters, it will tell you if Time::HiRes is installed or not.
    • It is strongly recommended to run the utility only with Time::HiRes installed (it will work without the module, but it is very slow and the result is not accurate)
  • Test if the installation was successful:
    • Run the pluginbenchmark utility from your bin directory:
      % ./pluginbenchmark TablePlugin GoodStyle

Add-On Info

  • Set SHORTDESCRIPTION = Measure the performance of a TWiki plugin

Add-on Author: TWiki:Main.PeterThoeny
Copyright: © 2006, TWiki:Main.PeterThoeny
License: GPL (GNU General Public License)
Add-on Version: 25 Oct 2008 (v1.030)
Change History:  
26 Oct 2008: v.1.030 Arthur Clemens: Now uses default skin instead of classic.
25 Oct 2008: v.1.021 Arthur Clemens: Changed hardcoded paths to variables read from lib/LocalSite.cfg. Changed call from geturl to geturl.pl. Updated documentation.
11 Nov 2004: Better accuracy, more flexible configuration
10 Nov 2004: Initial version
TWiki Dependency: $TWiki::Plugins::VERSION 1.1 (TWiki 4.0)
CPAN Dependencies: Time::HiRes
Other Dependencies: TWiki's geturl.pl utility
Perl Version: 5.005
Add-on Home: http://TWiki.org/cgi-bin/view/Plugins/PluginBenchmarkAddOn
Feedback: http://TWiki.org/cgi-bin/view/Plugins/PluginBenchmarkAddOnDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/PluginBenchmarkAddOnAppraisal

Related Topic: TWikiAddOns

Topic attachments
I Attachment History Action Size Date Who Comment
Unknown file formatmd5 PluginBenchmarkAddOn.md5 r4 r3 r2 r1 manage 0.2 K 2008-10-26 - 13:14 ArthurClemens  
Compressed Zip archivetgz PluginBenchmarkAddOn.tgz r4 r3 r2 r1 manage 4.9 K 2008-10-26 - 13:13 ArthurClemens  
Compressed Zip archivezip PluginBenchmarkAddOn.zip r6 r5 r4 r3 r2 manage 6.4 K 2008-10-26 - 13:13 ArthurClemens  
Unknown file formatEXT PluginBenchmarkAddOn_installer r2 r1 manage 3.5 K 2008-10-26 - 13:13 ArthurClemens  
Edit | Attach | Watch | Print version | History: r10 < r9 < r8 < r7 < r6 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r10 - 2008-10-26 - ArthurClemens
  • 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-2015 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.