system-metrics 0.1.0

data/config/routes.rb

@@ -0,0 +1,7 @@
+Rails.application.routes.draw do
+  scope '/system', :module => 'system_metrics' do
+    get 'metrics/admin' => 'metrics#admin', :as => 'system_metrics_admin'
+    get 'metrics/category/:category' => 'metrics#category', :as => 'system_metrics_category'
+    resources :metrics, :only => [:index, :show, :destroy]
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'system_metrics'

data/lib/generators/system_metrics.rb

@@ -0,0 +1,9 @@
+module Auditor
+  module Generators
+    class Base < Rails::Generators::NamedBase
+      def self.source_root
+        File.expand_path(File.join(File.dirname(__FILE__), 'system_metrics', generator_name, 'templates'))
+      end
+    end
+  end
+end

data/lib/generators/system_metrics/install/install_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+
+module SystemMetrics
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      desc "Install System Metrics public assets"
+
+      source_root File.expand_path("../../../../../public", __FILE__)
+
+      def copy_css_files
+        directory "stylesheets", "public/stylesheets/system_metrics", :recursive => true
+      end
+
+      def copy_image_files
+        directory "images", "public/images/system_metrics", :recursive => true
+      end
+
+    end
+  end
+end

data/lib/generators/system_metrics/migration/migration_generator.rb

@@ -0,0 +1,26 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module SystemMetrics
+  module Generators
+    class MigrationGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc "Create migration for System Metrics metrics table"
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def create_migration_file
+        migration_template 'migration.rb', 'db/migrate/create_metrics_table.rb'
+      end
+    end
+  end
+end

data/lib/generators/system_metrics/migration/templates/migration.rb

@@ -0,0 +1,22 @@
+class CreateMetricsTable < ActiveRecord::Migration
+  def self.up
+    create_table :system_metrics, :force => true do |t|
+      t.column :name, :string, :null => false
+      t.column :started_at, :datetime, :null => false
+      t.column :transaction_id, :string
+      t.column :payload, :text
+      t.column :duration, :float, :null => false
+      t.column :exclusive_duration, :float, :null => false
+      t.column :request_id, :integer
+      t.column :parent_id, :integer
+      t.column :action, :string, :null => false
+      t.column :category, :string, :null => false
+    end
+
+    # TODO: Add indexes
+  end
+
+  def self.down
+    drop_table :system_metrics
+  end
+end

data/lib/system-metrics.rb

@@ -0,0 +1 @@
+require 'system_metrics'

data/lib/system_metrics.rb

@@ -0,0 +1,33 @@
+module SystemMetrics
+  autoload :Collector,      'system_metrics/collector'
+  autoload :Config,         'system_metrics/config'
+  autoload :Middleware,     'system_metrics/middleware'
+  autoload :NestedEvent,    'system_metrics/nested_event'
+  autoload :Store,          'system_metrics/store'
+  autoload :Version,        'system_metrics/version'
+
+  def self.collection_on
+    Thread.current[:system_metrics_collecting] = true
+  end
+
+  def self.collection_off
+    Thread.current[:system_metrics_collecting] = false
+  end
+
+  def collecting?
+    Thread.current[:system_metrics_collecting] || false
+  end
+
+  def without_collection
+    previously_collecting = collecting?
+    SystemMetrics.collection_off
+    yield if block_given?
+  ensure
+    SystemMetrics.collection_on if previously_collecting
+  end
+
+  module_function :collecting?, :without_collection
+end
+
+require 'system_metrics/instrument'
+require 'system_metrics/engine'

data/lib/system_metrics/collector.rb

@@ -0,0 +1,32 @@
+module SystemMetrics
+  class Collector
+    attr_reader :store
+
+    def initialize(store)
+      @store = store
+    end
+
+    def collect_event(event)
+      events.push event if SystemMetrics.collecting?
+    end
+
+    def collect
+      events.clear
+      SystemMetrics.collection_on
+      result = yield
+      SystemMetrics.collection_off
+      store.save events.dup
+      result
+    ensure
+      SystemMetrics.collection_off
+      events.clear
+    end
+
+    private
+
+      def events
+        Thread.current[:system_metrics_events] ||= []
+      end
+
+  end
+end

data/lib/system_metrics/config.rb

