rack-mini-profiler 0.1.21 → 0.1.26

data/{lib → Ruby/lib}/mini_profiler/gc_profiler.rb

@@ -3,10 +3,16 @@ class Rack::MiniProfiler::GCProfiler
   def object_space_stats
     stats = {}
     ids = Set.new
+    i=0
     ObjectSpace.each_object { |o|
-      stats[o.class] ||= 1
-      stats[o.class] += 1
-      ids << o.object_id
+      begin
+        i = stats[o.class] || 0
+        i += 1
+        stats[o.class] = i
+        ids << o.object_id if Integer === o.object_id 
+      rescue NoMethodError
+        # Redis::Future undefines .class and .object_id super weird
+      end
     }
     {:stats => stats, :ids => ids}
   end
@@ -35,24 +41,42 @@ class Rack::MiniProfiler::GCProfiler
     result
   end
 
-  def profile_gc(app,env)
-    
-    body = [];
+  def profile_gc_time(app,env)
+    body = []
 
-    stat_after = nil
-    stat_before = object_space_stats
     begin
       GC::Profiler.clear
       GC::Profiler.enable
       b = app.call(env)[2]
       b.close if b.respond_to? :close
-      stat_after = object_space_stats
+      body << "GC Profiler ran during this request, if it fired you will see the cost below:\n\n"
       body << GC::Profiler.result
     ensure
+      GC.enable
       GC::Profiler.disable
     end
 
-    diff = diff_object_stats(stat_before[:stats],stat_after[:stats])
+    return [200, {'Content-Type' => 'text/plain'}, body]
+  end
+
+  def profile_gc(app,env)
+    
+    body = [];
+
+    stat_before,stat_after,diff,string_analysis = nil
+    begin
+      GC.disable
+      stat_before = object_space_stats
+      b = app.call(env)[2]
+      b.close if b.respond_to? :close
+      stat_after = object_space_stats
+      
+      diff = diff_object_stats(stat_before[:stats],stat_after[:stats])
+      string_analysis = analyze_strings(stat_before[:ids], stat_after[:ids])
+    ensure
+      GC.enable
+    end
+
 
     body << "
 ObjectSpace delta caused by request:
@@ -69,13 +93,12 @@ ObjectSpace stats:
       body << "#{k} : #{v}\n" 
     end
 
-    r = analyze_strings(stat_before[:ids], stat_after[:ids])
 
     body << "\n
 String stats:
 ------------\n"
 
-    r.to_a.sort{|x,y| y[1] <=> x[1] }.take(1000).each do |string,count|
+    string_analysis.to_a.sort{|x,y| y[1] <=> x[1] }.take(1000).each do |string,count|
       body << "#{count} : #{string}\n"
     end
 

data/{lib → Ruby/lib}/mini_profiler/page_timer_struct.rb

@@ -7,6 +7,7 @@ module Rack
     #   Root: RequestTimer
     #     :has_many RequestTimer children
     #     :has_many SqlTimer children
+    #     :has_many CustomTimer children
     class PageTimerStruct < TimerStruct
       def initialize(env)
         super("Id" => MiniProfiler.generate_id,
@@ -27,7 +28,10 @@ module Rack
               "HasDuplicateSqlTimings" => false,
               "ExecutedReaders" => 0,
               "ExecutedScalars" => 0,
-              "ExecutedNonQueries" => 0)
+              "ExecutedNonQueries" => 0,
+              "CustomTimingNames" => [],
+              "CustomTimingStats" => {}
+             )
         name = "#{env['REQUEST_METHOD']} http://#{env['SERVER_NAME']}:#{env['SERVER_PORT']}#{env['SCRIPT_NAME']}#{env['PATH_INFO']}"
         self['Root'] = RequestTimerStruct.createRoot(name, self)
       end
@@ -43,7 +47,8 @@ module Rack
       def to_json(*a)
         attribs = @attributes.merge(
           "Started" => '/Date(%d)/' % @attributes['Started'], 
-          "DurationMilliseconds" => @attributes['Root']['DurationMilliseconds']
+          "DurationMilliseconds" => @attributes['Root']['DurationMilliseconds'],
+          "CustomTimingNames" => @attributes['CustomTimingStats'].keys.sort
         )        
         ::JSON.generate(attribs, :max_nesting => 100)
       end

