kotovalexarian-likes-github/rails--rails
1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Code Releases Activity

revised titles in performance guide

Browse source
This commit is contained in:
Xavier Noria 2009-03-14 22:10:11 +01:00
parent b0caa62cbf
commit abe921f81f
1 changed files with 22 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
railties/guides/source/performance_testing.textile
View file

@ -32,7 +32,7 @@ end
This example is a simple performance test case for profiling a GET request to the application's homepage. This example is a simple performance test case for profiling a GET request to the application's homepage.
h4. Generating performance tests h4. Generating Performance Tests
Rails provides a generator called +performance_test+ for creating new performance tests: Rails provides a generator called +performance_test+ for creating new performance tests:
@ -95,7 +95,7 @@ class Post < ActiveRecord::Base
end end
</ruby> </ruby>
h5. Controller example h5. Controller Example
Because performance tests are a special kind of integration test, you can use the +get+ and +post+ methods in them. Because performance tests are a special kind of integration test, you can use the +get+ and +post+ methods in them.
@ -123,7 +123,7 @@ end
You can find more details about the +get+ and +post+ methods in the "Testing Rails Applications":testing.html guide. You can find more details about the +get+ and +post+ methods in the "Testing Rails Applications":testing.html guide.
h5. Model example h5. Model Example
Even though the performance tests are integration tests and hence closer to the request/response cycle by nature, you can still performance test pure model code. Even though the performance tests are integration tests and hence closer to the request/response cycle by nature, you can still performance test pure model code.
@ -173,13 +173,13 @@ h4. Metrics
Benchmarking and profiling run performance tests in various modes described below. Benchmarking and profiling run performance tests in various modes described below.
h5. Wall time h5. Wall Time
Wall time measures the real world time elapsed during the test run. It is affected by any other processes concurrently running on the system. Wall time measures the real world time elapsed during the test run. It is affected by any other processes concurrently running on the system.
Mode: Benchmarking Mode: Benchmarking
h5. Process time h5. Process Time
Process time measures the time taken by the process. It is unaffected by any other processes running concurrently on the same system. Hence, process time is likely to be constant for any given performance test, irrespective of the machine load. Process time measures the time taken by the process. It is unaffected by any other processes running concurrently on the same system. Hence, process time is likely to be constant for any given performance test, irrespective of the machine load.
@ -197,19 +197,19 @@ Objects measures the number of objects allocated for the performance test case.
Mode: Benchmarking, Profiling "Requires GC Patched Ruby":#installing-gc-patched-ruby Mode: Benchmarking, Profiling "Requires GC Patched Ruby":#installing-gc-patched-ruby
h5. GC runs h5. GC Runs
GC Runs measures the number of times GC was invoked for the performance test case. GC Runs measures the number of times GC was invoked for the performance test case.
Mode: Benchmarking "Requires GC Patched Ruby":#installing-gc-patched-ruby Mode: Benchmarking "Requires GC Patched Ruby":#installing-gc-patched-ruby
h5. GC time h5. GC Time
GC Time measures the amount of time spent in GC for the performance test case. GC Time measures the amount of time spent in GC for the performance test case.
Mode: Benchmarking "Requires GC Patched Ruby":#installing-gc-patched-ruby Mode: Benchmarking "Requires GC Patched Ruby":#installing-gc-patched-ruby
h4. Understanding the output h4. Understanding the Output
Performance tests generate different outputs inside +tmp/performance+ directory depending on their mode and metric. Performance tests generate different outputs inside +tmp/performance+ directory depending on their mode and metric.
@ -217,7 +217,7 @@ h5. Benchmarking
In benchmarking mode, performance tests generate two types of outputs: In benchmarking mode, performance tests generate two types of outputs:
h6. Command line h6. Command Line
This is the primary form of output in benchmarking mode. Example: This is the primary form of output in benchmarking mode. Example:
@ -230,7 +230,7 @@ BrowsingTest#test_homepage (31 ms warmup)
gc_time: 19 ms gc_time: 19 ms
</shell> </shell>
h6. CSV files h6. CSV Files
Performance test results are also appended to +.csv+ files inside +tmp/performance+. For example, running the default +BrowsingTest#test_homepage+ will generate following five files: Performance test results are also appended to +.csv+ files inside +tmp/performance+. For example, running the default +BrowsingTest#test_homepage+ will generate following five files:
@ -262,7 +262,7 @@ h5. Profiling
In profiling mode, you can choose from four types of output. In profiling mode, you can choose from four types of output.
h6. Command line h6. Command Line
This is a very basic form of output in profiling mode: This is a very basic form of output in profiling mode:
@ -285,13 +285,13 @@ h6. Tree
Tree output is profiling information in calltree format for use by "kcachegrind":http://kcachegrind.sourceforge.net/html/Home.html and similar tools. Tree output is profiling information in calltree format for use by "kcachegrind":http://kcachegrind.sourceforge.net/html/Home.html and similar tools.
h4. Tuning test runs h4. Tuning Test Runs
By default, each performance test is run +4 times+ in benchmarking mode and +1 time+ in profiling. However, test runs can easily be configured. By default, each performance test is run +4 times+ in benchmarking mode and +1 time+ in profiling. However, test runs can easily be configured.
WARNING: Performance test configurability is not yet enabled in Rails. But it will be soon. WARNING: Performance test configurability is not yet enabled in Rails. But it will be soon.
h4. Performance test environment h4. Performance Test Environment
Performance tests are run in the +development+ environment. But running performance tests will set the following configuration parameters: Performance tests are run in the +development+ environment. But running performance tests will set the following configuration parameters:
@ -303,7 +303,7 @@ Rails.logger.level = ActiveSupport::BufferedLogger::INFO
As +ActionController::Base.perform_caching+ is set to +true+, performance tests will behave much as they do in the +production+ environment. As +ActionController::Base.perform_caching+ is set to +true+, performance tests will behave much as they do in the +production+ environment.
h4. Installing GC-patched Ruby h4. Installing GC-Patched Ruby
To get the best from Rails performance tests, you need to build a special Ruby binary with some super powers - "GC patch":http://rubyforge.org/tracker/download.php/1814/7062/17676/3291/ruby186gc.patch for measuring GC Runs/Time and memory/object allocation. To get the best from Rails performance tests, you need to build a special Ruby binary with some super powers - "GC patch":http://rubyforge.org/tracker/download.php/1814/7062/17676/3291/ruby186gc.patch for measuring GC Runs/Time and memory/object allocation.
@ -313,7 +313,7 @@ h5. Installation
Compile Ruby and apply this "GC Patch":http://rubyforge.org/tracker/download.php/1814/7062/17676/3291/ruby186gc.patch. Compile Ruby and apply this "GC Patch":http://rubyforge.org/tracker/download.php/1814/7062/17676/3291/ruby186gc.patch.
h5. Download and extract h5. Download and Extract
<shell> <shell>
[lifo@null ~]$ mkdir rubygc [lifo@null ~]$ mkdir rubygc
@ -322,13 +322,13 @@ h5. Download and extract
[lifo@null ~]$ cd <ruby-version> [lifo@null ~]$ cd <ruby-version>
</shell> </shell>
h5. Apply the patch h5. Apply the Patch
<shell> <shell>
[lifo@null ruby-version]$ curl http://rubyforge.org/tracker/download.php/1814/7062/17676/3291/ruby186gc.patch | patch -p0 [lifo@null ruby-version]$ curl http://rubyforge.org/tracker/download.php/1814/7062/17676/3291/ruby186gc.patch | patch -p0
</shell> </shell>
h5. Configure and install h5. Configure and Install
The following will install ruby in your home directory's +/rubygc+ directory. Make sure to replace +<homedir>+ with a full patch to your actual home directory. The following will install ruby in your home directory's +/rubygc+ directory. Make sure to replace +<homedir>+ with a full patch to your actual home directory.
@ -337,7 +337,7 @@ The following will install ruby in your home directory's +/rubygc+ directory. Ma
[lifo@null ruby-version]$ make && make install [lifo@null ruby-version]$ make && make install
</shell> </shell>
h5. Prepare aliases h5. Prepare Aliases
For convenience, add the following lines in your +~/.profile+: For convenience, add the following lines in your +~/.profile+:
@ -349,7 +349,7 @@ alias gcirb='~/rubygc/bin/irb'
alias gcrails='~/rubygc/bin/rails' alias gcrails='~/rubygc/bin/rails'
</shell> </shell>
h5. Install Rubygems and dependency gems h5. Install Rubygems and Dependency Gems
Download "Rubygems":http://rubyforge.org/projects/rubygems and install it from source. Rubygem's README file should have necessary installation instructions. Download "Rubygems":http://rubyforge.org/projects/rubygems and install it from source. Rubygem's README file should have necessary installation instructions.
@ -496,21 +496,21 @@ Michael Koziarski has an "interesting blog post":http://www.therailsway.com/2009
h3. Useful Links h3. Useful Links
h4. Rails plugins and gems h4. Rails Plugins and Gems
* "Rails Analyzer":http://rails-analyzer.rubyforge.org * "Rails Analyzer":http://rails-analyzer.rubyforge.org
* "Palmist":http://www.flyingmachinestudios.com/projects * "Palmist":http://www.flyingmachinestudios.com/projects
* "Rails Footnotes":http://github.com/josevalim/rails-footnotes/tree/master * "Rails Footnotes":http://github.com/josevalim/rails-footnotes/tree/master
* "Query Reviewer":http://github.com/dsboulder/query_reviewer/tree/master * "Query Reviewer":http://github.com/dsboulder/query_reviewer/tree/master
h4. Generic tools h4. Generic Tools
* "httperf":http://www.hpl.hp.com/research/linux/httperf * "httperf":http://www.hpl.hp.com/research/linux/httperf
* "ab":http://httpd.apache.org/docs/2.2/programs/ab.html * "ab":http://httpd.apache.org/docs/2.2/programs/ab.html
* "JMeter":http://jakarta.apache.org/jmeter * "JMeter":http://jakarta.apache.org/jmeter
* "kcachegrind":http://kcachegrind.sourceforge.net/html/Home.html * "kcachegrind":http://kcachegrind.sourceforge.net/html/Home.html
h4. Tutorials and documentation h4. Tutorials and Documentation
* "ruby-prof API Documentation":http://ruby-prof.rubyforge.org * "ruby-prof API Documentation":http://ruby-prof.rubyforge.org
* "Request Profiling Railscast":http://railscasts.com/episodes/98-request-profiling - Outdated, but useful for understanding call graphs * "Request Profiling Railscast":http://railscasts.com/episodes/98-request-profiling - Outdated, but useful for understanding call graphs