active-record-profiler 0.1 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29a3517f08a6a21ab80d888178ae5371f60f9f05
-  data.tar.gz: 752933b5e705af4c7698496246f2356df6007dbb
+  metadata.gz: 211f71211f9004c489a7de54d5c5e59698d7597d
+  data.tar.gz: 956d9fbd435a5eaa6159e221fa4a7182532e6a70
 SHA512:
-  metadata.gz: e23f7711b5a0936b5d55e14027f3befd06bf7f6d999d3a4e8b8efcc636d0b41e78cd69cef3f4d11d3c7ba9a673ad50bf2e829a1ea58172e5580ff8a8d09ce74a
-  data.tar.gz: 3099240d90f3497e8f2f95597e5489c4b487d58e0fc234f29190d9ad4ca3daefe125ffecf05a73b8ac9d8588b1b247eb8c69091eb2fd6683a10c9ce2ad869e13
+  metadata.gz: a7b4b502cbd6e098f23aa3666b1567954aedf24d4de83e69168a404216e914ed53c011a815b85ca8bcf5febe33bddf08330969631f28cc87a9f5474a119f3df5
+  data.tar.gz: a8e5101c041a79d1383039ac2ab661d832b3a6d054d19be37a3255f5d8eae71b3ce1af69f3445f64ced0dc667248751d0ff108f5c86f987227025e0e8bd906e3

data/README.md

@@ -1,147 +1,122 @@
 ActiveRecordProfiler
 ====================
 
-ActiveRecordProfiler monkey-patches 
-ActiveRecord::ConnectionAdapters::AbstractAdapter both to improve the 
-standard SQL logging and to provide profiler-like tracking of SQL
-statements generated by application code.
-
-Each SQL log entry generated by ActiveRecord will have appended the 
-filename, line number, and function name of the nearest calling 
-application code. The information is determined by walking up the call
-stack until a filename within the /app/ directory is found. If no such
-filename can be found, the SQL will be logged with a location of 
-'Non-application code'.
-
-Additionally, the profiler will keep track of the total time spent by all
-SQL calls coming from each calling location, as well as the number of time
-that location accessed the database. Certain SQL calls not under the
-direct control of the application are not counted in these statistics,
-such as "SHOW FIELDS", "SET NAMES", "BEGIN", and "COMMIT" statements which
-tend to skew the timing statistics and provide less useful information
-about slow SQL queries.
-
-Periodically, the profiler will dump its statistics out to a file and
-restart all of its counters/timers. The output file is named for the time
-and PID from which it was written, so that multiple processes can safely
-write their output simultaneously.
+The `active-record-profiler` gem adds a log formatter to improve the standard SQL logging and a log subscriber to provide profiler-like tracking of SQL statements generated by application code. The log formatter makes the SQL statements in your logs look like this (imagine it's all in one log line):
+
+    Person Load (0.3ms)  SELECT  `people`.* FROM `people`  WHERE `people`.`id` = ? LIMIT 1  [["id", 1]] 
+      CALLED BY 'app/controllers/day_controller.rb:282:in `find_person''
+
+If you're using log colorizing, then it's even fancier:
+
+![Enhanced Log](./screenshots/enhanced-log.png?raw=true)
+
+Each SQL log entry generated by ActiveRecord will have appended the filename, line number, and function name of the nearest calling application code. The information is determined by walking up the call stack until a filename within the `/app/` directory is found. If no such filename can be found, the SQL will be logged with a location of 'Non-application code'.
+
+Additionally, the profiler will keep track of the total time spent by all SQL calls coming from each calling location, as well as the number of time that location accessed the database. Certain SQL calls not under the direct control of the application are not counted in these statistics, such as `SHOW FIELDS`, `SET NAMES`, `BEGIN`, and `COMMIT` statements which tend to skew the timing statistics and provide less useful information about slow SQL queries.
+
+Periodically, the profiler will dump its statistics out to a file and restart all of its counters/timers. The output file is named for the time, process id, and thread id from which it was written, so that multiple threads/processes can safely write their output simultaneously.
 
 Installation
 ============
-Add it to your Gemfile, do `bundle install`, and then add a new initializer, `config/initializers/active_record_profiler.rb`:
+Add it to your Gemfile, like so:
+
+    gem 'active-record-profiler'
+
+Then do `bundle install`, and then add a new initializer, `config/initializers/active_record_profiler.rb`:
 
     ActiveRecord::Base.logger =
         ActiveRecordProfiler::Logger.new(ActiveRecord::Base.logger)
     ActiveRecordProfiler::LogSubscriber.attach_to :active_record unless Rails.env.test?
 
-
 The first line adds call-site information to ActiveRecord logging, and the second line enables profiling (except in the test environment, where it would mess up your profiling data).
 
 Configuration
 =============
+
+## stats_flush_period ##
 Control the (approximate) frequency of statistics flushes (default: `1.hour`)
 
-    ActiveRecordProfiler::Collector.stats_flush_period = 1.hour
+    ActiveRecordProfiler.stats_flush_period = 1.hour
 
 Note that only flushed data is available for use in the rake reports (described below). If you are running a multithreaded or multiprocess server (which covers most common rails server types), your data will be incomplete until all those threads/processes/servers have flushed their data. This limitation exists primarily to avoid the overhead of coordinating/locking during the process of serving your application's web requests.
 
-Directory where profile data is recorded (default: `Rails.root,join('log', 'profiler_data'`)
+## profile_dir ##
+Directory where profile data is recorded. (default: `Rails.root,join('log', 'profiler_data'`)
+
+    ActiveRecordProfiler.profile_dir = Rails.root.join('log', 'profiler_data'
+
+## sql_ignore_pattern ##
+Any SQL statements matching this pattern will not be tracked by the profiler output, though it will still appear in the enhanced SQL logging. (default: `/^(SHOW FIELDS |SET SQL_AUTO_IS_NULL|SET NAMES |EXPLAIN |BEGIN|COMMIT|PRAGMA )/`)
+
+    ActiveRecordProfiler.sql_ignore_pattern = /^SET /x
 
-    ActiveRecordProfiler::Collector.profile_dir = Rails.root.join('log', 'profiler_data'
+## app_path_pattern ##
+ Any calling location that matches this pattern will be tracked individually. Any locations that do __not__ match will be grouped under a single `Non-application code` label. The default only includes the `app`, `lib`, and `vendor` directories, but that's usually suitable and avoids noise. (default: `Regexp.new(Regexp.quote("#{Rails.root.expand_path}/") + "(:?app|lib|vendor)/")`)
 
-Any SQL statements matching this pattern will not be tracked by the 
-profiler output, though it will still appear in the enhanced SQL logging
-(default: `/^(SHOW FIELDS |SET SQL_AUTO_IS_NULL|SET NAMES |EXPLAIN |BEGIN|COMMIT|PRAGMA )/`)
+    ActiveRecordProfiler.app_path_pattern = Regexp.new(Regexp.quote("#{Rails.root.expand_path}/"))
 
-    ActiveRecordProfiler::Collector.sql_ignore_pattern = /^SET /x
+## trim_root_path ##
+This prefix will be removed from the calling site filepath for brevity. (default: `"#{Rails.root.expand_path}/"`)
 
+    ActiveRecordProfiler.trim_root_path = "#{Rails.root.parent.expand_path}/app"
 
-Reports
-=======
-To see a top-100 list of what SQL statements your application is spending its
-time in, run the following rake task:
+## profile_self ##
+This setting controls whether the profiler records information about how much time was spent in the profiling code itself. If you want to know what kind of overhead the profiler is adding, set this to true. (default: `false`)
+
+    ActiveRecordProfiler.profile_self = true
+
+
+## link_location ##
+Whether or not to make the locations in the profiler reports into source code links (only works with editors that can be launched via URL scheme) (default: `false`):
+
+    ActiveRecordProfiler.link_location = true
+
+
+Command Line Reports
+====================
+To see a top-100 list of what SQL statements your application is spending its time in, run the following rake task:
 
     rake profiler:aggregate max_lines=100 show_sql=true
 
-This will return a list of the SQL which is taking the most time in your 
-application in this format:
+This will return a list of the SQL which is taking the most time in your application in this format:
 
     <file path>:<line number>:in <method name>: <total duration>, <call count>, <max single call duration>
 
-This will aggregate all of the profiler data you have accumulated; in order 
-to limit the timeframe of the data, use the `prefix` option to specify a
-partial date/time:
+This will aggregate all of the profiler data you have accumulated; in order to limit the timeframe of the data, use the `prefix` option to specify a partial date/time:
 
     rake profiler:aggregate max_lines=100 show_sql=true prefix=2010-06-20-10  # data from June 20 during the 10am hour (roughly)
 
-Each thread running the profiler flushes its stats periodically, and there
-is a rake task to combine multiple profiler data files together in order to 
-keep the number of data files down to a manageable number. A good way to 
-manage the data files on a server is to set up a cron task to run the 
-following command once per hour or once per day:
+Each thread running the profiler flushes its stats periodically, and there is a rake task to combine multiple profiler data files together in order to keep the number of data files down to a manageable number. A good way to manage the data files on a server is to set up a cron task to run the following command once per hour or once per day:
 
     rake profiler:aggregate compact=<'hour' or 'date'> RAILS_ENV=qa
 
-Compacting by hour will result in a single file for each hour any process 
-dumped its stats. Compacting by day will result in a single file for each 
-day. When using the `prefix` option to generate a profiler report, you
-cannot specify an hour if you have compacted your data by date instead of
-hour (the prefix matching operates on the file names, which will not have
-hours if they have been compacted by date).
+Compacting by hour will result in a single file for each hour any process dumped its stats. Compacting by day will result in a single file for each day. When using the `prefix` option to generate a profiler report, you cannot specify an hour if you have compacted your data by date instead of hour (the prefix matching operates on the file names, which will not have hours if they have been compacted by date).
 
 You can clear out all profiler data using the following command:
 
     rake profiler:clear_data
   
-If you want programmatic access to the profiler data, check out the source
-code for the rake tasks in `lib/active-record-profiler/tasks.rake`.
+If you want programmatic access to the profiler data, check out the source code for the rake tasks in `lib/active-record-profiler/tasks.rake`.
 
 
-=======
-HTML Reports
-============
+Web Reports
+===========
 
-The profiler includes some view helpers to make it easy for your application
-to generate a sortable HTML table of profiler information. The core helper
-method generates a table based on an ActiveRecordProfiler::Collector object.
-In its simplest form, it can be called from a view like this:
+The `active-record-profiler` gem also includes support for producing reports in your browser, which look something like this:
 
-  <div id="#profiler">
-    <%= profiler_report(params) %>
-  </div>
-  
-The full set of parameters available looks like this:
+![Web Report UI](./screenshots/web-reports.png?raw=true)
+ 
+In order to make it available, you'll want to mount the engine within your application's `routes.rb`. Since you don't want the public to have access to your profiler reports, you'll want to limit access to it. You could only mount the profiler's web interface in the development environment:
 
-  profiler_report(page_parameters, date_prefix, sort_id, max_rows, profiler_collector, css_options)
-  
-parameters:
-  page_parameters: this is generally the request parameters, used to build the report-sorting links (HashWithIndifferentAccess)
-  options: hash containing optional settings for the report; supported keys:
-  
-    :date : year, year-month, year-month-day, year-month-day-hour used to filter the profiler data; defaults to Today (String)
-    :sort : ActiveRecordProfiler::(DURATION|COUNT|LONGEST|AVG_DURATION) specifying which field to sort the report by; defaults to DURATION (Constant/Integer)
-    :max_rows : Maximum number of table rows to output; in other words, report on the top max_rows SQL statements; defaults to 100 (Integer)
-    :collector : object representing the profile data to use in building the report; defaults to an empty collector using the configured profile data directory (ActiveRecordProfiler::Collector )
-    :table : css class applied to the report <table> element; defaults to nil
-    :header_row : css class applied to the report's header row; defaults to nil
-    :row : css class applied to the report's data rows; defaults to nil
-    :link_locations : true/false value indicating whether to build textmate links to the source code whence a given piece of SQL came; defaults to false
-  
-An easy way to support filtering of report data by month/date/hour is to 
-use a view like this:
+    mount ActiveRecordProfiler::Engine => "/profiler"  if Rails.env.development?
 
-  <%= profiler_date_filter_form(params) %>
-  <%= profiler_report(params) %>
-  
-And if you use TextMate, then you may want to throw in some extra goodies
-to generate links to the actual source code files and lines where the SQL
-was triggered (Note: the current javascript requires jQuery):
+Or, if you are using [Devise](https://github.com/plataformatec/devise) and have an admin flag on a `User` model, for example:
 
-  <%= profiler_date_filter_form(params) %>
-  <%= profiler_report_local_path_form %>
-  <%= profile_report_local_path_javascript %>
-  <%= profiler_report(params, {:link_locations => true}) %>
+    authenticated :user, -> user { user.admin? } do
+      mount ActiveRecordProfiler::Engine => "/profiler"
+    end
 
+When you visit the path where you've mounted the web interface, you will by default see a report for the current day. If you just installed `active-record-profiler`, there probably won't be anything there yet, in which case you should go play with your app for a while and come back later. :) Also note that if the web server you are using has multiple processes or threads, you won't see data from those other processes/threads until they dump their data.
 
 Miscellaneous
 =============

data/active-record-profiler.gemspec

@@ -22,6 +22,7 @@ EOF
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rails", "~> 4.0"
+  spec.add_dependency "jquery-rails", "~> 3.1"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.3"

data/app/assets/javascripts/active_record_profiler/application.js

@@ -0,0 +1,14 @@
+// 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 jquery
+//= require_tree .

data/app/assets/javascripts/active_record_profiler/profiler.js

@@ -0,0 +1,104 @@
+var ActiveRecordProfiler = (function (my_module) {
+  my_module = my_module || {};
+
+  var SOURCE_ROOT_KEY = "db_prof_source_root";
+  var SOURCE_EDITOR_KEY = "db_prof_source_editor";
+  var profilerSourceRootField, sourceEditorSelect, railsRoot;
+
+  function supportsLocalStorage() {
+    try {
+      return (('localStorage' in window) && (window['localStorage'] !== null));
+    } catch (e) {
+      return false;
+    }
+  }
+
+  function setDBProfSourceRoot(value) {
+    if (supportsLocalStorage()) {
+      if (!!value) {
+        window.localStorage[SOURCE_ROOT_KEY] = value;
+      } else {
+        window.localStorage.removeItem(SOURCE_ROOT_KEY);
+      } 
+    }
+  }
+
+  function getDBProfSourceRoot() {
+    var root = railsRoot;
+
+    if (supportsLocalStorage()) {
+      var localRoot = window.localStorage[SOURCE_ROOT_KEY];
+      if (!!localRoot) {
+        root = localRoot;
+      }
+    }
+    return root;
+  }
+
+  function setSourceEditor(value) {
+    if (supportsLocalStorage()) {
+      if (!!value) {
+        window.localStorage[SOURCE_EDITOR_KEY] = value;
+      } else {
+        window.localStorage.removeItem(SOURCE_EDITOR_KEY);
+      } 
+    }
+  }
+
+  function getSourceEditor() {
+    if (supportsLocalStorage()) {
+      return window.localStorage[SOURCE_EDITOR_KEY];
+    } else {
+      return undefined;
+    }
+  }
+
+  my_module.formatLink = function (file, line, editor) {
+    var link;
+
+    switch (editor) {
+      case "subl":
+      case "txmt":
+        link = editor + "://open/?url=file://" + file + "&line=" + line;
+        break;
+      default:
+        // do nothing, return undefined link
+    }
+
+    return link;
+  };
+
+  my_module.showSourceFile = function (file, line) {
+    var root = profilerSourceRootField.val();
+    var editor = sourceEditorSelect.val();
+    if (root == "") { root = railsRoot; }
+    // window.location = "txmt://open/?url=file://" + root + "/" + file + "&line=" + line;
+    var link = my_module.formatLink(root + "/" + file, line, editor);
+    if (link) {
+      window.location = link;
+    }
+  };
+
+  $(function () {
+    profilerSourceRootField = $('#source_root');
+    railsRoot = profilerSourceRootField.val();
+
+    profilerSourceRootField.val(getDBProfSourceRoot());
+    profilerSourceRootField.change(function (e) {
+      setDBProfSourceRoot($(this).val());
+    });
+    
+    sourceEditorSelect = $('#source_editor');
+    sourceEditorSelect.val(getSourceEditor());
+    sourceEditorSelect.change(function (e) {
+      setSourceEditor($(this).val());
+    })
+
+    $('.profiler-report').on('click', '.source-link', function (event) {
+      var link = $(this);
+      my_module.showSourceFile(link.data('file'), link.data('line'));
+    });
+  });
+
+  return my_module;
+}(ActiveRecordProfiler));

data/app/assets/stylesheets/active_record_profiler/application.css

@@ -0,0 +1,61 @@
+.profiler-report {
+  border: solid 1px gray;
+  border-collapse: collapse;
+  margin-top: 5px;
+}
+
+.profiler-report th, .profiler-report td {
+  vertical-align: top;
+  padding: 3px;
+}
+
+.profiler-report thead {
+  border: solid 1px gray;
+  background: #c9e6ec;
+}
+
+.profiler-report th {
+  vertical-align: middle;
+  font-weight: bold;
+}
+
+.profiler-report th.location {
+  width: 19%;
+}
+
+.profiler-report th.total-duration {
+  width: 6%;
+}
+.profiler-report th.count {
+  width: 6%;
+}
+
+.profiler-report th.average-duration {
+  width: 6%;
+}
+
+.profiler-report th.max-duration {
+  width: 6%;
+}
+
+.profiler-report th.max-duration-sql {
+  width: 57%;
+}
+
+.profiler-report tbody tr:nth-child(even) {
+  background-color: #eee;
+}
+
+.profiler-report .rank-bar {
+  background-color: red; 
+  height: 1.2em;
+}
+
+.profiler-report td.numeric {
+  text-align: right;
+}
+
+.profiler-report td.sql {
+  font-family: monospace;
+  padding-left: 10px;
+}

data/app/controllers/active_record_profiler/application_controller.rb

@@ -0,0 +1,4 @@
+module ActiveRecordProfiler
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/active_record_profiler/reports_controller.rb

@@ -0,0 +1,30 @@
+module ActiveRecordProfiler
+  class ReportsController < ActiveRecordProfiler::ApplicationController
+    include ReportsHelper
+
+    def index
+      @report_options = report_options(params)
+      collector = ActiveRecordProfiler::Collector.new
+      @totals = collector.aggregate(:prefix => @report_options[:date])
+      @top_locations = collector.sorted_locations(@report_options[:sort], 
+          @report_options[:max_rows])
+      top_item = @totals[@top_locations.first]
+      @max_bar_value = bar_value(@report_options[:sort], top_item)
+    end
+
+    private
+      def report_options(page_params)
+        options = page_params.reverse_merge(
+            :date => Time.now.strftime(Collector::DATE_FORMAT),
+            :sort => Collector::DURATION,
+            :max_rows => 100
+        )
+        
+        options[:sort] = options[:sort].to_i
+        options[:max_rows] = options[:max_rows].to_i
+        options[:link_location] = ActiveRecordProfiler.link_location
+
+        return options
+      end
+  end
+end

data/app/helpers/active_record_profiler/reports_helper.rb

@@ -0,0 +1,27 @@
+module ActiveRecordProfiler
+  module ReportsHelper
+    def report_column_header_link(column_id, sort_by, label, page_params)
+      link_to_unless(sort_by == column_id, 
+        label, 
+        page_params.merge(:sort => column_id)
+      )
+    end
+
+    def bar_value(sort, item)
+      return 0 unless item && sort
+      if sort == ActiveRecordProfiler::Collector::AVG_DURATION
+        item[Collector::DURATION] / item[Collector::COUNT]
+      else
+        item[sort]
+      end
+    end
+
+    def breakable_path(path)
+      h(path).gsub('/', "​/")
+    end
+
+    def location_description(path, line_number)
+      "#{breakable_path(path)}: #{h(line_number)}".html_safe
+    end
+  end
+end

data/app/views/active_record_profiler/reports/_date_filter_form.html.erb

@@ -0,0 +1,6 @@
+<form>
+  <%= hidden_field_tag :sort, @report_options[:sort] %>
+  <label for="profiler_date">Filter by date-hour prefix (yyyy-mm-dd-hh):</label>
+  <%= text_field_tag :date, @report_options[:date], {:size =>10, :id => :profiler_date} %>
+  <input name="commit" type="submit" value="Go">
+</form>

data/app/views/active_record_profiler/reports/_local_path_form.html.erb

@@ -0,0 +1,11 @@
+<form>
+  <label for="source_root">Local source path (for location links):</label>
+  <input id="source_root" name="source_root" size="50" type="text" value="<%= Rails.root %>">
+  <br />
+  <label for="source_root">Editor (for location links):</label>
+  <select id="source_editor">
+    <option value="">None</option>
+    <option value="subl">Sublime Text</option>
+    <option value="txmt">TextMate</option>
+  </select>
+</form>

data/app/views/active_record_profiler/reports/_report_table.html.erb

@@ -0,0 +1,51 @@
+<table class="profiler-report">
+  <thead>
+    <tr>
+      <th class="location">Location</th>
+      <th class="duration">
+        <%= report_column_header_link(ActiveRecordProfiler::Collector::DURATION, @report_options[:sort], 'Total Duration (s)', params) %>
+      </th>
+      <th class="count">
+        <%= report_column_header_link(ActiveRecordProfiler::Collector::COUNT, @report_options[:sort], 'Count', params) %>
+      </th>
+      <th class="average-duration">
+        <%= report_column_header_link(ActiveRecordProfiler::Collector::AVG_DURATION, @report_options[:sort], 'Avg. Duration (ms)', params) %>
+      </th>
+      <th class="max-duration">
+        <%= report_column_header_link(ActiveRecordProfiler::Collector::LONGEST, @report_options[:sort], 'Max. Duration (ms)', params) %>          
+      </th>
+      <th class="max-duration-sql">SQL for Max Duration</th>
+    </tr>
+  </thead>
+  <tbody>
+  <% @top_locations.each do |location| -%>
+    <tr>
+      <% 
+        item = @totals[location]
+        path, line_number, method = location.split(':') 
+        this_bar = bar_value(@report_options[:sort], item)
+        bar_width = 100 * this_bar / @max_bar_value
+      -%>
+      <td title="<%= location %>">
+        <%= link_to_if(@report_options[:link_location], location_description(path, line_number), "#", :class => 'source-link', :data => {file: path, line: line_number}) %>
+        <div class="rank-bar" style="width:<%= bar_width %>%"></div>
+      </td>
+      <td class="numeric">
+        <%= number_with_precision(item[ActiveRecordProfiler::Collector::DURATION], :precision => 3) %>
+      </td>
+      <td class="numeric">
+        <%= number_with_delimiter(item[ActiveRecordProfiler::Collector::COUNT]) %>
+      </td>
+      <td class="numeric">
+        <%= number_with_precision(item[ActiveRecordProfiler::Collector::DURATION] / item[ActiveRecordProfiler::Collector::COUNT] * 1000, :precision => 3) %>
+      </td>
+      <td class="numeric">
+        <%= number_with_precision(item[ActiveRecordProfiler::Collector::LONGEST] * 1000, :precision => 3) %>
+      </td>
+      <td class="sql">
+        <%= item[ActiveRecordProfiler::Collector::LONGEST_SQL] %>
+      </td>
+    </tr>
+  <% end -%>
+  </tbody>
+</table>

data/app/views/active_record_profiler/reports/index.html.erb

@@ -0,0 +1,7 @@
+<h1>Active Record Profiler Report</h1>
+
+<div id="profiler">
+  <%= render "date_filter_form" %>
+  <%= render "local_path_form" %>
+  <%= render "report_table" %>
+</div>

data/app/views/layouts/active_record_profiler/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>ActiveRecordProfiler</title>
+  <%= stylesheet_link_tag    "active_record_profiler/application", media: "all" %>
+  <%= javascript_include_tag "active_record_profiler/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/initializers/default_config.rb

@@ -0,0 +1,8 @@
+ActiveRecordProfiler.stats_flush_period = 1.hour
+ActiveRecordProfiler.profile_dir = Rails.root.join("log", "profiler_data")
+ActiveRecordProfiler.sql_ignore_pattern = 
+  /^(SHOW (:?FULL )?FIELDS |SET SQL_AUTO_IS_NULL|SET NAMES |EXPLAIN |BEGIN|COMMIT|PRAGMA )/i
+ActiveRecordProfiler.app_path_pattern = Regexp.new(Regexp.quote("#{Rails.root.expand_path}/") + "(:?app|lib|vendor)/")
+ActiveRecordProfiler.trim_root_path = "#{Rails.root.expand_path}/"
+ActiveRecordProfiler.profile_self = false
+ActiveRecordProfiler.link_location = false

data/config/routes.rb

@@ -0,0 +1,3 @@
+ActiveRecordProfiler::Engine.routes.draw do
+  get "/" => "reports#index"
+end

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

@@ -27,7 +27,6 @@ module ActiveRecordProfiler
     # You can control the (approximate) frequency of statistics flushes by setting
     # ActiveRecordProfiler::Collector.stats_flush_period = 1.hour
     cattr_accessor :stats_flush_period
-    self.stats_flush_period = 1.hour
     
     # Directory where profile data is recorded
     cattr_accessor :profile_dir
@@ -35,19 +34,23 @@ module ActiveRecordProfiler
     # Any SQL statements matching this pattern will not be tracked by the profiler output
     # (though it will still appear in the enhanced SQL logging).
     cattr_accessor :sql_ignore_pattern
-    self.sql_ignore_pattern = /^(SHOW FIELDS |SET SQL_AUTO_IS_NULL|SET NAMES |EXPLAIN |BEGIN|COMMIT|PRAGMA )/i
     
+    # Any locations matching this pattern will be considered part of the 
+    # application. Any locations NOT matching will be lumped under a single
+    # 'Non-application code' entry.
     cattr_accessor :app_path_pattern
-    self.app_path_pattern = Regexp.new(Regexp.quote("/app/"))
     
+    # This prefix will be removed from location names, for brevity.
     cattr_accessor :trim_root_path
     
+    # Controls whether or not to record profiling data for time spent in the
+    # profiler code itself.
+    cattr_accessor :profile_self
+
+    # Obsolete, but still referenced
     cattr_accessor :storage_backend
     self.storage_backend = :json
     
-    cattr_accessor :profile_self
-    self.profile_self = false
-
     attr_accessor :last_stats_flush
     attr_accessor :query_sites
     attr_accessor :profile_data_directory

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

@@ -0,0 +1,19 @@
+module ActiveRecordProfiler
+  class Engine < ::Rails::Engine
+    isolate_namespace ActiveRecordProfiler
+
+    rake_tasks do
+      load 'active-record-profiler/tasks.rake'
+    end
+
+    initializer "active_record_profiler.apply_default" do
+      # Copy module settings to collector class
+      [:stats_flush_period, :profile_dir, :sql_ignore_pattern, 
+          :app_path_pattern, :trim_root_path, :profile_self
+      ].each do |config_item|
+        ActiveRecordProfiler::Collector.send("#{config_item}=".to_sym, 
+            ActiveRecordProfiler.send(config_item))
+      end
+    end
+  end
+end

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

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

data/lib/active-record-profiler.rb

@@ -2,12 +2,13 @@ require 'active-record-profiler/version'
 require 'active-record-profiler/collector'
 require 'active-record-profiler/log_subscriber'
 require 'active-record-profiler/logger'
-require 'active-record-profiler/profiler_view_helper'
-
-require 'active-record-profiler/railtie' if defined?(Rails)
+require "active-record-profiler/engine" if defined?(Rails)
 
 module ActiveRecordProfiler
   require 'fileutils'
   require 'json'
+  
+  mattr_accessor :link_location, :stats_flush_period, :profile_dir, 
+      :sql_ignore_pattern, :app_path_pattern, :trim_root_path, :profile_self
 end
 

data/test/dummy/config/routes.rb

@@ -1,56 +1,3 @@
 Rails.application.routes.draw do
-  # The priority is based upon order of creation: first created -> highest priority.
-  # See how all your routes lay out with "rake routes".
-
-  # You can have the root of your site routed with "root"
   root 'profiler#index'
-
-  # Example of regular route:
-  #   get 'products/:id' => 'catalog#view'
-
-  # Example of named route that can be invoked with purchase_url(id: product.id)
-  #   get 'products/:id/purchase' => 'catalog#purchase', as: :purchase
-
-  # Example resource route (maps HTTP verbs to controller actions automatically):
-  #   resources :products
-
-  # Example resource route with options:
-  #   resources :products do
-  #     member do
-  #       get 'short'
-  #       post 'toggle'
-  #     end
-  #
-  #     collection do
-  #       get 'sold'
-  #     end
-  #   end
-
-  # Example resource route with sub-resources:
-  #   resources :products do
-  #     resources :comments, :sales
-  #     resource :seller
-  #   end
-
-  # Example resource route with more complex sub-resources:
-  #   resources :products do
-  #     resources :comments
-  #     resources :sales do
-  #       get 'recent', on: :collection
-  #     end
-  #   end
-
-  # Example resource route with concerns:
-  #   concern :toggleable do
-  #     post 'toggle'
-  #   end
-  #   resources :posts, concerns: :toggleable
-  #   resources :photos, concerns: :toggleable
-
-  # Example resource route within a namespace:
-  #   namespace :admin do
-  #     # Directs /admin/products/* to Admin::ProductsController
-  #     # (app/controllers/admin/products_controller.rb)
-  #     resources :products
-  #   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active-record-profiler
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '1.0'
 platform: ruby
 authors:
 - Ben Turner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-22 00:00:00.000000000 Z
+date: 2015-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -96,14 +110,28 @@ files:
 - README.md
 - Rakefile
 - active-record-profiler.gemspec
+- app/assets/javascripts/active_record_profiler/application.js
+- app/assets/javascripts/active_record_profiler/profiler.js
+- app/assets/stylesheets/active_record_profiler/application.css
+- app/controllers/active_record_profiler/application_controller.rb
+- app/controllers/active_record_profiler/reports_controller.rb
+- app/helpers/active_record_profiler/reports_helper.rb
+- app/views/active_record_profiler/reports/_date_filter_form.html.erb
+- app/views/active_record_profiler/reports/_local_path_form.html.erb
+- app/views/active_record_profiler/reports/_report_table.html.erb
+- app/views/active_record_profiler/reports/index.html.erb
+- app/views/layouts/active_record_profiler/application.html.erb
+- config/initializers/default_config.rb
+- config/routes.rb
 - lib/active-record-profiler.rb
 - lib/active-record-profiler/collector.rb
+- lib/active-record-profiler/engine.rb
 - lib/active-record-profiler/log_subscriber.rb
 - lib/active-record-profiler/logger.rb
-- lib/active-record-profiler/profiler_view_helper.rb
-- lib/active-record-profiler/railtie.rb
 - lib/active-record-profiler/tasks.rake
 - lib/active-record-profiler/version.rb
+- screenshots/enhanced-log.png
+- screenshots/web-reports.png
 - test/active_record_profiler_test.rb
 - test/database.yml
 - test/dummy/README.rdoc

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

@@ -1,200 +0,0 @@
-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

@@ -1,18 +0,0 @@
-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