data/{lib → Ruby/lib}/mini_profiler/profiler.rb

@@ -2,8 +2,10 @@ require 'json'
 require 'timeout'
 require 'thread'
 
+require 'mini_profiler/version'
 require 'mini_profiler/page_timer_struct'
 require 'mini_profiler/sql_timer_struct'
+require 'mini_profiler/custom_timer_struct'
 require 'mini_profiler/client_timer_struct'
 require 'mini_profiler/request_timer_struct'
 require 'mini_profiler/storage/abstract_store'
@@ -16,15 +18,14 @@ require 'mini_profiler/profiling_methods'
 require 'mini_profiler/context'
 require 'mini_profiler/client_settings'
 require 'mini_profiler/gc_profiler'
+require 'mini_profiler/flame_graph'
 
 module Rack
 
-	class MiniProfiler
+  class MiniProfiler
 
-		VERSION = '107'.freeze
+    class << self
 
-    class << self 
-      
       include Rack::MiniProfiler::ProfilingMethods
 
       def generate_id
@@ -44,7 +45,7 @@ module Rack
         return @share_template unless @share_template.nil?
         @share_template = ::File.read(::File.expand_path("../html/share.html", ::File.dirname(__FILE__)))
       end
-      
+
       def current
         Thread.current[:mini_profiler_private]
       end
@@ -78,82 +79,83 @@ module Rack
       def request_authorized?
         Thread.current[:mp_authorized]
       end
+
     end
 
-		#
-		# options:
-		# :auto_inject - should script be automatically injected on every html page (not xhr)
-		def initialize(app, config = nil)
+    #
+    # options:
+    # :auto_inject - should script be automatically injected on every html page (not xhr)
+    def initialize(app, config = nil)
       MiniProfiler.config.merge!(config)
-      @config = MiniProfiler.config 
-			@app = app
-			@config.base_url_path << "/" unless @config.base_url_path.end_with? "/"
+      @config = MiniProfiler.config
+      @app = app
+      @config.base_url_path << "/" unless @config.base_url_path.end_with? "/"
       unless @config.storage_instance
         @config.storage_instance = @config.storage.new(@config.storage_options)
       end
-      @storage = @config.storage_instance 
-		end
-    
+      @storage = @config.storage_instance
+    end
+
     def user(env)
       @config.user_provider.call(env)
     end
 
-		def serve_results(env)
-			request = Rack::Request.new(env)      
+    def serve_results(env)
+      request = Rack::Request.new(env)
       id = request['id']
-			page_struct = @storage.load(id)
+      page_struct = @storage.load(id)
       unless page_struct
-        @storage.set_viewed(user(env), id) 
-        return [404, {}, ["Request not found: #{request['id']} - user #{user(env)}"]] 
+        @storage.set_viewed(user(env), id)
+        return [404, {}, ["Request not found: #{request['id']} - user #{user(env)}"]]
       end
-			unless page_struct['HasUserViewed']
+      unless page_struct['HasUserViewed']
         page_struct['ClientTimings'] = ClientTimerStruct.init_from_form_data(env, page_struct)
-				page_struct['HasUserViewed'] = true
-        @storage.save(page_struct) 
-        @storage.set_viewed(user(env), id) 
-			end
+        page_struct['HasUserViewed'] = true
+        @storage.save(page_struct)
+        @storage.set_viewed(user(env), id)
+      end
 
       result_json = page_struct.to_json
       # If we're an XMLHttpRequest, serve up the contents as JSON
       if request.xhr?
-  			[200, { 'Content-Type' => 'application/json'}, [result_json]]
+        [200, { 'Content-Type' => 'application/json'}, [result_json]]
       else
 
         # Otherwise give the HTML back
-        html = MiniProfiler.share_template.dup  
-        html.gsub!(/\{path\}/, @config.base_url_path)      
-        html.gsub!(/\{version\}/, MiniProfiler::VERSION)      
+        html = MiniProfiler.share_template.dup
+        html.gsub!(/\{path\}/, @config.base_url_path)
+        html.gsub!(/\{version\}/, MiniProfiler::VERSION)
         html.gsub!(/\{json\}/, result_json)
         html.gsub!(/\{includes\}/, get_profile_script(env))
         html.gsub!(/\{name\}/, page_struct['Name'])
