rack-perftools_profiler 0.1.1 → 0.2.0

data/README.rdoc

@@ -55,7 +55,7 @@ For Rack::Builder, call 'use' inside the Builder constructor block
 == Options
 
 * :default_printer - can be set to 'text', 'gif', or 'pdf'. Default is :text
-* :mode            - can be set to 'cputime' or 'walltime'. Default is :cputime
+* :mode            - can be set to 'cputime', 'objects', 'walltime'. Default is :cputime. See the 'Profiling Modes' section below.
 * :frequency       - in :cputime mode, the number of times per second the app will be sampled. Default is 100 (times/sec)
 * :bundler         - run the profiler binary using 'bundle' if set to true. Default is false
 * :gemfile_dir     - directory with Gemfile. Default is the current directory.
@@ -99,6 +99,47 @@ start/stop mode, they are added to the \_\_data\_\_ URL
 (for 'ignore' and 'focus', please see http://google-perftools.googlecode.com/svn/trunk/doc/cpuprofile.html#pprof
 for more details)
 
+== Profiling Modes
+
+perftools.rb can be put into three different profiling modes.
+
+* CPU time mode            - Reports how many CPU cycles are spent in each section of code. This is the default and can be enabled by setting ':mode => :cputime'
+* Wall time mode           - Reports the amount of time (as in, wall clock time) spent in each section of code. Enable by setting ':mode => :walltime'
+* Object allocation mode   - Reports the percentage of object allocations performed in each section of code. Enable by setting ':mode => :objects'
+
+For example, consider the following Sinatra application:
+
+  require 'sinatra'
+  require 'rack/perftools_profiler'
+
+  configure do
+    use Rack::PerftoolsProfiler, :default_printer => 'gif', :mode => :cputime
+  end
+
+  get "/slow" do
+    sleep(3)
+    "hello"
+  end
+
+In the default mode, there will be no profiling data for the 'slow' route, because it uses few CPU cycles (You'll see the message 'No nodes to print').
+
+If you change the mode to ':walltime', you'll get profiling data, since the call to 'sleep' causes the code to spend several seconds of wall time in the block.
+
+== Changing behavior with environment variables
+
+The mode and frequency settings are enabled by setting environment variables. Some of these environment variables must be set before 'perftools' is required. If you only require 'rack/perftools_profiler', it will do the right thing (require 'perftools' after setting the environment variables).
+
+If you need to require 'perftools' before 'rack/perftools_profiler' (or you have other problems changing the mode or frequency), try using these environment variables yourself.
+
+Setting the frequency:
+  CPUPROFILE_FREQUENCY=500 ruby your_app.rb
+
+Setting the mode to 'wall time'
+  CPUPROFILE_REALTIME=1 ruby your_app.rb
+
+Setting the mode to 'object allocation'
+  CPUPROFILE_OBJECTS=1 ruby your_app.rb
+
 == Acknowledgments
 
 A huge thanks to Aman Gupta for the awesome perftools.rb gem.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/rack/perftools_profiler/profiler.rb

@@ -23,7 +23,7 @@ module Rack::PerftoolsProfiler
     PROFILING_SETTINGS_FILE = ::File.join(self.tmpdir, 'rack_perftools_profiler.config')
     DEFAULT_PRINTER = :text
     DEFAULT_MODE = :cputime
-    UNSET_FREQUENCY = -1
+    UNSET_FREQUENCY = "-1"
     DEFAULT_GEMFILE_DIR = '.'
 
     def initialize(app, options)
@@ -33,6 +33,9 @@ module Rack::PerftoolsProfiler
       @bundler     = (options.delete(:bundler) { false })
       @gemfile_dir = (options.delete(:gemfile_dir) { DEFAULT_GEMFILE_DIR })
       ProfileDataAction.check_printer(@printer)
+      # We need to set the enviroment variables before loading perftools
+      set_env_vars
+      require 'perftools'
       raise ProfilerArgumentError, "Invalid option(s): #{options.keys.join(' ')}" unless options.empty?
     end
     
@@ -48,7 +51,6 @@ module Rack::PerftoolsProfiler
     end
     
     def start
-      set_env_vars
       PerfTools::CpuProfiler.stop
       PerfTools::CpuProfiler.start(PROFILING_DATA_FILE)
       self.profiling = true
@@ -105,12 +107,15 @@ module Rack::PerftoolsProfiler
 
     def set_env_vars
       ENV['CPUPROFILE_REALTIME'] = '1' if @mode == :walltime
+      ENV['CPUPROFILE_OBJECTS'] = '1' if @mode == :objects
       ENV['CPUPROFILE_FREQUENCY'] = @frequency if @frequency != UNSET_FREQUENCY
     end
 
+    # Useful for testing
     def unset_env_vars
       ENV.delete('CPUPROFILE_REALTIME')
       ENV.delete('CPUPROFILE_FREQUENCY')
+      ENV.delete('CPUPROFILE_OBJECTS')
     end
     
     def profiling=(value)

data/lib/rack/perftools_profiler.rb

@@ -1,5 +1,4 @@
 require 'rack'
-require 'perftools'
 require 'pstore'
 require 'open4'
 

data/test/rack-perftools-profiler_test.rb

@@ -159,6 +159,28 @@ class RackPerftoolsProfilerTest < Test::Unit::TestCase
         assert_equal '1', realtime
       end
 
+      should "set CPUPROFILE_OBJECTS to 1 if mode is 'objects'" do
+        realtime = ENV['CPUPROFILE_OBJECTS']
+        assert_nil realtime
+        app = lambda do |env|
+          realtime = ENV['CPUPROFILE_OBJECTS']
+          [200, {}, ["hi"]]
+        end
+        Rack::PerftoolsProfiler.new(app, :mode => 'objects').call(@profiled_request_env)
+        assert_equal '1', realtime
+      end
+
+      should "not set CPUPROFILE_FREQUENCY by default" do
+        frequency = ENV['CPUPROFILE_FREQUENCY']
+        assert_nil frequency
+        app = lambda do |env|
+          frequency = ENV['CPUPROFILE_FREQUENCY']
+          [200, {}, ["hi"]]
+        end
+        Rack::PerftoolsProfiler.new(app).call(@profiled_request_env)
+        assert_nil frequency
+      end
+
       should 'alter CPUPROFILE_FREQUENCY if frequency is set' do
         frequency = ENV['CPUPROFILE_FREQUENCY']
         assert_nil frequency

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ben Brinckerhoff
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-11 00:00:00 -06:00
+date: 2010-11-09 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency