active-profiling 0.0.2 → 0.1.0

data/README.rdoc

@@ -2,8 +2,7 @@
 = ActiveProfiling
 
 ActiveProfiling is a gem I've slapped together over the years to help with
-profiling Rails applications. It is mostly aimed at profiling actions but
-can also be used to profile generic blocks of code.
+profiling Rails applications.
 
 == Profiler ActionController Filters
 
@@ -25,6 +24,9 @@ To enable this filter, add the following to your application configuration:
 
   config.active_profiling.profiler.enabled = true
 
+Additional configuration options can be found in the documentation for
+ActiveProfiling::Railtie.
+
 === +action_gc_statistics+
 
 This filter wraps up the functionality of either GC::Profiler in Ruby 1.9+ or
@@ -45,6 +47,9 @@ To enable this filter, add the following to your application configuration:
 
   config.active_profiling.gc_statistics.enabled = true
 
+Additional configuration options can be found in the documentation for
+ActiveProfiling::Railtie.
+
 == Profiling Blocks
 
 You can also profile individual blocks of code by using the
@@ -65,6 +70,23 @@ minus the +:enabled+ option.
     # ...
   end
 
+
+== Extended ActiveRecord Logging
+
+The database can often be a performance hotspot, and tracking down where and
+why some queries are occuring in your application can be a pain.
+ActiveProfiling includes an extended query logger that can be configured
+to log backtraces for SQL queries that can help you track down where
+unexpected queries are occuring in your code.
+
+To enable extended logging, add the following to your application
+configuration:
+
+  config.active_profiling.active_record.backtrace_logger.enabled = true
+
+Additional configuration options can be found in the documentation for
+ActiveProfiling::Railtie.
+
 == Using In A Rails Project
 
 Profiling should be performed in a production environment, as profiling in
@@ -107,6 +129,8 @@ like so:
           :print_file => true
         }
         config.active_profiling.gc_statistics.enabled = true
+
+        config.active_profiling.active_record.backtrace_logger.enabled = true
       end
 
       # etc...

data/lib/active-profiling.rb

@@ -20,7 +20,8 @@ module ActiveProfiling
 end
 
 require 'active-profiling/railtie'
-require 'active-profiling/log_subscriber'
 require 'active-profiling/gc_statistics'
 require 'active-profiling/ruby_profiler'
-require 'active-profiling/action_controller/action_profiling'
+require 'active-profiling/action_controller'
+require 'active-profiling/active_record'
+

data/lib/active-profiling/action_controller.rb

@@ -0,0 +1,3 @@
+
+require 'active-profiling/action_controller/action_profiling'
+require 'active-profiling/action_controller/log_subscriber'

data/lib/active-profiling/{log_subscriber.rb → action_controller/log_subscriber.rb}

@@ -1,5 +1,5 @@
 
-module ActiveProfiling
+module ActiveProfiling::ActionController
   class LogSubscriber < ActiveSupport::LogSubscriber
     def profiler_output(event)
       return unless logger &&
@@ -56,4 +56,4 @@ module ActiveProfiling
   end
 end
 
-ActiveProfiling::LogSubscriber.attach_to :active_profiling
+ActiveProfiling::ActionController::LogSubscriber.attach_to :active_profiling

data/lib/active-profiling/active_record.rb

@@ -0,0 +1,3 @@
+
+require 'active-profiling/active_record/backtrace_log_subscriber'
+

data/lib/active-profiling/active_record/backtrace_log_subscriber.rb

@@ -0,0 +1,41 @@
+
+module ActiveProfiling::ActiveRecord
+  class BacktraceLogSubscriber < ::ActiveSupport::LogSubscriber
+    def sql(event)
+      return unless config.log_level &&
+        logger &&
+        logger.send("#{config.log_level}?")
+
+      payload = event.payload
+
+      return if 'SCHEMA' == payload[:name]
+
+      backtrace = event.send(:caller).collect { |line|
+        if line_match(line)
+          "    #{line}"
+        end
+      }.compact
+
+      unless backtrace.empty?
+        name = color(payload[:name], YELLOW, true)
+        logger.send(config.log_level, "  #{name}\n#{backtrace.join("\n")}")
+      end
+    end
+
+    def logger
+      ::ActiveRecord::Base.logger
+    end
+
+    protected
+      def config
+        Rails.application.config.active_profiling.active_record.backtrace_logger
+      end
+
+      def line_match(line)
+        config.enabled && (config.verbose || !!(line =~ config.matcher))
+      end
+  end
+end
+
+ActiveProfiling::ActiveRecord::BacktraceLogSubscriber.attach_to :active_record
+

data/lib/active-profiling/railtie.rb

@@ -84,15 +84,40 @@ module ActiveProfiling
       :log_level => :info
     }.freeze
 
+    # These settings are the default values used for the ActiveRecord
+    # backtrace logger.
+    #
+    # * +:enabled+ - Enables backtrace logging of SQL queries so you can see
+    #   where your queries originate.
+    # * +:verbose+ - Logs all backtrace lines. Normally we have a +:matcher+
+    #   option that you can use to filter out lines you want to log, but this
+    #   is a quick method to bypass that matching completely.
+    # * +:log_level+ - The log level to use when logging SQL backtraces.
+    # * +:matcher+ - A Regexp that is used to match caller lines in the
+    #   backtraces being logged. By default, this is set to
+    #   /^#{Rails.root}(?!(\/vendor\/rails|\/\.bundle))/ so that only lines
+    #   in your application code are logged.
+    DEFAULT_AR_BACKTRACE_LOGGER_OPTIONS = {
+      :enabled => false,
+
+      :verbose => false,
+
+      :log_level => :debug
+    }.freeze
+
     config.active_profiling = ActiveSupport::OrderedOptions.new
     config.active_profiling.profiler = ActiveSupport::OrderedOptions.new
     config.active_profiling.gc_statistics = ActiveSupport::OrderedOptions.new
+    config.active_profiling.active_record = ActiveSupport::OrderedOptions.new
+    config.active_profiling.active_record.backtrace_logger = ActiveSupport::OrderedOptions.new
 
     initializer "active_profiling.set_profiling_config" do |app|
       options = app.config.active_profiling
 
       options.profiler.reverse_merge!(DEFAULT_PROFILER_OPTIONS)
       options.gc_statistics.reverse_merge!(DEFAULT_GC_STATISTICS_OPTIONS)
+      options.active_record.backtrace_logger.reverse_merge!(DEFAULT_AR_BACKTRACE_LOGGER_OPTIONS)
+      options.active_record.backtrace_logger[:matcher] ||= /^#{Rails.root}(?!(\/vendor\/rails|\/\.bundle))/
     end
   end
 end

data/lib/active-profiling/ruby_profiler.rb

@@ -36,8 +36,13 @@ module ActiveProfiling
       GC.disable if options[:disable_gc]
 
       result = nil
+      exception = nil
       profiler_result = RubyProf.profile do
-        result = yield
+        begin
+          result = yield
+        rescue
+          exception = $!
+        end
       end
 
       case output
@@ -94,7 +99,11 @@ module ActiveProfiling
           printer_class.new(profiler_result).print(File.open(file_name, 'w'), options[:printer_options])
       end
 
-      result
+      if exception
+        raise exception
+      else
+        result
+      end
     ensure
       GC.enable if options[:disable_gc]
     end

data/lib/active-profiling/version.rb

@@ -1,4 +1,4 @@
 
 module ActiveProfiling
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

metadata

@@ -2,31 +2,31 @@
 name: active-profiling
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - J Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-24 00:00:00.000000000 Z
+date: 2013-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rails
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.0'
     none: false
-  name: rails
-  type: :runtime
-  prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.0'
     none: false
+  prerelease: false
 description: A Rails profiling suite.
 email: dark.panda@gmail.com
 executables: []
@@ -41,9 +41,12 @@ files:
 - Rakefile
 - active-profiling.gemspec
 - lib/active-profiling.rb
+- lib/active-profiling/action_controller.rb
 - lib/active-profiling/action_controller/action_profiling.rb
+- lib/active-profiling/action_controller/log_subscriber.rb
+- lib/active-profiling/active_record.rb
+- lib/active-profiling/active_record/backtrace_log_subscriber.rb
 - lib/active-profiling/gc_statistics.rb
-- lib/active-profiling/log_subscriber.rb
 - lib/active-profiling/railtie.rb
 - lib/active-profiling/ruby_profiler.rb
 - lib/active-profiling/version.rb
@@ -57,6 +60,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 1112450418277949513
       version: '0'
   none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -67,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A Rails profiling suite.