-        html.gsub!(/\{duration\}/, page_struct.duration_ms.round(1).to_s)
-        
+        html.gsub!(/\{duration\}/, "%.1f" % page_struct.duration_ms)
+
         [200, {'Content-Type' => 'text/html'}, [html]]
       end
 
-		end
+    end
 
-		def serve_html(env)
-			file_name = env['PATH_INFO'][(@config.base_url_path.length)..1000]
-			return serve_results(env) if file_name.eql?('results')
-			full_path = ::File.expand_path("../html/#{file_name}", ::File.dirname(__FILE__))
-			return [404, {}, ["Not found"]] unless ::File.exists? full_path
-			f = Rack::File.new nil
-			f.path = full_path
+    def serve_html(env)
+      file_name = env['PATH_INFO'][(@config.base_url_path.length)..1000]
+      return serve_results(env) if file_name.eql?('results')
+      full_path = ::File.expand_path("../html/#{file_name}", ::File.dirname(__FILE__))
+      return [404, {}, ["Not found"]] unless ::File.exists? full_path
+      f = Rack::File.new nil
+      f.path = full_path
 
-      begin 
+      begin
         f.cache_control = "max-age:86400"
         f.serving env
       rescue
-        # old versions of rack have a different api 
+        # old versions of rack have a different api
         status, headers, body = f.serving
         headers.merge! 'Cache-Control' => "max-age:86400"
         [status, headers, body]
       end
 
-		end
+    end
+
 
-    
     def current
       MiniProfiler.current
     end
@@ -168,7 +170,7 @@ module Rack
     end
 
 
-		def call(env)
+    def call(env)
 
       client_settings = ClientSettings.new(env)
 
@@ -178,20 +180,20 @@ module Rack
 
       skip_it = (@config.pre_authorize_cb && !@config.pre_authorize_cb.call(env)) ||
                 (@config.skip_paths && @config.skip_paths.any?{ |p| path[0,p.length] == p}) ||
-                query_string =~ /pp=skip/ 
-      
+                query_string =~ /pp=skip/
+
       has_profiling_cookie = client_settings.has_cookie?
-    
+
       if skip_it || (@config.authorization_mode == :whitelist && !has_profiling_cookie)
         status,headers,body = @app.call(env)
-        if !skip_it && @config.authorization_mode == :whitelist && !has_profiling_cookie && MiniProfiler.request_authorized? 
-          client_settings.write!(headers) 
+        if !skip_it && @config.authorization_mode == :whitelist && !has_profiling_cookie && MiniProfiler.request_authorized?
+          client_settings.write!(headers)
         end
         return [status,headers,body]
       end
 
       # handle all /mini-profiler requests here
-			return serve_html(env) if path.start_with? @config.base_url_path
+      return serve_html(env) if path.start_with? @config.base_url_path
 
       has_disable_cookie = client_settings.disable_profiling?
       # manual session disable / enable
@@ -208,10 +210,16 @@ module Rack
         client_settings.disable_profiling = true
         client_settings.write!(headers)
         return [status,headers,body]
+      else
+        client_settings.disable_profiling = false
       end
 
       if query_string =~ /pp=profile-gc/
-        return Rack::MiniProfiler::GCProfiler.new.profile_gc(@app, env)
+        if query_string =~ /pp=profile-gc-time/
+          return Rack::MiniProfiler::GCProfiler.new.profile_gc_time(@app, env)
+        else
+          return Rack::MiniProfiler::GCProfiler.new.profile_gc(@app, env)
+        end
       end
 
       MiniProfiler.create_current(env, @config)
@@ -231,31 +239,26 @@ module Rack
       done_sampling = false
       quit_sampler = false
       backtraces = nil
-      stacktrace_installed = true
-      if query_string =~ /pp=sample/
+      
+      if query_string =~ /pp=sample/ || query_string =~ /pp=flamegraph/
+        current.measure = false
         skip_frames = 0
         backtraces = []
         t = Thread.current