@@ -0,0 +1,38 @@
+module SystemMetrics
+  class Config
+    attr_accessor :store, :instruments, :notification_exclude_patterns, :path_exclude_patterns
+
+    def initialize
+      self.store = SystemMetrics::Store.new
+      self.notification_exclude_patterns = []
+      self.path_exclude_patterns = [/system\/metrics/, /system_metrics/]
+      self.instruments = [
+        SystemMetrics::Instrument::ActionController.new,
+        SystemMetrics::Instrument::ActionView.new,
+        SystemMetrics::Instrument::ActiveRecord.new,
+        SystemMetrics::Instrument::Rack.new
+      ]
+    end
+
+    def valid?
+      !invalid?
+    end
+
+    def invalid?
+      store.nil? ||
+        instruments.nil? ||
+        notification_exclude_patterns.nil? ||
+        path_exclude_patterns.nil?
+    end
+
+    def errors
+      return nil if valid?
+      errors = []
+      errors << 'store cannot be nil' if store.nil?
+      errors << 'instruments cannot be nil' if instruments.nil?
+      errors << 'notification_exclude_patterns cannot be nil' if notification_exclude_patterns.nil?
+      errors << 'path_exclude_patterns cannot be nil' if path_exclude_patterns.nil?
+      errors.join("\n")
+    end
+  end
+end

data/lib/system_metrics/engine.rb

@@ -0,0 +1,43 @@
+module SystemMetrics
+  class Engine < ::Rails::Engine
+
+    attr_accessor :collector, :smc
+
+    config.system_metrics = SystemMetrics::Config.new
+
+    initializer "system_metrics.initialize" do |app|
+      self.smc = app.config.system_metrics
+      raise ArgumentError.new(smc.errors) if smc.invalid?
+      self.collector = SystemMetrics::Collector.new(smc.store)
+    end
+
+    initializer "system_metrics.start_subscriber" do |app|
+      ActiveSupport::Notifications.subscribe /^[^!]/ do |*args|
+        unless smc.notification_exclude_patterns.any? { |pattern| pattern =~ name }
+          process_event SystemMetrics::NestedEvent.new(*args)
+        end
+      end
+    end
+
+    initializer "system_metrics.add_middleware" do |app|
+      app.config.middleware.use SystemMetrics::Middleware, collector, smc.path_exclude_patterns
+    end
+
+    private
+
+      def process_event(event)
+        instrument = smc.instruments.find { |instrument| instrument.handles?(event) }
+
+        if instrument.present?
+          unless instrument.ignore?(event)
+            instrument.prepare(event)
+            collector.collect_event(event)
+          end
+        else
+          collector.collect_event(event)
+        end
+      end
+
+  end
+end
+

data/lib/system_metrics/instrument.rb

@@ -0,0 +1,10 @@
+module SystemMetrics
+  module Instrument
+    autoload :Base,               'system_metrics/instrument/base'
+    autoload :ActionController,   'system_metrics/instrument/action_controller'
+    autoload :ActionMailer,       'system_metrics/instrument/action_mailer'
+    autoload :ActionView,         'system_metrics/instrument/action_view'
+    autoload :ActiveRecord,       'system_metrics/instrument/active_record'
+    autoload :Rack,               'system_metrics/instrument/rack'
+  end
+end

data/lib/system_metrics/instrument/action_controller.rb

@@ -0,0 +1,20 @@
+module SystemMetrics
+  module Instrument
+    class ActionController < SystemMetrics::Instrument::Base
+
+      def initialize
+        super /\.action_controller$/
+      end
+
+      def ignore?(event)
+        event.name != 'process_action.action_controller'
+      end
+
+      def prepare(event)
+        event.payload[:end_point] = "#{event.payload.delete(:controller)}##{event.payload.delete(:action)}"
+        event.payload.slice!(:path, :method, :params, :db_runtime, :view_runtime, :end_point)
+      end
+
+    end
+  end
+end

data/lib/system_metrics/instrument/action_mailer.rb

@@ -0,0 +1,15 @@
+module SystemMetrics
+  module Instrument
+    class ActionMailer < SystemMetrics::Instrument::Base
+
+      def initialize
+        super /\.action_mailer$/
+      end
+
+      def prepare(event)
+        event.payload.except!(:mail)
+      end
+
+    end
+  end
+end

data/lib/system_metrics/instrument/action_view.rb

