active-record-profiler 0.1

data/lib/active-record-profiler/log_subscriber.rb

@@ -0,0 +1,30 @@
+require 'active_record/log_subscriber'
+
+module ActiveRecordProfiler
+  class LogSubscriber < ActiveRecord::LogSubscriber
+    def sql(event)
+      start_time = Time.now.to_f
+      payload = event.payload
+
+      duration = event.duration
+      sql_string = payload[:sql]
+
+      begin
+        collector = ActiveRecordProfiler::Collector.instance
+        loc = collector.call_location_name
+        collector.record_caller_info(loc, duration, sql_string.strip)
+
+        collector.record_self_info((Time.now.to_f - start_time), 'updating profiler stats') if ActiveRecordProfiler::Collector.profile_self?
+
+        start_time = Time.now.to_f
+        if collector.should_flush_stats?
+          collector.flush_query_sites_statistics 
+          collector.record_self_info((Time.now.to_f - start_time), 'flushing profiler stats') if ActiveRecordProfiler::Collector.profile_self?
+        end
+      rescue Exception => e
+        Rails.logger.error("Caught exception in #{self.class}: #{e} at #{e.backtrace.first}")
+      end
+    end
+
+  end
+end

data/lib/active-record-profiler/logger.rb

@@ -0,0 +1,67 @@
+require 'logger'
+
+module ActiveRecordProfiler
+  class Logger < SimpleDelegator
+
+    def add(severity, message = nil, progname = nil, &block)
+      return true if (severity || ::Logger::Severity::UNKNOWN) < self.level
+
+      if message.nil?
+        if block_given?
+          message = yield
+        else
+          message = progname
+          progname = self.progname
+        end
+      end
+
+      message = add_call_site_to_message(message)
+
+      super(severity, message, progname, &block)
+    end
+
+    # Define all of the basic logging methods so that they invoke our add()
+    # method rather than delegating to the delagatee's methods, which will then
+    # invoke the delegatee's add() method that does not add call-site 
+    # information.
+    [:debug, :info, :warn, :error, :fatal, :unknown].each do |level|
+      define_method(level) do |progname = nil, &block|
+        add(
+            ::Logger::Severity.const_get(level.to_s.upcase),
+            nil,
+            progname,
+            &block
+        )
+      end
+    end
+
+    protected
+      def add_call_site_to_message(msg)
+        message = msg
+
+        if String === msg 
+          match = /^\s*(?:\e\[\d+m)*(:?[^(]*)\(([0-9.]+)\s*([a-z]s(:?econds)?)\)(?:\e\[\d+m)*\s*(.*)/.match(msg)
+
+          if match
+            loc = collector.call_location_name
+            message = "#{msg} CALLED BY '#{formatted_location(loc)}'"
+          end
+        end
+
+        return message
+      end
+  
+      def collector
+        ActiveRecordProfiler::Collector.instance
+      end
+
+      def formatted_location(loc)
+        if Rails.configuration.colorize_logging
+          "\e[4;32;1m#{loc}\e[0m"
+        else
+          loc
+        end
+      end
+
+  end
+end

data/lib/active-record-profiler/profiler_view_helper.rb

@@ -0,0 +1,200 @@
+module ActiveRecordProfiler
+  module ProfilerViewHelper
+    def profiler_date_filter_form(page_params, options = {})
+      page_params ||= {}
+      options ||= {}
+      date    = options[:date] || page_params[:date] || Time.now.strftime(ActiveRecordProfiler::Collector::DATE_FORMAT)
+      sort_by = options[:sort] || page_params[:sort] || ActiveRecordProfiler::Collector::DURATION
+      
+      content_tag(:form) do
+        [
+          hidden_field_tag(:sort, sort_by),
+          label_tag(:profiler_date, 'Filter by date-hour prefix (yyyy-mm-dd-hh):'),
+          text_field_tag(:date, date, {:size =>10, :id => :profiler_date}),
+          submit_tag('Go')
+        ].join.html_safe
+      end
+    end
+    
+    def profiler_report(page_params, options = {})
+      date      = options[:date]      || page_params[:date]     || Time.now.strftime(ActiveRecordProfiler::Collector::DATE_FORMAT)
+      sort_by   = (options[:sort]     || page_params[:sort]     || ActiveRecordProfiler::Collector::DURATION).to_i
+      max_rows  = (options[:max_rows] || page_params[:max_rows] || 100).to_i
+      collector = options[:collector] || ActiveRecordProfiler::Collector.new
+      
+      options = options.reverse_merge(:table => 'profiler', :link_locations => false)
+      
+      totals = collector.aggregate(:prefix => date)
+      top_locs = collector.sorted_locations(sort_by.to_i, max_rows)
+      
+      rows = []
+
+      if top_locs.present?
+        top_item = totals[top_locs.first]
+        max_bar = sort_by == ActiveRecordProfiler::Collector::AVG_DURATION ? (top_item[0]/top_item[1]) : top_item[sort_by]
+    
+        top_locs.each do |location|
+          rows << content_tag(
+            :tr, 
+            profiler_report_cols(location, totals[location], sort_by, max_bar, options),
+            {:class => "#{cycle('oddRow', 'evenRow')} #{options[:row]}"}
+          )
+        end
+      end
+      
+      content_tag(:table, {:class => options[:table]}) do 
+        [
+          content_tag(:thead,
+            profiler_report_header(page_params, sort_by, max_rows, options)
+          ),
+          content_tag(:tbody) do
+            rows.join.html_safe
+          end
+        ].join.html_safe
+      end  
+    end
+    
+    def profiler_column_header_link(column_id, sort_by, page_params)
+      labels = {
+        ActiveRecordProfiler::Collector::DURATION => '<b>Total Duration (s)</b>',
+        ActiveRecordProfiler::Collector::COUNT => '<b>Count</b>',
+        ActiveRecordProfiler::Collector::AVG_DURATION => '<b>Avg. Duration (ms)</b>',
+        ActiveRecordProfiler::Collector::LONGEST => '<b>Max. Duration (ms)</b>',
+      }
+      
+      link_to_unless(sort_by == column_id, 
+        labels[column_id].html_safe, 
+        page_params.merge(:sort => column_id)
+      )
+    end
+
+    def profiler_report_header(page_params, sort_by, max_rows, options)
+      column_styles = options[:column_styles] || {
+        :location => 'width:19%',
+        :total_duration => 'width:6%',
+        :count => 'width:6%',
+        :average_duration => 'width:6%',
+        :max_duration => 'width:6%',
+        :longest_sql => 'width:57%'
+      }
+
+      headers = []
+
+      headers << content_tag(:th, 'Location', {:style => column_styles[:location]})
+
+      headers << content_tag(
+        :th, 
+        profiler_column_header_link(ActiveRecordProfiler::Collector::DURATION, sort_by, page_params),
+        {:style => column_styles[:total_duration]}
+      )
+
+      headers << content_tag(
+        :th, 
+        profiler_column_header_link(ActiveRecordProfiler::Collector::COUNT, sort_by, page_params),
+        {:style => column_styles[:count]}
+      )
+
+      headers << content_tag(
+        :th, 
+        profiler_column_header_link(ActiveRecordProfiler::Collector::AVG_DURATION, sort_by, page_params),
+        {:style => column_styles[:average_duration]}
+      )
+
+      headers << content_tag(
+        :th, 
+        profiler_column_header_link(ActiveRecordProfiler::Collector::LONGEST, sort_by, page_params),
+        {:style => column_styles[:max_duration]}
+      )
+
+      headers << content_tag(:th, 'SQL for Max Duration', {:style => column_styles[:longest_sql]})
+      
+      content_tag(:tr, {:class => options[:header]}) do
+        headers.join.html_safe
+      end
+    end
+    
+    def profiler_report_cols(location, row_data, sort_by, max_bar, options)
+      columns = []
+
+      loc_parts = location.split(':')
+      breakble_loc = loc_parts[0].gsub('/', "&#8203;/")
+      this_bar = sort_by == ActiveRecordProfiler::Collector::AVG_DURATION ? (row_data[0]/row_data[1]) : row_data[sort_by]
+
+      columns << content_tag(:td, {:title=>loc_parts[2]}) do
+        [
+          link_to_if(
+            options[:link_locations],
+            "#{breakble_loc}: #{loc_parts[1]}".html_safe, 
+            "javascript:showSourceFile('#{loc_parts[0]}', '#{loc_parts[1]}');"
+          ),
+          content_tag(:div, '', {:style=>"background-color:red; height:1.2em; width:#{100*this_bar/max_bar}%"})
+        ].join.html_safe
+      end
+
+      columns << content_tag(:td, number_with_precision(row_data[0], :precision => 3), {:class => "numeric"})
+      columns << content_tag(:td, number_with_delimiter(row_data[1]), {:class => "numeric"})
+      columns << content_tag(:td, number_with_precision(row_data[0]/row_data[1] * 1000, :precision => 3), {:class => "numeric"})
+      columns << content_tag(:td, number_with_precision(row_data[2] * 1000, :precision => 3), {:class => "numeric"})
+      columns << content_tag(:td, h(row_data[3]), {:class => "sql"})
+
+      columns.join('').html_safe
+    end
+    
+    def profiler_report_local_path_form
+      content_tag(:form, 
+        [
+          label_tag(:source_root, 'Local gistweb source path (for location links):'),
+          text_field_tag(:source_root, nil, {:size => 50, :id => :source_root})
+        ]
+      )
+    end
+    
+    def profiler_local_path_link_formatters
+      @@profiler_local_path_link_formatters ||= {
+        :textmate => '"txmt://open/?url=file://" + root + "/" + file + "&line=" + line',
+      }
+    end
+    
+    def profile_report_local_path_javascript(link_format = :textmate)
+      formatter = profiler_local_path_link_formatters[link_format]
+      
+      javascript_tag(%Q[
+        var profiler_source_root = $('#source_root');
+        
+        function setDBProfSourceRoot(value) {
+          var exdate = new Date(); 
+          var expireDays = 356;
+          exdate.setDate(exdate.getDate() + expireDays);
+          document.cookie = "db_prof_source_root=" + escape(value) + ";expires=" + exdate.toGMTString();
+        }
+      
+        function getDBProfSourceRoot() {
+          if (document.cookie.length>0) {
+            var c_name = "db_prof_source_root";
+            c_start = document.cookie.indexOf(c_name + "=");
+            if (c_start != -1) {
+              c_start = c_start + c_name.length + 1;
+              c_end = document.cookie.indexOf(";", c_start);
+              if (c_end == -1) { c_end = document.cookie.length; }
+              var root = document.cookie.substring(c_start, c_end);
+              if (root != "") {
+                return unescape(root);
+              }
+            }
+          }
+          return "#{Rails.root}";
+        }
+        function showSourceFile(file, line){
+          var root = profiler_source_root.val();
+          if (root == "") { root = "#{Rails.root}"}
+          window.location = #{formatter};
+        }
+        
+        profiler_source_root.val(getDBProfSourceRoot());
+        profiler_source_root.change(function(e){
+          setDBProfSourceRoot($(this).val());
+        });
+      ])
+    end
+  end
+end

data/lib/active-record-profiler/railtie.rb

@@ -0,0 +1,18 @@
+require 'active-record-profiler'
+require 'rails'
+
+module ActiveRecordProfiler
+  class Railtie < Rails::Railtie
+    initializer "active_record_profiler.add_to_abstract_adapter" do |app|
+      # ActiveRecordProfiler::LogSubscriber.attach_to :active_record
+      ActionView::Base.send :include, ProfilerViewHelper
+
+      Collector.trim_root_path = "#{Rails.root.expand_path}/"
+      Collector.profile_dir = Rails.root.join("log", "profiler_data")
+    end
+
+    rake_tasks do
+      load 'active-record-profiler/tasks.rake'
+    end
+  end
+end

data/lib/active-record-profiler/tasks.rake

@@ -0,0 +1,41 @@
+namespace "profiler" do
+
+  desc 'Aggregate profile data and display locations with the longest total durations'
+  task :aggregate => :environment do
+    top_n = ENV['max_lines'].present? ? ENV['max_lines'].to_i : 50
+    show_longest_sql = ENV['show_sql'] == 'true' ? true : false
+    prefix = ENV['prefix'].present? ? ENV['prefix'] : nil
+    compact = case ENV['compact']
+      when 'date'
+        :date
+      when 'hour'
+        :hour
+      else
+        nil
+    end
+
+    if compact && prefix.nil?
+      case compact
+      when :date
+        prefix = 1.day.ago.strftime(ActiveRecordProfiler::Collector::DATE_FORMAT)
+      when :hour
+        prefix = 1.hour.ago.strftime(ActiveRecordProfiler::Collector::DATE_FORMAT + ActiveRecordProfiler::HOUR_FORMAT)
+      end
+    end
+    
+    collector = ActiveRecordProfiler::Collector.new
+    totals = collector.aggregate(:prefix => prefix, :compact => compact)
+    top_locs = collector.sorted_locations(ActiveRecordProfiler::Collector::DURATION, top_n)
+    
+    top_locs.each do |loc|
+      data = show_longest_sql ? totals[loc] : totals[loc][0..-2]
+      puts "#{loc}: #{data.join(', ')}"
+    end
+  end
+  
+  desc 'Clear out the profiler data diretory'
+  task :clear_data => :environment do
+    ActiveRecordProfiler::Collector.clear_data
+  end
+  
+end

data/lib/active-record-profiler/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordProfiler
+  VERSION = "0.1"
+end

data/test/active_record_profiler_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper.rb'
+
+class ActiveRecordProfilerTest < ActiveSupport::TestCase
+  def setup
+    @collector = ActiveRecordProfiler::Collector.instance
+    @test_log = StringIO.new
+    ActiveRecord::Base.logger = ActiveRecordProfiler::Logger.new(
+        ActiveSupport::Logger.new(@test_log))
+  end
+  
+  def test_caller_location_appears_in_log
+    sql = 'SELECT 1 FROM widgets'
+    ActiveRecord::Base.connection.select_value(sql)
+    @test_log.rewind
+    log_data = @test_log.read
+    assert_match Regexp.new(Regexp.quote(sql) + '.*' + Regexp.quote('active_record_profiler_test.rb')), log_data
+  end
+
+  def test_profiler_records_query_site
+    assert @collector
+    @collector.flush_query_sites_statistics
+    assert @collector.query_sites.blank?
+    sql = 'SELECT 1 FROM widgets'
+    ActiveRecord::Base.connection.select_value(sql)
+    @test_log.rewind
+    assert @collector.query_sites.present?
+  end
+
+end

data/test/database.yml

@@ -0,0 +1,4 @@
+test:
+ adapter: sqlite3
+ database: db/dummy.sqlite3
+ pool: 5

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .