rails_metrics 0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+== 0.1
+
+* First release of RailsMetrics by José Valim. It includes generators for bootstrap, stores instrumentations using a in process Queue and works as engine allowing you to see your metrics. The only ORM supported so far is ActiveRecord.

data/Gemfile

@@ -0,0 +1,9 @@
+source :gemcutter
+
+gem "rails",  "3.0.0.beta"
+gem "mysql",  "2.7"
+gem "webrat", "0.7.0"
+
+if RUBY_VERSION < '1.9'
+  gem "ruby-debug", ">= 0.10.3"
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2010 Engine Yard. http://www.engineyard.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,58 @@
+== RailsMetrics
+
+RailsMetrics is an engine that hooks into your application to listen ActiveSupport::Notifications and show you statistics about them. RailsMetrics uses threads to save those notifications in the database through an in-process Queue. You can see charts based on each request and see what queries, actions, templates rendering, etc. are slow.
+
+So far RailsMetrics supports only ActiveRecord as ORM but adding other datastore should be easy (take a look at lib/rails_metrics/orm/active_record.rb). Due to the threaded behavior in RailsMetrics, you cannot use SQLite as database, however MySQL and PostgreSQL work fine.
+
+There's an example application at http://github.com/engineyard/rails_metrics_example .
+
+== Installation
+
+Installing RailsMetrics is simple. Since it's a Rails::Engine, you need to install it as gem:
+
+  gem install rails_metrics
+
+Then add it to your gemfile. So far, I recommend you to install it only on development:
+
+  group :development do
+    gem "rails_metrics"
+  end
+
+Finally, create your model using the built-in generator:
+
+  rails g rails_metrics Metric
+
+You can choose another name than Metric as your rails metrics store. Run the created migration, restart your server and now you should be able to access "/rails_metrics". Navigate on your application and head back to "/rails_metrics" to see the stored data.
+
+== Configuration
+
+There are three parameters you can add to your application to configure RailsMetrics. The first one is to set the RailsMetrics store, which is done automatically when you use the generator:
+
+  config.rails_metrics.set_store = lambda { ::Metric }
+
+The other parameters allows you to ignore an specific notification, based on a given block
+or on its name. Let's suppose you have a plugin in your application which is yielding an useless notification. You can silence it by doing:
+
+  config.rails_metrics.ignore_patterns << /verbose_plugin/
+
+If you need to ignore a notification based on its payload, it's also easy:
+
+  config.rails_metrics.ignore_lambdas[:verbose_plugin] = lambda { |name, payload|
+    payload[:some_value] =~ /some_expression/
+  }
+
+== TODO
+
+Please refer to TODO file.
+
+== Maintainers
+
+* José Valim (http://github.com/josevalim)
+
+== Bugs and Feedback
+
+If you discover any bugs or want to drop a line, feel free to create an issue on GitHub.
+
+http://github.com/engineyard/rails_metrics/issues
+
+MIT License. Copyright 2010 Engine Yard. http://www.engineyard.com

data/Rakefile

@@ -0,0 +1,58 @@
+# encoding: UTF-8
+
+require "rake"
+require "rake/testtask"
+require "rake/rdoctask"
+require "fileutils"
+require File.expand_path("../lib/rails_metrics/version", __FILE__)
+
+desc "Default: run unit tests"
+task :default => :test
+
+desc "Prepare environment for tests"
+task :prepare do
+  FileUtils.cd File.expand_path("../test/dummy", __FILE__)
+  system("rake db:create:all")
+  system("rake db:migrate")
+  system("rake db:test:clone")
+end
+
+desc "Start the server for the dummy application used in tests"
+task :server do
+  exec("test/dummy/script/rails server")
+end
+
+desc "Test RailsMetrics"
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+
+desc "Generate documentation for RailsMetrics"
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "RailsMetrics"
+  rdoc.options << "--line-numbers" << "--inline-source"
+  rdoc.rdoc_files.include("README.rdoc")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |s|
+    s.name = "rails_metrics"
+    s.version = RailsMetrics::VERSION
+    s.summary = "Metrics measurement for your app on top of ActiveSupport::Notifications"
+    s.email = "contact@engineyard.com"
+    s.homepage = "http://github.com/engineyard"
+    s.description = "Metrics measurement for your app on top of ActiveSupport::Notifications"
+    s.authors = ["José Valim"]
+    s.files =  FileList["[A-Z]*", "{app,config,lib,public}/**/*"]
+    s.files.exclude("public/javascripts/rails_metrics.js")
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
+end

data/TODO.rdoc

@@ -0,0 +1 @@
+* Allow to set the maximum number of requests to store

data/app/controllers/rails_metrics_controller.rb

@@ -0,0 +1,78 @@
+class RailsMetricsController < ApplicationController
+  respond_to :html
+
+  # GET /rails_metrics
+  def index
+    @metrics = order_scopes(RailsMetrics.store.requests)
+    @metrics_count = @metrics.count
+    @metrics = with_pagination(@metrics)
+    respond_with(@metrics)
+  end
+
+  # GET /rails_metrics/1/chart
+  def chart
+    @metrics = RailsMetrics.store.earliest.by_request_id(params[:id]).all
+    @request = RailsMetrics.store.mount_tree(@metrics.reverse)
+    respond_with(@metrics)
+  end
+
+  # GET /rails_metrics
+  def all
+    @metrics = all_scopes(RailsMetrics.store)
+    @metrics_count = @metrics.count
+    @metrics = with_pagination(@metrics)
+    respond_with(@metrics)
+  end
+
+  # GET /rails_metrics/1
+  def show
+    @metric = find_store(params[:id])
+    respond_with(@metric)
+  end
+
+  # DELETE /rails_metrics/1
+  def destroy
+    @metric = find_store(params[:id])
+    @metric.destroy
+    flash[:notice] = "Metric ##{@metric.id} was deleted with success."
+    respond_with(@metric, :location => rails_metrics_path)
+  end
+
+  # DELETE /rails_metrics/destroy_all
+  def destroy_all
+    count = all_scopes(RailsMetrics.store).delete_all
+    flash[:notice] = "All #{count} selected metrics were deleted."
+    redirect_to rails_metrics_path
+  end
+
+  protected
+
+  def with_pagination(scope)
+    @limit  = (params[:limit].presence || 50).to_i
+    @offset = (params[:offset].presence || 0).to_i
+    scope.limit(@limit).offset(@offset).all
+  end
+
+  def by_scopes(store)
+    @by_name = params[:by_name].presence
+    store = store.by_name(@by_name) if @by_name
+    store
+  end
+
+  def order_scopes(store)
+    @order_by = (valid_order_by? ? params[:order_by] : :latest).to_sym
+    store = store.send(@order_by)
+  end
+
+  def all_scopes(store)
+    order_scopes(by_scopes(store))
+  end
+
+  def valid_order_by?
+    RailsMetrics::Store::VALID_ORDERS.include?(params[:order_by]) 
+  end
+
+  def find_store(id)
+    RailsMetrics.store.find(id)
+  end
+end

data/app/helpers/rails_metrics_helper.rb

@@ -0,0 +1,161 @@
+module RailsMetricsHelper
+  module Pagination
+    # Returns information about pagination
+    def pagination_info
+      maximum = [@metrics_count, @offset + @limit].min
+      "#{@offset + 1} - #{maximum} of #{@metrics_count}"
+    end
+
+    # Shows per page links
+    def show_per_page(values)
+      values.map do |i|
+        link_to_unless(@limit == i, i.to_s, url_for(params.merge(:limit => i)))
+      end.join(" | ").html_safe
+    end
+
+    # Shows previous link for pagination
+    def previous_link
+      link = url_for(params.merge(:offset => [0, @offset - @limit].max))
+      link_to_if(@offset > 0, "Previous", link)
+    end
+
+    # Show next link for pagination
+    def next_link
+      link = url_for(params.merge(:offset => @offset + @limit))
+      link_to_if(@offset + @limit < @metrics_count, "Next", link)
+    end
+
+    # Add pagination to footlinks
+    def paginate!
+      content_for :rails_metrics_footlinks do
+        content_tag(:p, [previous_link, pagination_info, next_link].join(" | ")) <<
+        content_tag(:p, "Show per page: #{show_per_page [10, 25, 50, 100]}")
+      end
+    end
+  end
+
+  module PayloadInspect
+    # Inspect payload to show more human readable information.
+    def payload_inspect(hash)
+      hash = hash.sort {|a,b| a[0].to_s <=> b[0].to_s }
+      content = []
+
+      hash.each do |key, value|
+        content << (content_tag(:b, key.to_s.humanize).safe_concat("<br />") << pretty_inspect(value))
+      end
+
+      content.map!{ |c| content_tag(:p, c) }
+      content.join("\n").html_safe
+    end
+
+    # Inspect a value using a more readable format.
+    def pretty_inspect(object)
+      case object
+        when String
+          object
+        when Array
+          "[#{object.map(&:inspect).join(", ")}]"
+        when Hash
+          hash = object.map { |k,v| "  #{k.inspect} => #{pretty_inspect(v)}" }.join(",\n")
+          if object.size == 1
+            "{ #{hash[2..-1]} }"
+          else
+            "{\n#{hash}\n}"
+          end
+        else
+          object.inspect
+      end
+    end
+  end
+
+  module Scoping
+    # Returns information about scope
+    def scopes_info
+      filters = []
+      filters << "name" if @by_name
+      filters.map!{ |i| content_tag(:b, i) }
+
+      content = []
+      content << "filtered by #{filters.to_sentence}" unless filters.empty?
+      content << "ordered by <b>#{@order_by.to_s.humanize.downcase}</b>"
+      content.to_sentence.html_safe
+    end
+
+    # Link to set a by_scope using the given content. If no value is given,
+    # the content is used as link value as well.
+    def link_to_set_by_scope(metric, what)
+      value = metric.send(what)
+      return value if instance_variable_get(:"@by_#{what}")
+      link_to value, url_for_scope(:"by_#{what}" => value, :action => "all"), :title => value
+    end
+
+    # Link to clear a by_scope using a cancel image.
+    def link_to_clear_by_scope(what)
+      return unless instance_variable_get(:"@by_#{what}")
+      link_to_set_scope_with_image("rails_metrics/cancel.png",
+        "Remove #{what.to_s.humanize.inspect} filter", :"by_#{what}" => nil)
+    end
+
+    # Link to order by scopes by using two arrows, one up and other down
+    def link_to_order_by_scopes(up, down)
+      link_to_set_scope_with_image("rails_metrics/arrow_up.png", "Order by #{up}", :order_by => up) <<
+        link_to_set_scope_with_image("rails_metrics/arrow_down.png", "Order by #{down}", :order_by => down)
+    end
+
+  protected
+
+    def url_for_scope(hash) #:nodoc:
+      url_for(params.except(:limit, :offset, :id).merge!(hash))
+    end
+
+    def link_to_set_scope_with_image(src, title, scope) #:nodoc:
+      image = image_tag(src, :title => title, :alt => title)
+      link  = url_for_scope(scope)
+      link_to image, link, :title => title
+    end
+  end
+
+  module Links
+    # Links to image inside rails_metrics if the given path it's not the current page using the given title.
+    def link_to_image_unless_current(icon, path, title)
+      return if current_page?(path)
+      image = image_tag("rails_metrics/#{icon}.png", :title => title, :alt => title)
+      link_to image, path, :title => title
+    end
+
+    # Add action icons to the current page.
+    def add_action_links!(metric)
+      concat link_to_image_unless_current(:chart_pie, chart_rails_metric_path(metric.request_id), "Chart")
+      concat link_to_image_unless_current(:page_white_go, rails_metric_path(metric), "Show")
+      form_tag(rails_metric_path(metric), :method => :delete) do
+        image_submit_tag "rails_metrics/page_white_delete.png", :onclick => "return confirm('Are you sure?')", :alt => "Delete", :title => "Delete"
+      end
+    end
+
+    def nagivation_links
+      @navigation_links ||= begin
+        links = []
+        links << link_to("All metrics", all_rails_metrics_path)
+        links << link_to("Requests", rails_metrics_path)
+        links << link_to("Back", :back)
+        links.join(" | ").html_safe
+      end
+    end
+  end
+
+  include Pagination
+  include PayloadInspect
+  include Scoping
+  include Links
+
+  # Returns pagination and scopes information
+  def pagination_and_scopes_info(countable)
+    countable = countable.to_s.pluralize unless @metrics_count == 1
+    "Showing #{pagination_info} #{countable} ".html_safe << scopes_info
+  end
+
+  # Create a table row using rails_metrics_#{id} as row id and odd and even as classes.
+  def rails_metrics_table_row_for(metric, &block)
+    content_tag(:tr, :id => "rails_metric_#{metric.id}", :class => cycle("odd", "even"), &block)
+  end
+end

data/app/views/layouts/rails_metrics.html.erb

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>RailsMetrics: <%= controller.action_name %></title>
+  <%= stylesheet_link_tag 'rails_metrics' %>
+  <%= javascript_include_tag 'rails_metrics/raphael-min', 'rails_metrics/g.raphael-min', 'rails_metrics/g.pie-min', :cache => "rails_metrics" %>
+</head>
+<body>
+  <%= content_tag(:div, content_tag(:p, notice), :class => :notice) if notice.present? %>
+  <div id="rails_metrics_header">
+    <h1><%= link_to "RailsMetrics", rails_metrics_path %></h1>
+    <div><%= yield :rails_metrics_header %></div>
+    <p><%= nagivation_links %></p>
+  </div>
+  <%= yield %>
+  <div id="rails_metrics_footlinks">
+    <%= yield :rails_metrics_footlinks %>
+    <p><%= nagivation_links %></p>
+  </div>
+</body>
+</html>

data/app/views/rails_metrics/_request.html.erb

@@ -0,0 +1,21 @@
+<% rails_metrics_table_row_for metric do %>
+  <td class="when">
+    <%= metric.started_at.strftime("%d %b %H:%M:%S") %>
+  </td>
+
+  <td class="method">
+    <%= metric.payload[:method] %>
+  </td>
+
+  <td class="path">
+    <%= metric.payload[:path] %>
+  </td>
+
+  <td class="duration">
+    <%= "%.1f" % metric.duration_in_ms %> ms
+  </td>
+
+  <td class="actions">
+    <% add_action_links!(metric) %>
+  </td>
+<% end %>

data/app/views/rails_metrics/_row.html.erb

@@ -0,0 +1,23 @@
+<% rails_metrics_table_row_for metric do %>
+  <% unless (skip_timestamps ||= false) %>
+    <td class="started_at">
+      <%= metric.started_at.strftime("%d %b %H:%M:%S") %>
+    </td>
+  <% end %>
+
+  <td class="name">
+    <%= link_to_set_by_scope metric, :name %>
+  </td>
+
+  <td class="duration">
+    <%= "%.1f" % metric.duration_in_ms %> <%= "(#{"%.1f" % metric.exclusive_duration_in_ms})" if metric.children.any? %> ms
+  </td>
+
+  <td class="payload">
+    <%= payload_inspect(metric.payload) %>
+  </td>
+
+  <td class="actions">
+    <% add_action_links!(metric) %>
+  </td>
+<% end %>