-        
-        begin 
-          require 'stacktrace'
-          skip_frames = stacktrace.length
-        rescue LoadError
-          stacktrace_installed = false
-        end
 
         Thread.new {
+          # new in Ruby 2.0
+          has_backtrace_locations = t.respond_to?(:backtrace_locations)
           begin
-            i = 10000 # for sanity never grab more than 10k samples 
+            i = 10000 # for sanity never grab more than 10k samples
             while i > 0
               break if done_sampling
               i -= 1
-              if stacktrace_installed
-                backtraces << t.stacktrace(0,-(1+skip_frames), StackFrame::Flags::METHOD | StackFrame::Flags::KLASS)
-              else
-                backtraces << t.backtrace 
-              end
-              sleep 0.001
+              backtraces << (has_backtrace_locations ? t.backtrace_locations : t.backtrace)
+              
+              # On my machine using Ruby 2.0 this give me excellent fidelity of stack trace per 1.2ms
+              #   with this fidelity analysis becomes very powerful
+              sleep 0.0005
             end
           ensure
             quit_sampler = true
@@ -263,11 +266,11 @@ module Rack
         }
       end
 
-			status, headers, body = nil
-      start = Time.now 
-      begin 
+      status, headers, body = nil
+      start = Time.now
+      begin
 
-        # Strip all the caching headers so we don't get 304s back 
+        # Strip all the caching headers so we don't get 304s back
         #  This solves a very annoying bug where rack mini profiler never shows up
         env['HTTP_IF_MODIFIED_SINCE'] = nil
         env['HTTP_IF_NONE_MATCH'] = nil
@@ -275,17 +278,18 @@ module Rack
         status,headers,body = @app.call(env)
         client_settings.write!(headers)
       ensure
-        if backtraces 
+        if backtraces
           done_sampling = true
           sleep 0.001 until quit_sampler
         end
       end
 
       skip_it = current.discard
+
       if (config.authorization_mode == :whitelist && !MiniProfiler.request_authorized?)
         # this is non-obvious, don't kill the profiling cookie on errors or short requests
         # this ensures that stuff that never reaches the rails stack does not kill profiling
-        if status == 200 && ((Time.now - start) > 0.1) 
+        if status == 200 && ((Time.now - start) > 0.1)
           client_settings.discard_cookie!(headers)
         end
         skip_it = true
@@ -303,43 +307,49 @@ module Rack
         body.close if body.respond_to? :close
         return help(client_settings)
       end
-      
+
       page_struct = current.page_struct
-			page_struct['Root'].record_time((Time.now - start) * 1000)
+      page_struct['User'] = user(env)
+      page_struct['Root'].record_time((Time.now - start) * 1000)
 
       if backtraces
         body.close if body.respond_to? :close
-        return analyze(backtraces, page_struct)
+        if query_string =~ /pp=sample/
+          return analyze(backtraces, page_struct)
+        else 
+          return flame_graph(backtraces, page_struct)
+        end
       end
-      
+
 
       # no matter what it is, it should be unviewed, otherwise we will miss POST
-      @storage.set_unviewed(user(env), page_struct['Id']) 
-			@storage.save(page_struct)
-			
+      @storage.set_unviewed(page_struct['User'], page_struct['Id'])
+      @storage.save(page_struct)
+
       # inject headers, script
-			if status == 200
+      if status == 200
 
         client_settings.write!(headers)
-        
+
         # mini profiler is meddling with stuff, we can not cache cause we will get incorrect data
         # Rack::ETag has already inserted some nonesense in the chain
         headers.delete('ETag')
         headers.delete('Date')
         headers['Cache-Control'] = 'must-revalidate, private, max-age=0'
 
-				# inject header
+        # inject header
         if headers.is_a? Hash
           headers['X-MiniProfiler-Ids'] = ids_json(env)
         end
 
-				# inject script
-				if current.inject_js \
-					&& headers.has_key?('Content-Type') \
-					&& !headers['Content-Type'].match(/text\/html/).nil? then
-					
+        # inject script
+        if current.inject_js \
+          && headers.has_key?('Content-Type') \
+          && !headers['Content-Type'].match(/text\/html/).nil? then
+
           response = Rack::Response.new([], status, headers)
           script = self.get_profile_script(env)
+
           if String === body
             response.write inject(body,script)
           else
@@ -347,34 +357,70 @@ module Rack
           end
           body.close if body.respond_to? :close
           return response.finish
-				end
-			end
+        end
+      end
 
       client_settings.write!(headers)
