rack-mini-profiler 0.1.23 → 0.1.28

data/Ruby/lib/html/includes.tmpl

@@ -123,6 +123,9 @@
 
 <script id="linksTemplate" type="text/x-jquery-tmpl">
   <a href="${MiniProfiler.shareUrl(Id)}" class="profiler-share-profiler-results" target="_blank">share</a>
+  {{if CustomLink}}
+  <a href="${CustomLink}" class="profiler-custom-link" target="_blank">${CustomLinkName}</a>
+  {{/if}}
   {{if HasTrivialTimings}}
   <a class="profiler-toggle-trivial" data-show-on-load="${HasAllTrivialTimings}" title="toggles any rows with &lt; ${TrivialDurationThresholdMilliseconds} ms">
     show trivial
@@ -156,12 +159,10 @@
     <td class="profiler-duration" title="aggregate duration of all queries in this step (excludes children)">
       ${MiniProfiler.formatDuration(timing.SqlTimingsDurationMilliseconds)}
     </td>
-  {{else}}
-    <td colspan='2'></td>
   {{/if}}
 
   {{each page.CustomTimingNames}}
-    {{if timing.CustomTimings[$value]}}
+    {{if timing.CustomTimings && timing.CustomTimings[$value]}}
       <td class="profiler-duration" title="aggregate number of all ${$value.toLowerCase()} invocations in this step (excludes children)">
         ${timing.CustomTimings[$value].length} ${$value.toLowerCase()}
       </td>

data/Ruby/lib/html/profile_handler.js

@@ -1 +1 @@
-<script async type="text/javascript" id="mini-profiler" src="{path}includes.js?v={version}" data-version="{version}" data-path="{path}" data-current-id="{currentId}" data-ids="{ids}" data-position="{position}" data-trivial="{showTrivial}" data-children="{showChildren}" data-max-traces="{maxTracesToShow}" data-controls="{showControls}" data-authorized="{authorized}"></script>
+<script async type="text/javascript" id="mini-profiler" src="{path}includes.js?v={version}" data-version="{version}" data-path="{path}" data-current-id="{currentId}" data-ids="{ids}" data-position="{position}" data-trivial="{showTrivial}" data-children="{showChildren}" data-max-traces="{maxTracesToShow}" data-controls="{showControls}" data-authorized="{authorized}" data-toggle-shortcut="{toggleShortcut}" data-start-hidden="{startHidden}"></script>

data/Ruby/lib/mini_profiler/config.rb

@@ -7,14 +7,15 @@ module Rack
       @attributes.concat vars
       super(*vars)
     end
-    
+
     def self.attributes
       @attributes
     end
 
     attr_accessor :auto_inject, :base_url_path, :pre_authorize_cb, :position,
-        :backtrace_remove, :backtrace_includes, :backtrace_ignores, :skip_schema_queries, 
-        :storage, :user_provider, :storage_instance, :storage_options, :skip_paths, :authorization_mode
+        :backtrace_remove, :backtrace_includes, :backtrace_ignores, :skip_schema_queries,
+        :storage, :user_provider, :storage_instance, :storage_options, :skip_paths, :authorization_mode,
+        :toggle_shortcut, :start_hidden, :backtrace_threshold_ms
 
     # Deprecated options
     attr_accessor :use_existing_jquery
@@ -23,26 +24,29 @@ module Rack
         new.instance_eval {
           @auto_inject = true # automatically inject on every html page
           @base_url_path = "/mini-profiler-resources/"
-          
+
           # called prior to rack chain, to ensure we are allowed to profile
-          @pre_authorize_cb = lambda {|env| true} 
-                                                  
+          @pre_authorize_cb = lambda {|env| true}
+
           # called after rack chain, to ensure we are REALLY allowed to profile
           @position = 'left'  # Where it is displayed
           @skip_schema_queries = false
           @storage = MiniProfiler::MemoryStore
           @user_provider = Proc.new{|env| Rack::Request.new(env).ip}
           @authorization_mode = :allow_all
+          @toggle_shortcut = 'Alt+P'
+          @start_hidden = false
+          @backtrace_threshold_ms = 0
           self
         }
       end
 
       def merge!(config)
         return unless config
-        if Hash === config 
+        if Hash === config
           config.each{|k,v| instance_variable_set "@#{k}",v}
