request_profiler 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a87c32c91aecffaf54d91f56d16170a083452c5d
+  data.tar.gz: 636ef8a135fe4a2a18b84cde713581055213c609
+SHA512:
+  metadata.gz: a89afe3801f9d175b08a19751293e2aa5f39630ff1bb9d36df59c1d5b7f3b8419443d9a5d08516739f57cbc6a850833041ccd144d910f958bc4be9962fc79ba3
+  data.tar.gz: 4626155ead14c5f1f66bc301ee57a38e11948ab89382cd457f160d5a919076d4969cfef906a158c5b0e7300443e15179bd8d758f517511fae38ee0113c66ee56

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    request_profiler (0.0.1)
+    request_profiler (0.0.3)
       ruby-prof
 
 GEM
@@ -13,7 +13,7 @@ GEM
     rack-test (0.5.6)
       rack (>= 1.0)
     rake (0.8.7)
-    ruby-prof (0.9.2)
+    ruby-prof (0.13.0)
     sinatra (1.1.0)
       rack (~> 1.1)
       tilt (~> 1.1)
@@ -26,5 +26,4 @@ DEPENDENCIES
   mocha
   rack-test
   request_profiler!
-  ruby-prof
   sinatra

data/README.rdoc

@@ -1,3 +1,58 @@
 = Request Profiler
 
-- A Rack middleware wrapper for ruby-prof
++request_profiler+ is a rack middleware that allows you to profile
+rack requests using {ruby-prof}[https://github.com/rdp/ruby-prof]. It
+sits out of the way until it's triggered using a specific request
+parameter. Once triggered, it will profile the request and dump a log
+file.
+
+== Setup
+
+After the gem is installed, it's used in the same way any rack
+middleware is set up. In Rails, you'd probably want to do something
+like this:
+
+  config.middleware.use "Rack::RequestProfiler"
+
++request_profiler+ takes a few optional parameters:
+
+:printer:: the <tt>ruby-prof</tt> printer to use. Defaults to
+           <tt>RubyProf::GraphPrinter</tt>.
+           
+:exclude:: a list of regexes (like <tt>[/Integer#times]</tt>) that
+           will not appear in the profile log. This is most commonly
+           used for methods that take a block, where you don't care
+           how much time was spent in the method itself.
+
+:path:: the path to write the log files to. If +request_profiler+ is
+        running under Rails, this defaults to
+        <tt>Rails.root/tmp/performance</tt>, otherwise it defaults to
+        <tt>$TMPDIR/performance</tt>.
+ 
+== Using +request_profiler+
+
+When you get to the point where you'd like to profile a request, you
+just add <tt>profile_request=true</tt> to the end of your request's query
+string. By default, this will use the <tt>RubyProf::PROCESS_TIME</tt>
+profiler. If you'd like to use a different profiler, you can specify
+the profiler class instead of +true+ in the query string. For example,
+
+  profile_request=memory
+
+will use the <tt>RubyProf::MEMORY</tt> profiler. Note that the
+profilers other than +PROCESS_TIME+ and +WALL_TIME+ require a patched
+ruby interpreter, as mentioned in the ruby-prof documentation. REE
+should work out of the box, but as far as I know, these patches don't
+yet exist for ruby 1.9.
+
+== Bugs Under Ruby 1.9.2
+
++ruby_prof+ uses a ruby method called +set_trace_func+, which tends to
+crash under ruby 1.9.2. I have an experimental patch which backports
+the fix in the 1.9.3 branch to 1.9.2, and adjusts the stack depth
+threshhold ruby uses, which fixes some other interpreter crashes I was
+seeing. If you run into similar issues, you should grab the patch
+located under +patches/set_trace_func_fix192.patch+. With
+{rvm}[http://rvm.beginrescueend.com/], it's as simple as
+
+  rvm install 1.9.2p0 --patch /path/to/set_trace_func_fix192.patch

data/lib/rack/request_profiler.rb

@@ -9,14 +9,14 @@ module Rack
 
       @path = options[:path]
       @path ||= Rails.root + 'tmp/performance' if defined?(Rails)
-      @path ||= ::File.join(ENV["TMPDIR"] + 'performance')
+      @path ||= ::File.join((ENV["TMPDIR"] || "/tmp"), 'performance')
       @path = Pathname(@path)
     end
 
     def call(env)
       request = Rack::Request.new(env)
       mode = profile_mode(request)
-      
+
       if mode
         ::RubyProf.measure_mode = mode
         ::RubyProf.start
@@ -27,14 +27,14 @@ module Rack
         result = ::RubyProf.stop
         write_result(result, request)
       end
-      
+
       [status, headers, body]
     end
 
     def profile_mode(request)
       mode_string = request.params["profile_request"]
       if mode_string
-        if mode_string.downcase == "true"
+        if mode_string.downcase == "true" or mode_string == "1"
           ::RubyProf::PROCESS_TIME
         else
           ::RubyProf.const_get(mode_string.upcase)
@@ -63,12 +63,21 @@ module Rack
       end
     end
 
+    def prefix(printer)
+      case printer
+      when ::RubyProf::CallTreePrinter
+        "callgrind."
+      else
+        ""
+      end
+    end
+
     def write_result(result, request)
       result.eliminate_methods!(@exclusions) if @exclusions
       printer = @printer.new(result)
       Dir.mkdir(@path) unless ::File.exists?(@path)
       url = request.fullpath.gsub(/[?\/]/, '-')
-      filename = "#{Time.now.strftime('%Y-%m-%d-%H-%M-%S')}-#{url}.#{format(printer)}"
+      filename = "#{prefix(printer)}#{Time.now.strftime('%Y-%m-%d-%H-%M-%S')}-#{url.slice(0, 50)}.#{format(printer)}"
       ::File.open(@path + filename, 'w+') do |f|
         printer.print(f)
       end

data/lib/request_profiler/version.rb

@@ -1,3 +1,3 @@
 module RequestProfiler
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,84 +1,79 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: request_profiler
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+version: !ruby/object:Gem::Version
+  version: 0.0.3
 platform: ruby
-authors: 
+authors:
 - Justin Weiss
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-12-16 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: ruby-prof
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rack-test
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: sinatra
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: mocha
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-description: Request Profiler is a Rack middleware that allows optionally profiling requests with ruby-prof.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Request Profiler is a Rack middleware that allows optionally profiling
+  requests with ruby-prof.
+email:
 - justin@uberweiss.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
@@ -92,39 +87,30 @@ files:
 - test/fake_app.rb
 - test/request_profiler_test.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: https://github.com/justinweiss/request_profiler
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: request_profiler
-rubygems_version: 1.3.7
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Profile Rack requests with ruby-prof
-test_files: 
+test_files:
 - test/fake_app.rb
 - test/request_profiler_test.rb
 - test/test_helper.rb