kamal-railsbench 0.9.9.pre

data/GCPATCH

@@ -0,0 +1,73 @@
+The garbage collector distributed with ruby tries to adapt memory
+usage to the amount of memory used by the program, dynamically growing
+or shrinking the allocated heap as it sees fit.
+
+For long running server apps this doesn't really work very well. The
+performance very much depends on the ratio heap size/program size. It
+behaves somewhat erratic: adding code can actually make your program
+run faster.
+
+The supplied patch fixes this problem: it allows one to specify the
+initial heap size to start with. Heap size will never drop below the
+initial size. By carefully selecting the initial heap size one can
+decrease startup time and increase throughput of server apps.
+
+There are 4 patches for different versions of Ruby:
+   rubygc184.patch     Ruby 1.8.4 (but will apply to 1.82 as well)
+   rubygc185.patch     Ruby 1.8.5
+   rubygc186.patch     Ruby 1.8.6
+   rubygc19.patch      Ruby 1.9
+
+Heap size and other options are controlled through environment
+variables:
+
+RUBY_HEAP_MIN_SLOTS
+    - the initial heap size in number of slots used
+
+RUBY_HEAP_SLOTS_INCREMENT
+    - how many additional slots to allocate when Ruby allocates
+      new heap slots
+
+RUBY_HEAP_SLOTS_GROWTH_FACTOR
+    - multiplicator used to increase heap block size for the next
+      allocation.
+
+RUBY_GC_MALLOC_LIMIT
+    - the amount of C data structures which can be allocated
+      without triggering a GC (if this is set too low, GC will be
+      started even if there are empty slots available)
+
+RUBY_HEAP_FREE_MIN
+    - number of free slots that should be available after GC
+      if fewer slots are available, additional heap will be allocated
+      (Ruby >= 1.8.5 ensures the freelist has at least heapsize*0.2 entries)
+
+The following values make the patched GC behave like the unpatched GC:
+
+RUBY_HEAP_MIN_SLOTS=10000
+RUBY_HEAP_SLOTS_INCREMENT=10000
+RUBY_HEAP_SLOTS_GROWTH_FACTOR=1.8
+RUBY_GC_MALLOC_LIMIT=8000000
+RUBY_HEAP_FREE_MIN=4096
+
+Try experimenting with these values. You can use perf_run_gc to find
+out how many slots you need.
+
+Memory usage of the ruby interpreter can be observed by setting
+RUBY_GC_STATS=1, before you invoke any of the railsbench commands.
+
+Per default, GC data gets written to stderr. You can change this
+behavior by setting environment variable RUBY_GC_DATA_FILE.
+
+Additionally, the Ruby module GC gets some new methods:
+
+GC.enable_stats   - enable GC statistics collection
+GC.disable_stats  - disable GC statistics collection
+GC.clear_stats    - reset GC statistics
+GC.collections    - number of collections since stats have been enabled
+GC.time           - GC time used since stats have been enabled (miro seconds)
+GC.dump           - dumps current heap topology to the GC log file
+GC.log            - log given string to the GC log file
+
+railsbench detects whether the patch has been applied and provides
+GC statistics only in this case.

data/INSTALL