-			[status, headers, body]
+      [status, headers, body]
     ensure
       # Make sure this always happens
       current = nil
-		end
+    end
 
     def inject(fragment, script)
-      fragment.sub(/<\/body>/i) do 
-        # if for whatever crazy reason we dont get a utf string, 
-        #   just force the encoding, no utf in the mp scripts anyway 
-        if script.respond_to?(:encoding) && script.respond_to?(:force_encoding)
-          (script + "</body>").force_encoding(fragment.encoding)
+      if fragment.match(/<\/body>/i)
+        # explicit </body>
+
+        regex = /<\/body>/i
+        close_tag = '</body>'
+      elsif fragment.match(/<\/html>/i)
+        # implicit </body>
+
+        regex = /<\/html>/i
+        close_tag = '</html>'
+      else
+        # implicit </body> and </html>. Just append the script.
+
+        return fragment + script
+      end
+
+      matches = fragment.scan(regex).length
+      index = 1
+      fragment.gsub(regex) do
+        # though malformed there is an edge case where /body exists earlier in the html, work around
+        if index < matches 
+          index += 1
+          close_tag        
         else
-          script + "</body>"
+
+          # if for whatever crazy reason we dont get a utf string,
+          #   just force the encoding, no utf in the mp scripts anyway
+          if script.respond_to?(:encoding) && script.respond_to?(:force_encoding)
+            (script + close_tag).force_encoding(fragment.encoding)
+          else
+            script + close_tag
+          end
         end
       end
     end
 
     def dump_env(env)
       headers = {'Content-Type' => 'text/plain'}
-      body = "" 
+      body = "Rack Environment\n---------------\n"
       env.each do |k,v|
         body << "#{k}: #{v}\n"
       end
+
+      body << "\n\nEnvironment\n---------------\n"
+      ENV.each do |k,v|
+        body << "#{k}: #{v}\n"
+      end
+
+      body << "\n\nInternals\n---------------\n"
+      body << "Storage Provider #{config.storage_instance}\n"
+      body << "User #{user(env)}\n"
+      body << config.storage_instance.diagnostics(user(env)) rescue "no diagnostics implemented for storage"
+
       [200, headers, [body]]
     end
 
@@ -387,28 +433,42 @@ module Rack
   pp=skip : skip mini profiler for this request
   pp=no-backtrace #{"(*) " if client_settings.backtrace_none?}: don't collect stack traces from all the SQL executed (sticky, use pp=normal-backtrace to enable)
   pp=normal-backtrace #{"(*) " if client_settings.backtrace_default?}: collect stack traces from all the SQL executed and filter normally
-  pp=full-backtrace #{"(*) " if client_settings.backtrace_full?}: enable full backtraces for SQL executed (use pp=normal-backtrace to disable) 
-  pp=sample : sample stack traces and return a report isolating heavy usage (experimental works best with the stacktrace gem)
-  pp=disable : disable profiling for this session 
+  pp=full-backtrace #{"(*) " if client_settings.backtrace_full?}: enable full backtraces for SQL executed (use pp=normal-backtrace to disable)
+  pp=sample : sample stack traces and return a report isolating heavy usage (works best on Ruby 2.0)
+  pp=disable : disable profiling for this session
   pp=enable : enable profiling for this session (if previously disabled)
-  pp=profile-gc: perform gc profiling on this request (ruby 1.9.3 only)
+  pp=profile-gc: perform gc profiling on this request, analyzes ObjectSpace generated by request (ruby 1.9.3 only)
+  pp=profile-gc-time: perform built-in gc profiling on this request (ruby 1.9.3 only)
+  pp=flamegraph: works best on Ruby 2.0, a graph representing sampled activity.
 "
-    
+
       client_settings.write!(headers)
       [200, headers, [body]]
     end
 
+    def flame_graph(traces, page_struct)
+      graph = FlameGraph.new(traces)
+      data = graph.graph_data
+
+      headers = {'Content-Type' => 'text/html'}
+      
+      body = IO.read(::File.expand_path('../html/flamegraph.html', ::File.dirname(__FILE__)))
+      body.gsub!("/*DATA*/", ::JSON.generate(data));
+
+      [200, headers, [body]]
+    end
+
     def analyze(traces, page_struct)
       headers = {'Content-Type' => 'text/plain'}
       body = "Collected: #{traces.count} stack traces. Duration(ms): #{page_struct.duration_ms}"
 
       seen = {}
       fulldump = ""