@@ -0,0 +1,23 @@
+module SystemMetrics
+  module Instrument
+    class ActionView < SystemMetrics::Instrument::Base
+
+      def initialize
+        super /\.action_view$/
+      end
+
+      def prepare(event)
+        event.payload.each do |key, value|
+          case value
+          when NilClass
+          when String
+            event.payload[key] = prune_path(value)
+          else
+            event.payload[key] = value
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/system_metrics/instrument/active_record.rb

@@ -0,0 +1,20 @@
+module SystemMetrics
+  module Instrument
+    class ActiveRecord < SystemMetrics::Instrument::Base
+
+      def initialize
+        super /\.active_record$/
+      end
+
+      def ignore?(event)
+        event.payload[:sql] !~ /^(SELECT|INSERT|UPDATE|DELETE)/
+      end
+
+      def prepare(event)
+        event.payload[:sql] = event.payload[:sql].squeeze(" ")
+        event.payload.delete(:connection_id)
+      end
+
+    end
+  end
+end

data/lib/system_metrics/instrument/base.rb

@@ -0,0 +1,77 @@
+module SystemMetrics
+  module Instrument
+
+    # Base class for System Metric instruments. The default implementations 
+    # for the methods in this class are all based on a regular expression 
+    # that is matched against a pattern. Custom intruments that simply need 
+    # to match against a notfication name can easily extend this class like:
+    #
+    #   class SearchInstrument < SystemMetrics::Instrument::Base
+    #     def initialize
+    #       super /search$/
+    #     end
+    #   end
+    class Base
+
+      attr_reader :pattern
+
+      # Create an instrument that will match notification names on the given
+      # pattern.
+      def initialize(pattern)
+        @pattern = pattern
+      end
+
+      # Holds the mapped paths used in prunning.
+      def mapped_paths
+        @mapped_paths ||= default_mapped_paths
+      end
+
+      # Prune paths based on the mapped paths set.
+      def prune_path(raw_path)
+        mapped_paths.each do |path, replacement|
+          next unless path.present?
+          raw_path = raw_path.gsub(path, replacement)
+        end
+        raw_path
+      end
+
+      # Declares whether this instrument handles the given event type.
+      #
+      # Please Note: Even if the instrument would ultimately like to 
+      # ignore the event, it should still return true if it generally 
+      # handles events like the one passed.
+      def handles?(event)
+        event.name =~ pattern
+      end
+
+      # Indicates whether the given event should be completely ingored 
+      # and not collected. This is called only if #handles?(event) 
+      # returns `true`
+      def ignore?(event)
+        false
+      end
+
+      # Provides an opportunity to modify the event before it's collected
+      # and stored. This is where you would normally modify the payload
+      # to add, remove, or format its elements.
+      def prepare(event)
+        # Modify the payload if you care to
+      end
+
+      private
+
+        def default_mapped_paths
+          # Make Rails.root appear as RAILS_ROOT in pruned paths.
+          paths = { Rails.root.to_s => 'RAILS_ROOT' }
+
+          # Make Gem paths appear as GEMS_ROOT in pruned paths.
+          Gem.path.each do |path|
+            paths[File.join(path, "gems")] = "GEMS_ROOT"
+          end if defined?(Gem)
+
+          paths
+        end
+
+    end
+  end
+end

data/lib/system_metrics/instrument/rack.rb

@@ -0,0 +1,11 @@
+module SystemMetrics
+  module Instrument
+    class Rack < SystemMetrics::Instrument::Base
+
+      def initialize
+        super /^request\.rack$/
+      end
+
+    end
+  end
+end

data/lib/system_metrics/middleware.rb

@@ -0,0 +1,32 @@
+module SystemMetrics
+  class Middleware
+    def initialize(app, collector, path_exclude_patterns)
+      @app = app
+      @collector = collector
+      @path_exclude_patterns = path_exclude_patterns
+    end
+
+    def call(env)
+      if exclude_path? env["PATH_INFO"]
+        @app.call(env)
+      else
+        @collector.collect do
+          response = notifications.instrument "request.rack",
+            :path => env["PATH_INFO"], :method => env["REQUEST_METHOD"] do
+            @app.call(env)
+          end
+        end
+      end
+    end
+
+  protected
+
+    def exclude_path?(path)
+      @path_exclude_patterns.any? { |pattern| pattern =~ path }
+    end
+
+    def notifications
+      ActiveSupport::Notifications
+    end
+  end
+end