@@ -0,0 +1,75 @@
+==================================================
+           RAILSBENCH INSTALLATION
+==================================================
+
+STEP 1: installing railsbench and PATH modification
+---------------------------------------------------
+
+If you obtained and installed railsbench as a gem, a script called
+railsbench is available in your Ruby bin directory. railsbench is a
+simple driver for the railsbench scripts, which are located in the gem
+installation directory. Example:
+
+    railsbench perf_run 100 -bm=all
+
+Alternatively, add the railsbench script directory to your search
+path. The exact place can be found running
+
+    railsbench base
+
+which prints the script directory path. Another option is to run
+
+    eval `railsbench path`
+
+Since gem packages don't support running postinstall scripts, you will
+need to make the scripts executable by running
+
+   sudo railsbench postinstall
+
+After performing these steps, individual commands can be run directly:
+
+    perf_run 100 -bm=all
+
+The environment variable RAILS_ROOT must be set and point to your apps
+base directory, in order for railsbench to work properly.
+
+If you obtained railsbench as a svn checkout, add the railsbench
+script directory to your search path.
+
+For bash shells you can use railsbench command completion by adding
+this line code to your .bashrc file:
+
+     complete -W "`railsbench commands`" -o default railsbench
+
+
+STEP 2: prepare your application for benchmarking
+-------------------------------------------------
+
+Manual installation:
+
+  Copy benchmarks.rb and benchmarks.yml into $RAILS_ROOT/config and
+  edit them to suit your needs. The provided default benchmark.yml
+  will run the root URL of your app.
+
+  Copy benchmarking.rb to $RAILS_ROOT/config/environments and add a
+  corresponding section to database.yml.
+
+Automatic installation:
+
+  Run 'railsbench install'. This will perform all of the above steps
+  and create a configuration named 'benchmarking' in database.yml
+  pointing to your development database. In case you are worrying
+  about possible results, you can call railsbench install --dry-run
+  first.
+
+In either case, run `railsbench generate_benchmarks'. This will create
+a benchmarks.yml file with a benchmark for each controller and action.
+
+
+STEP 3: optional (but highly recommended)
+-----------------------------------------
+
+Patch the ruby garbage collector using rubygc18{45}.patch, depending
+on your ruby version. Recompile ruby and copy the ruby binary and
+shared libs to where they were previously installed. See GCPATCH for
+details on how to influence the patched ruby gc.

data/LICENSE

@@ -0,0 +1,222 @@
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS

data/Manifest.txt

@@ -0,0 +1,53 @@
+BUGS
+CHANGELOG
+GCPATCH
+INSTALL
+LICENSE
+Manifest.txt
+PROBLEMS
+README
+Rakefile
+bin/railsbench
+config/benchmarking.rb
+config/benchmarks.rb
+config/benchmarks.yml
+images/empty.png
+images/minus.png
+images/plus.png
+install.rb
+latest_changes.txt
+lib/benchmark.rb
+lib/railsbench/benchmark.rb
+lib/railsbench/benchmark_specs.rb
+lib/railsbench/gc_info.rb
+lib/railsbench/perf_info.rb
+lib/railsbench/perf_utils.rb
+lib/railsbench/railsbenchmark.rb
+lib/railsbench/version.rb
+lib/railsbench/write_headers_only.rb
+postinstall.rb
+ruby184gc.patch
+ruby185gc.patch
+ruby186gc.patch
+ruby19gc.patch
+script/convert_raw_data_files
+script/generate_benchmarks
+script/perf_bench
+script/perf_comp
+script/perf_comp_gc
+script/perf_diff
+script/perf_diff_gc
+script/perf_html
+script/perf_plot
+script/perf_plot_gc
+script/perf_prof
+script/perf_run
+script/perf_run_gc
+script/perf_table
+script/perf_tex
+script/perf_times
+script/perf_times_gc
+script/run_urls
+setup.rb
+test/railsbench_test.rb
+test/test_helper.rb

data/PROBLEMS

@@ -0,0 +1,56 @@
+You might experience the problem described below, if your
+benchmarking.rb environment file contains the line
+
+    config.action_controller.view_controller_internals = false
+
+
+This is the preferred setting for a production mode config file, but
+can cause problems when a view template tries to access a method only
+available when view_controller_internals is true.
+
+If you experierence backtraces like the one below, try the setting
+
+    config.action_controller.view_controller_internals = true
+
+Typical backtrace:
+
+ActionView::TemplateError (undefined method `each' for nil:NilClass) on line #1 of app/views/test/param_access_t
+est.rhtml:
+1: <% for k,v in params %>
+2: <%= h k %> = <%= h v %>
+3: <% end %>
+4:
+
+    #{RAILS_ROOT}/app/views/test/param_access_test.rhtml:1:in `_run_rhtml_47app47views47test47param_access_test46rhtml'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_view/base.rb:326:in `compile_and_render_template'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_view/base.rb:301:in `render_template'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_view/base.rb:260:in `render_file'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_controller/base.rb:806:in `render_file'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_controller/base.rb:711:in `render_with_no_layout'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_controller/layout.rb:256:in `render_without_benchmark'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_controller/benchmarking.rb:50:in `render'
+    c:/ruby184/lib/ruby/gems/1.8/gems/railsbench-0.9.2/lib/benchmark.rb:300:in `measure'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_controller/benchmarking.rb:50:in `render'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_controller/base.rb:1096:in `perform_action_without_filters'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_controller/filters.rb:632:in `call_filter'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_controller/filters.rb:638:in `call_filter'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_controller/filters.rb:438:in `call'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_controller/filters.rb:637:in `call_filter'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_controller/filters.rb:634:in `call_filter'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_controller/filters.rb:619:in `perform_action_without_benchmark'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_controller/benchmarking.rb:66:in `perform_action_without_rescue'
+    c:/ruby184/lib/ruby/gems/1.8/gems/railsbench-0.9.2/lib/benchmark.rb:300:in `measure'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_controller/benchmarking.rb:66:in `perform_action_without_rescue'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_controller/rescue.rb:83:in `perform_action'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_controller/base.rb:430:in `process_without_filters'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_controller/filters.rb:624:in `process_without_session_management_support'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_controller/session_management.rb:114:in `process'
+    c:/home/skaes/svn/trunk12pre/actionpack/lib/action_controller/base.rb:330:in `process'
+    c:/home/skaes/svn/trunk12pre/railties/lib/dispatcher.rb:41:in `dispatch'
+    c:/ruby184/lib/ruby/gems/1.8/gems/railsbench-0.9.2/lib/railsbench/railsbenchmark.rb:262:in `run_urls_without_benchmark_and_without_gc_control'
+    c:/ruby184/lib/ruby/gems/1.8/gems/railsbench-0.9.2/lib/railsbench/railsbenchmark.rb:261:in `run_urls_without_benchmark_and_without_gc_control'
+    c:/ruby184/lib/ruby/gems/1.8/gems/railsbench-0.9.2/lib/railsbench/railsbenchmark.rb:259:in `run_urls_without_benchmark_and_without_gc_control'
+    c:/ruby184/lib/ruby/gems/1.8/gems/railsbench-0.9.2/lib/railsbench/railsbenchmark.rb:194:in `run_urls_without_benchmark'
+    c:/ruby184/lib/ruby/gems/1.8/gems/railsbench-0.9.2/script/run_urls:35
+    c:/ruby184/lib/ruby/gems/1.8/gems/railsbench-0.9.2/bin/railsbench:71
+    /ruby184/bin/railsbench:18