rack-mini-profiler 0.1.31 → 0.9.3

data/Ruby/CHANGELOG

@@ -1,161 +0,0 @@
-28-June-2012 - Sam
-
-  * Started change log
-  * Corrected profiler so it properly captures POST requests (was supressing non 200s)
-  * Amended Rack.MiniProfiler.config[:user_provider] to use ip addres for identity
-  * Fixed bug where unviewed missing ids never got cleared
-  * Supress all '/assets/' in the rails tie (makes debugging easier)
-  * record_sql was mega buggy
-  * added MemcacheStore
-
-9-July-2012 - Sam
-
-  * Cleaned up mechanism for profiling in production, all you need to do now
-  is call Rack::MiniProfiler.authorize_request to get profiling working in
-  production
-  * Added option to display full backtraces pp=full-backtrace
-  * Cleaned up railties, got rid of the post authorize callback
-  * Version 0.1.3
-
-12-July-2012 - Sam
-
-  * Fixed incorrect profiling steps (was not indenting or measuring start time right
-  * Implemented native PG and MySql2 interceptors, this gives way more accurate times
-  * Refactored context so its a proper class and not a hash
-  * Added some more client probing built in to rails
-  * More tests
-
-18-July-2012 - Sam
-
-  * Added First Paint time for chrome
-  * Bug fix to ensure non Rails installs have mini profiler
-  * Version 0.1.7
-
-30-July-2012 - Sam
-
-  * Made compliant with ancient versions of Rack (including Rack used by Rails2)
-  * Fixed broken share link
-  * Fixed crashes on startup (in MemoryStore and FileStore)
-  * Version 0.1.8
-  * Unicode fix
-  * Version 0.1.9
-
-7-August-2012 - Sam
-
-  * Added option to disable profiler for the current session (pp=disable / pp=enable)
-  * yajl compatability contributed by Sven Riedel
-
-10-August-2012 - Sam
-
-  * Added basic prepared statement profiling for postgres
-
-20-August-2012 - Sam
-
-  * 1.12.pre
-  * Cap X-MiniProfiler-Ids at 10, otherwise the header can get killed
-
-3-September-2012 - Sam
-
-  * 1.13.pre
-  * pg gem prepared statements were not being logged correctly
-  * added setting config.backtrace_ignores = [] - an array of regexes that match on caller lines that get ignored
-  * added setting config.backtrace_includes = [] - an array of regexes that get included in the trace by default
-  * cleaned up the way client settings are stored
-  * made pp=full-backtrace "sticky"
-  * added pp=normal-backtrace to clear the "sticky" state
-  * change "pp=sample" to work with "caller" no need for stack trace gem
-
-4-September-2012 - Sam
-
-  * 1.15.pre
-  * fixed annoying bug where client settings were not sticking
-  * fixed long standing issue with Rack::ConditionalGet stopping MiniProfiler from working properly
-
-5-September-2012 - Sam
-
-  * 1.16
-  * fixed long standing problem specs (issue with memory store)
-  * fixed issue where profiler would be dumped when you got a 404 in production (and any time rails is bypassed)
-  * implemented stacktrace properly
-
-9-September-2012 - Sam
-
-  * 1.17
-  * pp=sample was bust unless stacktrace was installed
-
-10-September-2012 - Sam
-
-  * 1.19
-  * fix compat issue with 1.8.7
-
-12-September-2012 - Sam
-
-  * 1.20
-  * Added pp=profile-gc , it allows you to profile the GC in Ruby 1.9.3
-
-17-September-2012
-  * 1.21
-  * New MemchacedStore
-  * Rails 4 support
-
-17-September-2012
-  * Allow rack-mini-profiler to be sourced from github
-  * Extracted the pp=profile-gc-time out, the object space profiler needs to disable gc
-
-20-September-2012
-  * 1.22
-  * Fix permission issue in the gem
-
-8-April-2013
-  * 1.24
-  * Flame Graph Support see: http://samsaffron.com/archive/2013/03/19/flame-graphs-in-ruby-miniprofiler
-  * Fix file retention leak in file_store
-  * New toggle_shortcut and start_hidden options
-  * Fix for AngularJS support and MooTools
-  * More robust gc profiling
-  * Mongoid support
-  * Fix for html5 implicit body tags
-  * script tag initialized via data-attributes
-  * new - Rack::MiniProfiler.counter counter_name {}
-  * Allow usage of existing jQuery if its already loaded
-  * Fix pp=enable
-  * 1.8.7 support ... grrr
-  * Net:HTTP profiling
-  * pre authorize to run in all non development? and production? modes
-
-8-April-2013
-  * 1.25
-  * Missed flamegraph.html from build
-
-11-April-2013
-  * 1.26
-  * (minor) allow Rack::MiniProfilerRails.initialize!(Rails.application), for post config intialization
-
-26-June-2013
-  * 1.27
-  * Disable global ajax handlers on MP requests @JP
-  * Add Rack::MiniProfiler.config.backtrace_threshold_ms
-  * jQuery 2.0 support
-
-18-July-2013
-  * 1.28
-	* diagnostics in abstract storage was raising not implemented killing
-	?pp=env and others
-  * SOLR xml unescaped by mistake
-
-20-August-2013
-  * 1.29
-  * Bugfix: SOLR patching had an incorrect monkey patch
-  * Implemented exception tracing using TracePoint see pp=trace-exceptions
-
-30-August-2013
-
-  * 1.30
-  * Feature: Added Rack::MiniProfiler.counter_method(klass,name) for injecting counters
-  * Bug: Counters were not shifting the table correctly
-
-3-September-2013
-
-  * Ripped out flamegraph so it can be isolated into a gem
-  * Flamegraph now has much increased fidelity
-  * Ripped out pp=sample it just was never really used

data/Ruby/README.md

@@ -1,172 +0,0 @@
-# rack-mini-profiler
-
-Middleware that displays speed badge for every html page. Designed to work both in production and in development.
-
-## Using rack-mini-profiler in your app
-
-Install/add to Gemfile
-
-```ruby
-gem 'rack-mini-profiler'
-```
-Using Rails:
-
-All you have to do is include the Gem and you're good to go in development.
-
-rack-mini-profiler is designed with production profiling in mind. To enable that just run `Rack::MiniProfiler.authorize_request` once you know a request is allowed to profile.
-
-Using Rails:
-
-```ruby
-# A hook in your ApplicationController
-def authorize
-  if current_user.is_admin? 
-    Rack::MiniProfiler.authorize_request
-  end
-end
-````
-
-
-Using Builder:
-
-```ruby
-require 'rack-mini-profiler'
-builder = Rack::Builder.new do
-  use Rack::MiniProfiler
-
-  map('/')    { run get }
-end
-```
-
-Using Sinatra:
-
-```ruby
-require 'rack-mini-profiler'
-class MyApp < Sinatra::Base
-  use Rack::MiniProfiler
-end
-```
-
-## Database profiling
-
-Currently supports Mysql2, Postgres, and Mongoid3 (with fallback support to ActiveRecord)
-
-## Storage
-
-rack-mini-profiler stores it's results so they can be shared later and aren't lost at the end of the request.
-
-There are 4 storage options: `MemoryStore`, `RedisStore`, `MemcacheStore`, and `FileStore`.
-
-`FileStore` is the default in Rails environments and will write files to `tmp/miniprofiler/*`.  `MemoryStore` is the default otherwise.
-
-To change the default you can create a file in `config/initializers/mini_profiler.rb`
-
-```ruby 
-# set MemoryStore
-Rack::MiniProfiler.config.storage = Rack::MiniProfiler::MemoryStore
-
-# set RedisStore
-if Rails.env.production?
-  uri = URI.parse(ENV["REDIS_SERVER_URL"])
-  Rack::MiniProfiler.config.storage_options = { :host => uri.host, :port => uri.port, :password => uri.password }
-  Rack::MiniProfiler.config.storage = Rack::MiniProfiler::RedisStore
-end
-```
-
-MemoryStore stores results in a processes heap - something that does not work well in a multi process environment. 
-FileStore stores results in the file system - something that may not work well in a multi machine environment. 
-RedisStore/MemcacheStore work in multi process and multi machine environments (RedisStore only saves results for up to 24 hours so it won't continue to fill up Redis).
-
-Additionally you may implement an AbstractStore for your own provider. 
-
-## User result segregation
-
-MiniProfiler will attempt to keep all user results isolated, out-of-the-box the user provider uses the ip address: 
-
-```ruby
-Rack::MiniProfiler.config.user_provider = Proc.new{|env| Rack::Request.new(env).ip} 
-```
-
-You can override (something that is very important in a multi-machine production setup): 
-
-```ruby
-Rack::MiniProfiler.config.user_provider = Proc.new{ |env| CurrentUser.get(env) } 
-```
-
-The string this function returns should be unique for each user on the system (for anonymous you may need to fall back to ip address)
-
-## Running the Specs
-
-```
-$ rake build
-$ rake spec
-```
-
-Additionally you can also run `autotest` if you like.
-
-## Configuration Options
-
-You can set configuration options using the configuration accessor on Rack::MiniProfiler:
-
-```
-# Have Mini Profiler show up on the right
-Rack::MiniProfiler.config.position = 'right'
-# Have Mini Profiler start in hidden mode - display with short cut (defaulted to 'Alt+P')
-Rack::MiniProfiler.config.start_hidden = true
-# Don't collect backtraces on SQL queries that take less than 5 ms to execute
-# (necessary on Rubies earlier than 2.0)
-Rack::MiniProfiler.config.backtrace_threshold_ms = 5
-```
-
-
-In a Rails app, this can be done conveniently in an initializer such as config/initializers/mini_profiler.rb.
-
-## Rails 2.X support
-
-To get MiniProfiler working with Rails 2.3.X you need to do the initialization manually as well as monkey patch away an incompatibility between activesupport and json_pure.
-
-Add the following code to your environment.rb (or just in a specific environment such as development.rb) for initialization and configuration of MiniProfiler.
-
-```ruby
-# configure and initialize MiniProfiler
-require 'rack-mini-profiler'
-c = ::Rack::MiniProfiler.config
-c.pre_authorize_cb = lambda { |env|
-  Rails.env.development? || Rails.env.production?
-}
-tmp = Rails.root.to_s + "/tmp/miniprofiler"
-FileUtils.mkdir_p(tmp) unless File.exists?(tmp)
-c.storage_options = {:path => tmp}
-c.storage = ::Rack::MiniProfiler::FileStore
-config.middleware.use(::Rack::MiniProfiler)
-::Rack::MiniProfiler.profile_method(ActionController::Base, :process) {|action| "Executing action: #{action}"}
-::Rack::MiniProfiler.profile_method(ActionView::Template, :render) {|x,y| "Rendering: #{@virtual_path}"}
-
-# monkey patch away an activesupport and json_pure incompatability
-# http://pivotallabs.com/users/alex/blog/articles/1332-monkey-patch-of-the-day-activesupport-vs-json-pure-vs-ruby-1-8
-if JSON.const_defined?(:Pure)
-  class JSON::Pure::Generator::State
-    include ActiveSupport::CoreExtensions::Hash::Except
-  end
-end
-```
-
-## Notes
-
-- Be sure to require rack_mini_profiler last in your Gemfile, when it is required it will monkey patch pg and mysql gems to insert instrumentation. If included too early no SQL will show up.
-
-## Available Options
-
-* pre_authorize_cb - A lambda callback you can set to determine whether or not mini_profiler should be visible on a given request. Default in a Rails environment is only on in development mode. If in a Rack app, the default is always on.
-* position - Can either be 'right' or 'left'. Default is 'left'.
-* skip_schema_queries - Whether or not you want to log the queries about the schema of your tables. Default is 'false', 'true' in rails development.
-* auto_inject (default true) - when false the miniprofiler script is not injected in the page
-* backtrace_filter - a regex you can use to filter out unwanted lines from the backtraces
-* toggle_shortcut (default Alt+P) - a jquery.hotkeys.js-style keyboard shortcut, used to toggle the mini_profiler's visibility. See http://code.google.com/p/js-hotkeys/ for more info.
-* start_hidden (default false) - Whether or not you want the mini_profiler to be visible when loading a page
-* backtrace_threshold_ms (default zero) - Minimum SQL query elapsed time before a backtrace is recorded. Backtrace recording can take a couple of milliseconds on rubies earlier than 2.0, impacting performance for very small queries.
-
-## Special query strings 
-
-If you include the query string `pp=help` at the end of your request you will see the various options available. You can use these options to extend or contract the amount of diagnostics rack-mini-profiler gathers. 
-

data/Ruby/lib/html/list.tmpl

@@ -1,34 +0,0 @@
-<script id="tableTemplate" type="text/x-jquery-tmpl">
-  <table>
-    <thead>
-      <tr>
-        <th>Name</th>
-        <th>Started</th>
-        <th>Sql Duration</th>
-        <th>Total Duration</th>
-        <th>Request Start</th>
-        <th>Response Start</th>
-        <th>Dom Complete</th>
-      </tr>
-    </thead>
-    <tbody>
-      
-    </tbody>
-  </table>
-</script>
-<script id="rowTemplate" type="text/x-jquery-tmpl">
-  <tr>
-    <td>
-      <a href="${MiniProfiler.path}results?id=${Id}">${Name}</a></td>
-    <td class="date">${MiniProfiler.renderDate(Started)}</td>
-    <td class="time">${DurationMillisecondsInSql}</td>
-    <td class="time">${DurationMilliseconds}</td>
-    {{if ClientTimings}}
-    <td class="time">${MiniProfiler.getClientTimingByName(ClientTimings,"Request").Start}</td>
-    <td class="time">${MiniProfiler.getClientTimingByName(ClientTimings,"Response").Start}</td>
-    <td class="time">${MiniProfiler.getClientTimingByName(ClientTimings,"Dom Complete").Start}</td>
-    {{else}}
-    <td colspan="3"></td>
-    {{/if}}
-  </tr>
-</script>

data/Ruby/lib/html/profile_handler.js

@@ -1 +0,0 @@
-<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/client_timer_struct.rb

@@ -1,78 +0,0 @@
-require 'mini_profiler/timer_struct'
-
-module Rack
-  class MiniProfiler
-
-    # This class holds the client timings
-    class ClientTimerStruct < TimerStruct
-
-      def self.init_instrumentation
-        "<script type=\"text/javascript\">mPt=function(){var t=[];return{t:t,probe:function(n){t.push({d:new Date(),n:n})}}}()</script>"
-      end
-      
-      def self.instrument(name,orig)
-        probe = "<script>mPt.probe('#{name}')</script>"
-        wrapped = probe
-        wrapped << orig 
-        wrapped << probe 
-        wrapped
-      end
-
-
-      def initialize(env={})
-        super
-      end
-
-      def self.init_from_form_data(env, page_struct)
-        timings = []
-        clientTimes, clientPerf, baseTime = nil 
-        form = env['rack.request.form_hash']
-
-        clientPerf = form['clientPerformance'] if form 
-        clientTimes = clientPerf['timing'] if clientPerf 
-
-        baseTime = clientTimes['navigationStart'].to_i if clientTimes
-        return unless clientTimes && baseTime 
-
-        probes = form['clientProbes']
-        translated = {}
-        if probes && !["null", ""].include?(probes)
-          probes.each do |id, val|
-            name = val["n"]
-            translated[name] ||= {} 
-            if translated[name][:start]
-              translated[name][:finish] = val["d"]
-            else 
-              translated[name][:start] = val["d"]
-            end
-          end
-        end
-
-        translated.each do |name, data|
-          h = {"Name" => name, "Start" => data[:start].to_i - baseTime}
-          h["Duration"] = data[:finish].to_i - data[:start].to_i if data[:finish]
-          timings.push(h)
-        end
-
-        clientTimes.keys.find_all{|k| k =~ /Start$/ }.each do |k|
-          start = clientTimes[k].to_i - baseTime 
-          finish = clientTimes[k.sub(/Start$/, "End")].to_i - baseTime
-          duration = 0 
-          duration = finish - start if finish > start 
-          name = k.sub(/Start$/, "").split(/(?=[A-Z])/).map{|s| s.capitalize}.join(' ')
-          timings.push({"Name" => name, "Start" => start, "Duration" => duration}) if start >= 0
-        end
-
-        clientTimes.keys.find_all{|k| !(k =~ /(End|Start)$/)}.each do |k|
-          timings.push("Name" => k, "Start" => clientTimes[k].to_i - baseTime, "Duration" => -1)
-        end
-
-        rval = self.new
-        rval['RedirectCount'] = env['rack.request.form_hash']['clientPerformance']['navigation']['redirectCount']
-        rval['Timings'] = timings
-        rval
-      end
-    end
-
-  end
-end