-      traces.each do |trace| 
+      traces.each do |trace|
         fulldump << "\n\n"
         distinct = {}
         trace.each do |frame|
-          frame = "#{frame.klass}::#{frame.method}" unless String === frame
+          frame = frame.to_s unless String === frame
           unless distinct[frame]
             distinct[frame] = true
             seen[frame] ||= 0
@@ -424,7 +484,7 @@ module Rack
           body << "#{name} x #{count}\n"
         end
       end
-      
+
       body << "\n\n\nRaw traces \n"
       body << fulldump
 
@@ -437,43 +497,48 @@ module Rack
       ::JSON.generate(ids.uniq)
     end
 
-		# get_profile_script returns script to be injected inside current html page
-		# By default, profile_script is appended to the end of all html requests automatically.
-		# Calling get_profile_script cancels automatic append for the current page
-		# Use it when:
-		# * you have disabled auto append behaviour throught :auto_inject => false flag
-		# * you do not want script to be automatically appended for the current page. You can also call cancel_auto_inject
-		def get_profile_script(env)
-			ids = ids_json(env)
-			path = @config.base_url_path
-			version = MiniProfiler::VERSION
-			position = @config.position
-			showTrivial = false
-			showChildren = false
-			maxTracesToShow = 10
-			showControls = false
-			currentId = current.page_struct["Id"]
-			authorized = true
-			useExistingjQuery = @config.use_existing_jquery
-			# TODO : cache this snippet 
-			script = IO.read(::File.expand_path('../html/profile_handler.js', ::File.dirname(__FILE__)))
-			# replace the variables
-			[:ids, :path, :version, :position, :showTrivial, :showChildren, :maxTracesToShow, :showControls, :currentId, :authorized, :useExistingjQuery].each do |v|
-				regex = Regexp.new("\\{#{v.to_s}\\}")
-				script.gsub!(regex, eval(v.to_s).to_s)
-			end
-			# replace the '{{' and '}}''
-			script.gsub!(/\{\{/, '{').gsub!(/\}\}/, '}')
-			current.inject_js = false
-			script
-		end
-
-		# cancels automatic injection of profile script for the current page
-		def cancel_auto_inject(env)
-		  current.inject_js = false
-		end
-
-	end
+    def ids_comma_separated(env)
+      # cap at 10 ids, otherwise there is a chance you can blow the header
+      ids = [current.page_struct["Id"]] + (@storage.get_unviewed_ids(user(env)) || [])[0..8]
+      ids.join(",")
+    end
+
+    # get_profile_script returns script to be injected inside current html page
+    # By default, profile_script is appended to the end of all html requests automatically.
+    # Calling get_profile_script cancels automatic append for the current page
+    # Use it when:
+    # * you have disabled auto append behaviour throught :auto_inject => false flag
+    # * you do not want script to be automatically appended for the current page. You can also call cancel_auto_inject
+    def get_profile_script(env)
+      ids = ids_comma_separated(env)
+      path = @config.base_url_path
+      version = MiniProfiler::VERSION
+      position = @config.position
+      showTrivial = false
+      showChildren = false
+      maxTracesToShow = 10
+      showControls = false
+      currentId = current.page_struct["Id"]
+      authorized = true
+      toggleShortcut = @config.toggle_shortcut
+      startHidden = @config.start_hidden
+      # TODO : cache this snippet
+      script = IO.read(::File.expand_path('../html/profile_handler.js', ::File.dirname(__FILE__)))
+      # replace the variables
+      [:ids, :path, :version, :position, :showTrivial, :showChildren, :maxTracesToShow, :showControls, :currentId, :authorized, :toggleShortcut, :startHidden].each do |v|
+        regex = Regexp.new("\\{#{v.to_s}\\}")
+        script.gsub!(regex, eval(v.to_s).to_s)
+      end
+      current.inject_js = false
+      script
+    end
+
+    # cancels automatic injection of profile script for the current page
+    def cancel_auto_inject(env)
+      current.inject_js = false
+    end
+
+  end
 
 end