system-metrics 0.1.0

data/public/stylesheets/typography.css

@@ -0,0 +1,123 @@
+/* --------------------------------------------------------------
+
+   typography.css
+   * Sets up some sensible default typography.
+
+-------------------------------------------------------------- */
+
+/* Default font settings.
+   The font-size percentage is of 16px. (0.75 * 16px = 12px) */
+html { font-size:100.01%; }
+body {
+  font-size: 75%;
+  color: #222;
+  background: #fff;
+  font-family: "Helvetica Neue", Arial, Helvetica, sans-serif;
+}
+
+
+/* Headings
+-------------------------------------------------------------- */
+
+h1,h2,h3,h4,h5,h6 { font-weight: normal; color: #111; }
+
+h1 { font-size: 3em; line-height: 1; margin-bottom: 0.5em; }
+h2 { font-size: 2em; margin-bottom: 0.75em; }
+h3 { font-size: 1.5em; line-height: 1; margin-bottom: 1em; }
+h4 { font-size: 1.2em; line-height: 1.25; margin-bottom: 1.25em; }
+h5 { font-size: 1em; font-weight: bold; margin-bottom: 1.5em; }
+h6 { font-size: 1em; font-weight: bold; }
+
+h1 img, h2 img, h3 img,
+h4 img, h5 img, h6 img {
+  margin: 0;
+}
+
+
+/* Text elements
+-------------------------------------------------------------- */
+
+p           { margin: 0 0 1.5em; }
+/*
+  These can be used to pull an image at the start of a paragraph, so
+  that the text flows around it (usage: <p><img class="left">Text</p>)
+ */
+.left       { float: left !important; }
+p .left     { margin: 1.5em 1.5em 1.5em 0; padding: 0; }
+.right      { float: right !important; }
+p .right    { margin: 1.5em 0 1.5em 1.5em; padding: 0; }
+
+a:focus,
+a:hover     { color: #09f; }
+a           { color: #06c; text-decoration: underline; }
+
+blockquote  { margin: 1.5em; color: #666; font-style: italic; }
+strong,dfn  { font-weight: bold; }
+em,dfn      { font-style: italic; }
+sup, sub    { line-height: 0; }
+
+abbr,
+acronym     { border-bottom: 1px dotted #666; }
+address     { margin: 0 0 1.5em; font-style: italic; }
+del         { color:#666; }
+
+pre         { margin: 1.5em 0; white-space: pre; }
+pre,code,tt { font: 1em 'andale mono', 'lucida console', monospace; line-height: 1.5; }
+
+
+/* Lists
+-------------------------------------------------------------- */
+
+li ul,
+li ol  { margin: 0; }
+ul, ol { margin: 0 1.5em 1.5em 0; padding-left: 1.5em; }
+
+ul     { list-style-type: disc; }
+ol     { list-style-type: decimal; }
+
+dl     { margin: 0 0 1.5em 0; }
+dl dt  { font-weight: bold; }
+dd     { margin-left: 1.5em;}
+
+
+/* Tables
+-------------------------------------------------------------- */
+
+/*
+  Because of the need for padding on TH and TD, the vertical rhythm
+  on table cells has to be 27px, instead of the standard 18px or 36px
+  of other elements.
+ */
+table         { margin-bottom: 1.4em; width:100%; }
+th            { font-weight: bold; }
+thead th      { background: #c3d9ff; }
+th,td,caption { padding: 4px 10px 4px 5px; }
+/*
+  You can zebra-stripe your tables in outdated browsers by adding
+  the class "even" to every other table row.
+ */
+tbody tr:nth-child(even) td,
+tbody tr.even td  {
+  background: #e5ecf9;
+}
+tfoot       { font-style: italic; }
+caption     { background: #eee; }
+
+
+/* Misc classes
+-------------------------------------------------------------- */
+
+.small     { font-size: .8em; margin-bottom: 1.875em; line-height: 1.875em; }
+.large     { font-size: 1.2em; line-height: 2.5em; margin-bottom: 1.25em; }
+.hide      { display: none; }
+
+.quiet     { color: #666; }
+.loud      { color: #000; }
+.highlight { background:#ff0; }
+.added     { background:#060; color: #fff; }
+.removed   { background:#900; color: #fff; }
+
+.first     { margin-left:0; padding-left:0; }
+.last      { margin-right:0; padding-right:0; }
+.top       { margin-top:0; padding-top:0; }
+.bottom    { margin-bottom:0; padding-bottom:0; }

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'rails'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.include NotificationsSupport
+end

data/spec/support/db_setup.rb

@@ -0,0 +1,41 @@
+require 'active_support/core_ext'
+require 'active_record'
+require 'fileutils'
+
+tmpdir = File.join(File.dirname(__FILE__), '..', '..', 'tmp')
+FileUtils.mkdir(tmpdir) unless File.exist?(tmpdir)
+test_db = File.join(tmpdir, 'test.db')
+
+connection_spec = {
+  :adapter => 'sqlite3',
+  :database => test_db
+}
+
+# Delete any existing instance of the test database
+FileUtils.rm test_db, :force => true
+
+# Create a new test database
+ActiveRecord::Base.establish_connection(connection_spec)
+
+# ActiveRecord::Base.connection.initialize_schema_migrations_table
+
+class CreateMeasurements < ActiveRecord::Migration
+  def self.up
+    create_table :system_metrics, :force => true do |t|
+      t.string :name
+      t.datetime :started_at
+      t.string :transaction_id
+      t.text :payload
+      t.float :duration
+      t.integer :request_id
+      t.integer :parent_id
+    end
+  end
+
+  def self.down
+    drop_table :system_metrics
+  end
+end
+
+CreateMeasurements.up
+

data/spec/support/mock_app.rb

@@ -0,0 +1,23 @@
+class MockApp
+  attr_accessor :config
+
+  def config
+    @config ||= Config.new
+  end
+
+  class Config
+    def system_metrics
+      @system_metrics ||= {}
+    end
+
+    def middleware
+      @middleware ||= Middleware.new
+    end
+  end
+
+  class Middleware < Array
+    def use(*args)
+      self.push args
+    end
+  end
+end

data/spec/support/notifications_support.rb

@@ -0,0 +1,12 @@
+module NotificationsSupport
+
+  def self.included(base)
+    base.class_eval do
+      after(:each) do
+        ActiveSupport::Notifications.notifier.instance_variable_set(:@subscribers, [])
+        ActiveSupport::Notifications.notifier.instance_variable_set(:@listeners_for, {})
+      end
+    end
+  end
+
+end

data/spec/support/test_logger.rb

@@ -0,0 +1,11 @@
+class TestLogger
+  attr_reader :messages
+
+  def initialize
+    @messages = []
+  end
+
+  def info(msg)
+    messages << msg
+  end
+end

data/spec/support/test_store.rb

@@ -0,0 +1,11 @@
+class TestStore
+  attr_reader :events
+
+  def initialize
+    @events = []
+  end
+
+  def save(events)
+    @events = events
+  end
+end

data/spec/support/transactional_specs.rb

@@ -0,0 +1,17 @@
+module TransactionalSpecs
+
+  def self.included(base)
+    base.class_eval do
+      around(:each) do |spec|
+        ActiveRecord::Base.transaction do
+          begin
+            spec.call
+          ensure
+            raise ActiveRecord::Rollback
+          end
+        end
+      end
+    end
+  end
+
+end

data/spec/system_metrics/collector_spec.rb

@@ -0,0 +1,60 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'system_metrics/collector'
+
+describe SystemMetrics::Collector do
+  before(:each) do 
+    @store = TestStore.new
+    @collector = SystemMetrics::Collector.new(@store)
+  end
+
+  it 'should collect events while collecting' do
+    @collector.collect do
+      @collector.collect_event(Object.new)
+      @collector.collect_event(Object.new)
+    end
+
+    @store.should have(2).events
+  end
+
+  it 'should not collect events if collecting is turned off' do
+    @collector.collect do
+      @collector.collect_event(Object.new)
+      SystemMetrics.collection_off
+      @collector.collect_event(Object.new)
+      SystemMetrics.collection_on
+    end
+
+    @store.should have(1).events
+  end
+
+  it 'should clear out all thread resident events after collecting' do
+    @collector.collect do
+      @collector.collect_event(Object.new)
+      @collector.collect_event(Object.new)
+    end
+
+    @store.should have(2).events
+    @collector.send(:events).should be_empty
+  end
+
+  it 'should set collecting to off after a call to collect' do
+    @collector.collect do
+      @collector.collect_event(Object.new)
+      @collector.collect_event(Object.new)
+    end
+
+    SystemMetrics.should_not be_collecting
+  end
+
+  it 'should not save events to the store if an exception occurs' do
+    lambda {
+      @collector.collect do
+        @collector.collect_event(Object.new)
+        @collector.collect_event(Object.new)
+        raise StandardError.new
+      end
+    }.should raise_error
+
+    @store.should have(0).events
+  end
+end

data/spec/system_metrics/config_spec.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'system_metrics/config'
+
+describe SystemMetrics::Config do
+  it 'should be valid with instruments, path_exclude_patterns, and a store' do
+    config = SystemMetrics::Config.new({:instruments => [Object.new], :store => Object.new})
+    config.should be_valid
+  end
+
+  it 'should be invalid without instruments' do
+    config = SystemMetrics::Config.new({:store => Object.new})
+    config.should_not be_valid
+  end
+
+  it 'should be invalid without a store' do
+    config = SystemMetrics::Config.new({:instruments => [Object.new]})
+    config.should_not be_valid
+  end
+
+  it 'should be invalid if passed an unrecognized option' do
+    config = SystemMetrics::Config.new({:instruments => [Object.new], :path_exclude_patterns => [], :store => Object.new, :bogus => true})
+    config.should_not be_valid
+  end
+end

data/spec/system_metrics/engine_spec.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'system_metrics/engine'
+
+describe SystemMetrics::Engine do
+  before(:each) do
+    @app = MockApp.new
+    @store = TestStore.new
+    @app.config.system_metrics[:instruments] = [Comb::Instrument::Base.new(/xyz123/)]
+    @app.config.system_metrics[:store] = @store
+  end
+
+  it 'should establish ActiveSupport::Notification subscribers for each instrument' do
+    @app.config.system_metrics[:instruments] = [Comb::Instrument::Base.new(/^sql/), Comb::Instrument::Base.new(/^render/)]
+    engine = SystemMetrics::Engine.new
+    run_initializers(engine)
+
+    collector = SystemMetrics::Collector.new(@store)
+    collector.collect do
+      ActiveSupport::Notifications.instrument 'sql.active_record'
+      ActiveSupport::Notifications.instrument 'render.action_view'
+      ActiveSupport::Notifications.instrument 'process.action_controller'
+    end
+
+    @store.should have(2).events
+    @store.events.map(&:name) =~ ['sql.active_record', 'render.action_view']
+  end
+
+  it 'should setup the SystemMetrics::Middleware' do
+    engine = SystemMetrics::Engine.new
+    run_initializers(engine)
+
+    middleware = @app.config.middleware.first
+    middleware[0].should == SystemMetrics::Middleware
+    middleware[1].should_not be_nil
+    middleware[2].should_not be_nil
+  end
+
+  def run_initializer(engine, name)
+    initializer = engine.initializers.find do |initializer|
+      initializer.name == name
+    end
+    initializer.run @app
+  end
+
+  def run_initializers(engine)
+    ['system_metrics.initialize', 'system_metrics.add_subscribers', 'system_metrics.add_middleware'].each do |name|
+      run_initializer(engine, name)
+    end
+  end
+end

data/spec/system_metrics/middleware_spec.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'system_metrics/middleware'
+require 'system_metrics/collector'
+
+describe SystemMetrics::Middleware do
+  before(:each) do
+    @store = TestStore.new
+    @collector = SystemMetrics::Collector.new(@store)
+  end
+
+  it 'should invoke the collector for a non-excluded paths' do
+    event = Object.new
+    blk = Proc.new { @collector.collect_event(event) }
+    middleware = SystemMetrics::Middleware.new(blk, @collector, [])
+    env = { "PATH_INFO" => '/collect' }
+
+    middleware.call(env)
+    @store.should have(1).events
+  end
+
+  it 'should not invoke the collector for excluded paths' do
+    event = Object.new
+    blk = Proc.new { @collector.collect_event(event) }
+    middleware = SystemMetrics::Middleware.new(blk, @collector, [/^\/collect/])
+    env = { "PATH_INFO" => '/collect' }
+
+    middleware.call(env)
+    @store.should have(0).events
+  end
+
+  it 'should wrap everything with an instrumentation for rack requests' do
+    ActiveSupport::Notifications.subscribe(/\.rack$/) do |*args|
+      @collector.collect_event(ActiveSupport::Notifications::Event.new(*args))
+    end
+
+    event = Object.new
+    blk = Proc.new {}
+    middleware = SystemMetrics::Middleware.new(blk, @collector, [])
+    env = { "PATH_INFO" => '/collect' }
+
+    middleware.call(env)
+    @store.should have(1).events
+    @store.events.first.name.should == 'request.rack'
+  end
+end