-        else 
-          self.class.attributes.each{ |k|  
+        else
+          self.class.attributes.each{ |k|
             v = config.send k
             instance_variable_set "@#{k}", v if v
           }

data/Ruby/lib/mini_profiler/context.rb

@@ -1,10 +1,11 @@
-class Rack::MiniProfiler::Context
-  attr_accessor :inject_js,:current_timer,:page_struct,:skip_backtrace,:full_backtrace,:discard, :mpt_init
-  
-  def initialize(opts = {})
-    opts.each do |k,v|
-      self.instance_variable_set('@' + k, v)
-    end
-  end
-
-end
+class Rack::MiniProfiler::Context
+  attr_accessor :inject_js,:current_timer,:page_struct,:skip_backtrace,:full_backtrace,:discard, :mpt_init, :measure
+  
+  def initialize(opts = {})
+    opts["measure"] = true unless opts.key? "measure"
+    opts.each do |k,v|
+      self.instance_variable_set('@' + k, v)
+    end
+  end
+
+end

data/Ruby/lib/mini_profiler/flame_graph.rb

@@ -0,0 +1,54 @@
+# inspired by https://github.com/brendangregg/FlameGraph
+
+class Rack::MiniProfiler::FlameGraph
+  def initialize(stacks)
+    @stacks = stacks
+  end
+
+  def graph_data
+    height = 0
+
+    table = []
+    prev = []
+
+    # a 2d array makes collapsing easy
+    @stacks.each_with_index do |stack, pos|
+      col = []
+
+      stack.reverse.map{|r| r.to_s}.each_with_index do |frame, i|
+
+        if !prev[i].nil?
+          last_col = prev[i]
+          if last_col[0] == frame
+            last_col[1] += 1
+            col << nil
+            next
+          end
+        end
+
+        prev[i] = [frame, 1]
+        col << prev[i]
+      end
+      prev = prev[0..col.length-1].to_a
+      table << col
+    end
+
+    data = []
+
+    # a 1d array makes rendering easy
+    table.each_with_index do |col, col_num|
+      col.each_with_index do |row, row_num|
+        next unless row && row.length == 2
+        data << {
+          :x => col_num + 1,
+          :y => row_num + 1,
+          :width => row[1],
+          :frame => row[0]
+        }
+      end
+    end
+
+    data
+  end
+
+end

data/Ruby/lib/mini_profiler/gc_profiler.rb

@@ -5,10 +5,14 @@ class Rack::MiniProfiler::GCProfiler
     ids = Set.new
     i=0
     ObjectSpace.each_object { |o|
-      i = stats[o.class] || 0
-      i += 1
-      stats[o.class] = i
-      ids << o.object_id if Integer === 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

data/Ruby/lib/mini_profiler/profiler.rb

@@ -18,13 +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 << 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
@@ -79,104 +80,82 @@ module Rack
         Thread.current[:mp_authorized]
       end
 
-      # Add a custom timing. These are displayed similar to SQL/query time in
-      # columns expanding to the right.
-      #
-      # type        - String counter type. Each distinct type gets its own column.
-      # duration_ms - Duration of the call in ms. Either this or a block must be
-      #               given but not both.
-      #
-      # When a block is given, calculate the duration by yielding to the block
-      # and keeping a record of its run time.
-      #
-      # Returns the result of the block, or nil when no block is given.
-      def counter(type, duration_ms=nil)
-        result = nil
-        if block_given?
-          start = Time.now
-          result = yield
-          duration_ms = (Time.now - start).to_f * 1000
-        end
-        return result if current.nil? || !request_authorized?
-        current.current_timer.add_custom(type, duration_ms, current.page_struct)
-        result
-      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\}/, "#{env['SCRIPT_NAME']}#{@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\}/, "%.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
@@ -191,7 +170,7 @@ module Rack
     end
 
 
-		def call(env)
+    def call(env)
 
       client_settings = ClientSettings.new(env)
 
@@ -201,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
@@ -236,21 +215,16 @@ module Rack
       end
 
       if query_string =~ /pp=profile-gc/
-        # begin
-          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
-        # rescue => e
-        #   p e
-        #   e.backtrace.each do |s|
-        #     puts s
-        #   end
-        # end
+        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)
       MiniProfiler.deauthorize_request if @config.authorization_mode == :whitelist
+
       if query_string =~ /pp=normal-backtrace/
         client_settings.backtrace_level = ClientSettings::BACKTRACE_DEFAULT
       elsif query_string =~ /pp=no-backtrace/
@@ -266,31 +240,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
@@ -298,29 +267,30 @@ 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
+        env['HTTP_IF_MODIFIED_SINCE'] = ''
+        env['HTTP_IF_NONE_MATCH'] = ''
 
         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
@@ -338,44 +308,46 @@ module Rack
         body.close if body.respond_to? :close
         return help(client_settings)
       end
-      
+
       page_struct = current.page_struct
       page_struct['User'] = user(env)
-			page_struct['Root'].record_time((Time.now - start) * 1000)
+      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(page_struct['User'], page_struct['Id'])
-			@storage.save(page_struct)
-			
+      @storage.save(page_struct)
+
+      content_type = headers['Content-Type']
       # inject headers, script
-			if status == 200
+      if content_type && 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
-					
+        if current.inject_js && content_type =~ /text\/html/
           response = Rack::Response.new([], status, headers)
           script = self.get_profile_script(env)
+
           if String === body
             response.write inject(body,script)
           else
@@ -383,15 +355,15 @@ 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)
       if fragment.match(/<\/body>/i)
@@ -410,23 +382,43 @@ module Rack
         return fragment + script
       end
 
-      fragment.sub(regex) 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 + close_tag).force_encoding(fragment.encoding)
+      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 + close_tag
+
+          # 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
 
@@ -439,29 +431,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, 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
@@ -477,7 +482,7 @@ module Rack
           body << "#{name} x #{count}\n"
         end
       end
-      
+
       body << "\n\n\nRaw traces \n"
       body << fulldump
 
@@ -496,40 +501,42 @@ module Rack
       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
-			# 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].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
+    # 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 = "#{env['SCRIPT_NAME']}#{@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