rails_customerbeats 0.0.4

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+== 0.1
+
+* 

data/Gemfile

@@ -0,0 +1,10 @@
+source :gemcutter
+
+gem "rails",  "~> 3.0.0"
+gem "mysql",  "~> 2.8"
+gem "webrat", "~> 0.7.0"
+gem "jeweler"
+
+if RUBY_VERSION < '1.9'
+  gem "ruby-debug", ">= 0.10.3"
+end

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+
+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,2 @@
+== CJM
+

data/Rakefile

@@ -0,0 +1,58 @@
+# encoding: UTF-8
+
+require "rake"
+require "rake/testtask"
+require "rdoc/task"
+require "fileutils"
+require File.expand_path("../lib/rails_customerbeat/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"
+RDoc::Task.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_customerbeat"
+    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_customerbeat.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 @@
+*

data/app/controllers/rails_customerbeats_controller.rb

@@ -0,0 +1,82 @@
+class RailsCustomerbeatsController < ApplicationController
+  respond_to :html
+
+  # GET /rails_customerbeats
+  def index
+    @metrics = order_scopes(RailsCustomerbeats.store.requests)
+    @metrics_count = @metrics.count
+    @metrics = with_pagination(@metrics)
+    respond_with(@metrics)
+  end
+
+  # GET /rails_customerbeats/1/chart
+  def chart
+    @metrics = RailsCustomerbeats.store.earliest.by_request_id(params[:id]).all
+    @request = RailsCustomerbeats.store.mount_tree(@metrics.reverse)
+    respond_with(@metrics)
+  end
+
+  # GET /rails_customerbeats
+  def all
+    @metrics = all_scopes(RailsCustomerbeats.store)
+    @metrics_count = @metrics.count
+    @metrics = with_pagination(@metrics)
+    respond_with(@metrics)
+  end
+
+  # GET /rails_customerbeats/1
+  def show
+    @metric = find_store(params[:id])
+    respond_with(@metric)
+  end
+
+  # DELETE /rails_customerbeats/1
+  def destroy
+    @metric = find_store(params[:id])
+    @metric.destroy
+    flash[:notice] = "Metric ##{@metric.id} was deleted with success."
+    respond_with(@metric, :location => rails_customerbeats_path)
+  end
+
+  # DELETE /rails_customerbeats/destroy_all
+  def destroy_all
+    count = all_scopes(RailsCustomerbeats.store).send(RailsCustomerbeats::ORM.delete_all)
+    flash[:notice] = "All #{count} selected metrics were deleted."
+    redirect_to rails_customerbeats_path
+  end
+
+  protected
+
+  def with_pagination(scope)
+    @limit  = (params[:limit].presence || 50).to_i
+    @offset = (params[:offset].presence || 0).to_i
+    if scope.respond_to?(:limit)
+      scope.limit(@limit).offset(@offset).all
+    else
+      scope.all(:limit => @limit, :offset => @offset)
+    end
+  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?
+    RailsCustomerbeats::Store::VALID_ORDERS.include?(params[:order_by]) 
+  end
+
+  def find_store(id)
+    RailsCustomerbeats.store.send(RailsCustomerbeats::ORM.primary_key_finder, id)
+  end
+end

data/app/helpers/rails_customerbeats_helper.rb

@@ -0,0 +1,164 @@
+module RailsCustomerbeatsHelper
+  
+
+  
+  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_customerbeats_footlinks do
+        content_tag(:p, [previous_link, pagination_info, next_link].join(" | "),nil,false) <<
+        content_tag(:p, "Show per page: #{show_per_page([10, 25, 50, 100])}",nil,false)
+      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_customerbeats/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("images/r_metrics/arrow_up.png", "Order by #{up}", :order_by => up) <<
+        link_to_set_scope_with_image("images/r_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_customerbeats 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("images/r_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_customerbeat_path(metric.request_id), "Chart")
+      concat link_to_image_unless_current(:page_white_go, rails_customerbeat_path(metric), "Show")
+      form_tag(rails_customerbeat_path(metric), :method => :delete) do
+        image_submit_tag "images/r_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_customerbeats_path)
+        links << link_to("Requests", rails_customerbeats_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_customerbeats_#{id} as row id and odd and even as classes.
+  def rails_customerbeats_table_row_for(metric, &block)
+    content_tag(:tr, :id => "rails_customerbeat_#{metric.id}", :class => cycle("odd", "even"), &block)
+  end
+end

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

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>RailsCustomerbeats: <%= controller.action_name %></title>
+  <%= stylesheet_link_tag 'stylesheets/r_metrics' %>
+  <%= javascript_include_tag 'javascripts/r_metrics/raphael-min', 'javascripts/r_metrics/g.raphael-min', 'javascripts/r_metrics/g.pie-min'%>
+</head>
+<body>
+  <%= content_tag(:div, content_tag(:p, notice), :class => :notice) if notice.present? %>
+  <div id="rails_customerbeats_header">
+    <h1><%= link_to "RailsCustomerbeats", rails_customerbeats_path %></h1>
+    <div><%= yield :rails_customerbeats_header %></div>
+    <p><%= nagivation_links %></p>
+  </div>
+  <%= yield %>
+  <div id="rails_customerbeats_footlinks">
+    <%= yield :rails_customerbeats_footlinks %>
+    <p><%= nagivation_links %></p>
+  </div>
+</body>
+</html>

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

@@ -0,0 +1,21 @@
+<%= rails_customerbeats_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_customerbeats/_row.html.erb

@@ -0,0 +1,28 @@
+<%= rails_customerbeats_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="Id">
+    <%= metric.request_id %>
+  </td>
+
+  <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 %>

data/app/views/rails_customerbeats/all.html.erb

@@ -0,0 +1,26 @@
+<% if @metrics.empty? %>
+  <h2>No metrics so far, navigate on your app and come back.</h2>
+<% else %>
+  <% content_for(:rails_customerbeats_header) do %>
+    <%= pagination_and_scopes_info(:metrics) %>
+
+    <%= form_tag url_for(params.merge(:action => "destroy_all")), :method => :delete do %>
+      <%= submit_tag "Delete all", :onclick => "return confirm('Are you sure you want to delete those #{@metrics_count} metrics?')" %>
+    <% end %>
+  <% end %>
+
+  <table id="rails_customerbeats_table" class="all">
+    <tr>
+      <th>When<br /><%= link_to_order_by_scopes(:earliest, :latest) %></th>
+      <th>Id</th>
+      <th>Name<br /><%= link_to_clear_by_scope(:name) %></th>
+      <th>Duration<br /><%= link_to_order_by_scopes(:slowest, :fastest) %></th>
+      <th>Payload</th>
+      <th></th>
+    </tr>
+
+    <%= render :partial => "row", :collection => @metrics, :as => :metric %>
+  </table>
+
+  <% paginate! %>
+<% end %>

data/app/views/rails_customerbeats/chart.html.erb

@@ -0,0 +1,49 @@
+<% content_for(:rails_customerbeats_header) do %>
+  Showing request #<%= @request.id %>
+  <div class="actions"><% add_action_links!(@request) %></div>
+<% end %>
+
+<div id="chart_container">
+  <div id="chart"></div>
+</div>
+
+<script type="text/javascript" charset="utf-8"> 
+  var r = Raphael("chart");
+  r.g.text(400, 30, "<%= @request.payload[:method] %> <%= @request.payload[:path] %> at <%= @request.started_at.strftime("%d %b %H:%M:%S") %>").attr({"font-size": 20});
+
+  var pie = r.g.piechart(250, 150, 100,
+    <%=raw @metrics.map { |m| m.exclusive_duration_in_ms }.inspect %>, {
+      legend: <%=raw @metrics.map { |m| "##.# ms - #{m.name}" }.inspect %>,
+      href: <%=raw @metrics.map { |m| "#rails_customerbeats_#{m.id}" }.inspect %>,
+      cut: 0
+    }
+  );
+
+  pie.hover(function () {
+    this.sector.stop();
+    this.sector.scale(1.1, 1.1, this.cx, this.cy);
+    if (this.label) {
+      this.label[0].stop();
+      this.label[0].scale(1.5);
+      this.label[1].attr({"font-weight": 800});
+    }
+  }, function () {
+    this.sector.animate({scale: [1, 1, this.cx, this.cy]}, 500, "bounce");
+    if (this.label) {
+      this.label[0].animate({scale: 1}, 500, "bounce");
+      this.label[1].attr({"font-weight": 400});
+    }
+  });
+</script>
+
+<table id="rails_customerbeats_table" class="chart">
+  <tr>
+    <th>Name</th>
+    <th>Duration (exclusive)</th>
+    <th>Payload</th>
+    <th></th>
+  </tr>
+
+  <%= render :partial => "row", :collection => @metrics, :as => :metric,
+    :locals => { :skip_timestamps => true } %>
+</table>

data/app/views/rails_customerbeats/index.html.erb

@@ -0,0 +1,21 @@
+<% if @metrics.empty? %>
+  <h2>No requests so far, navigate on your app and come back.</h2>
+<% else %>
+  <% content_for(:rails_customerbeats_header) do %>
+    <%= pagination_and_scopes_info(:requests) %>
+  <% end %>
+
+  <table id="rails_customerbeats_table" class="requests">
+    <tr>
+      <th>When<br /><%= link_to_order_by_scopes(:earliest, :latest) %></th>
+      <th>Method</th>
+      <th>Path</th>
+      <th>Duration<br /><%= link_to_order_by_scopes(:slowest, :fastest) %></th>
+      <th></th>
+    </tr>
+
+    <%= render :partial => "request", :collection => @metrics, :as => :metric %>
+  </table>
+
+  <% paginate! %>
+<% end %>

data/app/views/rails_customerbeats/show.html.erb

@@ -0,0 +1,41 @@
+<% content_for(:rails_customerbeats_header) do %>
+  Showing metric #<%= @metric.id %>
+  <div class="actions"><% add_action_links!(@metric) %></div>
+<% end %>
+
+<table id="rails_customerbeats_table" class="show">
+  <tr>
+    <th>Key</th>
+    <th>Value</th>
+  </tr>
+
+  <tr class="odd">
+    <td>Name</td>
+    <td><%= link_to_set_by_scope @metric, :name %></td>
+  </tr>
+
+  <tr class="even">
+    <td>Request</td>
+    <td><%= link_to @metric.request_id, chart_rails_customerbeat_path(@metric.request_id) %></td>
+  </tr>
+
+  <tr class="odd">
+    <td>Duration</td>
+    <td><%= @metric.duration_in_ms %> ms</td>
+  </tr>
+
+  <tr class="even">
+    <td>Payload</td>
+    <td class="payload"><%= payload_inspect(@metric.payload) %></td>
+  </tr>
+
+  <tr class="odd">
+    <td>Started at</td>
+    <td><%= @metric.started_at %></td>
+  </tr>
+
+  <tr class="even">
+    <td>Created at</td>
+    <td><%= @metric.created_at %></td>
+  </tr>
+</table>

data/config/routes.rb

@@ -0,0 +1,10 @@
+Rails.application.routes.draw do
+  resources :rails_customerbeats, :only => [:index, :show, :destroy] do
+    collection do
+      get :all
+      delete :destroy_all
+    end
+
+    get :chart, :on => :member
+  end
+end

data/lib/generators/rails_customerbeats_generator.rb

@@ -0,0 +1,33 @@
+class RailsCustomerbeatsGenerator < Rails::Generators::NamedBase
+  class_option :migration, :type => :boolean, :default => true
+
+  class_option :update, :type => :boolean, :default => false,
+                        :desc => "Just update public files, do not create a model"
+
+  def self.source_root
+    @_metrics_source_root ||= File.dirname(__FILE__)
+  end
+
+  def copy_public_files
+    directory "../../public", "public", :recursive => true
+    exit(0) if options.update?
+  end
+
+  def invoke_model
+    require "rails_customerbeats/orm/#{Rails::Generators.options[:rails][:orm]}"
+    invoke "model", [name].concat(RailsCustomerbeats::ORM.metric_model_properties),
+      :timestamps => false, :test_framework => false, :migration => options.migration?
+  end
+
+  def add_model_config
+    RailsCustomerbeats::ORM.add_metric_model_config(self, file_name, class_name)
+  end
+
+  def add_application_config
+    inject_into_class "config/application.rb", "Application", <<-CONTENT
+    # Set rails metrics store
+    config.rails_customerbeats.set_store = lambda { ::#{class_name} }
+
+CONTENT
+  end
+end

data/lib/rails_customerbeats/async_consumer.rb

@@ -0,0 +1,54 @@
+require 'thread'
+
+module RailsCustomerbeats
+  # An instrumenter that does not send notifications. This is used in the
+  # AsyncQueue so saving events does not send any notifications, not even
+  # for logging.
+  class VoidInstrumenter < ::ActiveSupport::Notifications::Instrumenter
+    def instrument(name, payload={})
+      yield(payload) if block_given?
+    end
+  end
+
+  class AsyncConsumer
+    attr_reader :thread
+
+    def initialize(queue=Queue.new, &block)
+      @off   = true
+      @block = block
+      @queue = queue
+      @mutex = Mutex.new
+
+      @thread = Thread.new do
+        set_void_instrumenter
+        consume
+      end
+    end
+
+    def push(*args)
+      @mutex.synchronize { @off = false }
+      @queue.push(*args)
+    end
+
+    def finished?
+      @off
+    end
+
+  protected
+
+    def set_void_instrumenter #:nodoc:
+      Thread.current[:"instrumentation_#{notifier.object_id}"] = VoidInstrumenter.new(notifier)
+    end
+
+    def notifier #:nodoc:
+      ActiveSupport::Notifications.notifier
+    end
+
+    def consume #:nodoc:
+      while args = @queue.shift
+        @block.call(args)
+        @mutex.synchronize { @off = @queue.empty? }
+      end
+    end
+  end
+end