strumbar 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+notifications:
+  email:
+    recipients:
+      - anordman@majorleaguegaming.com
+      - mwilson@majorleaguegaming.com

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in strumbar.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Andrew Nordman
+
+MIT License
+
+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.md

@@ -0,0 +1,74 @@
+# Strumbar [![Build Status](https://secure.travis-ci.org/agoragames/strumbar.png)](http://travis-ci.org/agoragames/strumbar)
+
+Strumbar is a wrapper around ActiveSupport::Notifications with preconfigurations
+for basic instrumentation to be sent to statsd.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'strumbar'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install strumbar
+
+## Usage
+
+
+Configuration:
+
+``` ruby
+Strumbar.configure do |config|
+  config.port = 80
+  config.host = 'instrument.majorleaguegaming.com'
+  config.application = 'instrument'
+end
+```
+
+Adding this alone causes basic instrumentation data to be sent to the Statsd
+server broken down by your application and will be visible in the dashboard.
+If you are happy with that, you're done.  Adding custom instrumentation that is
+specific to your application is incredibly simple.  Strumbar is a wrapper around
+ActiveSupport::Notifications.
+
+``` ruby
+Strumbar.subscribe /something_cool/ do |client, event|
+  client.increment 'something_cool_counter'
+end
+```
+
+Client is an instance of `Strumbar::Client` and wraps around Statsd::Client for
+namespacing and syntactic sugar.
+
+By default, it will subscribe to runtime data for `process_action.action_controller`
+and the sql load time in `sql.active_record`.
+
+In case you get tired of typing `ActiveSupport::Notifications.instrument` you can use the helpful sugar `Strumbar` provides:
+
+```ruby
+Strumbar.strum 'view.render', payload do
+  render :text => "I'm monitored!"
+end
+```
+
+
+## Default Instruments
+
+Strumbar takes the approach of auto-detecting the libraries being used and
+loading default instrumentation subscriptions.  Currently, this list includes:
+
+- ActionController
+- ActiveRecord
+- Redis
+
+More default instrumentation defaults will be added.
+
+## Authors
+
+Written by [Andrew Nordman](https://github.com/cadwallion) and [Matthew Wilson](https://github.com/hypomodern)
+

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--backtrace']
+  # spec.ruby_opts = ['-w']
+end
+
+task :default => :spec
+task :test => :spec

data/lib/strumbar/client.rb

@@ -0,0 +1,22 @@
+require 'statsd'
+
+module Strumbar
+  class Client < ::Statsd::Client
+    def initialize host, port
+      @host = host
+      @port = port
+    end
+
+    def timing stat, time, sample_rate = 1
+      super "#{Strumbar.application}.#{stat}", time, sample_rate
+    end
+
+    def increment stat, sample_rate = 1
+      super "#{Strumbar.application}.#{stat}", sample_rate
+    end
+
+    def decrement stat, sample_rate = 1
+      super "##{Strumbar.application}.#{stat}", sample_rate
+    end
+  end
+end

data/lib/strumbar/configuration.rb

@@ -0,0 +1,5 @@
+module Strumbar
+  class Configuration
+    attr_accessor :port, :host, :application
+  end
+end

data/lib/strumbar/instrumentation/action_controller.rb

@@ -0,0 +1,17 @@
+module Strumbar
+  module Instrumentation
+    module ActionController
+      def self.load
+        Strumbar.subscribe /process_action.action_controller/ do |client, event|
+          key = "#{event.payload[:controller]}.#{event.payload[:action]}"
+
+          client.timing     "#{key}.total_time", event.duration
+          client.timing     "#{key}.view_time",  event.payload[:view_runtime]
+          client.timing     "#{key}.db_time",    event.payload[:db_runtime]
+
+          client.increment  "#{key}.status.#{event.payload[:status]}"
+        end
+      end
+    end
+  end
+end

data/lib/strumbar/instrumentation/active_record.rb

@@ -0,0 +1,11 @@
+module Strumbar
+  module Instrumentation
+    module ActiveRecord
+      def self.load
+        Strumbar.subscribe /sql.active_record/ do |client, event|
+          client.timing 'query_log', event.duration
+        end
+      end
+    end
+  end
+end

data/lib/strumbar/instrumentation/redis.rb

@@ -0,0 +1,36 @@
+module Strumbar
+  module Instrumentation
+    module Redis
+      def self.load
+        Strumbar.subscribe 'query.redis' do |client, event|
+          client.increment 'query.redis'
+          client.increment 'failure.redis' if event.payload[:failure]
+
+          client.timing "#{event.payload[:command]}.redis", event.duration
+        end
+
+        unless ::Redis::Client.instance_methods.include? :call_with_instrumentation
+          ::Redis::Client.class_eval do
+            def call_with_instrumentation command, &block
+              Strumbar.strum 'query.redis', command: command do |payload|
+                call_without_instrumentation command, &block
+                begin
+                  reply = call_without_instrumentation command, &block 
+                  payload[:failure] = false
+                rescue CommandError
+                  payload[:failure] = true
+                  raise
+                end
+
+                reply
+              end
+            end
+
+            alias_method :call_without_instrumentation, :call
+            alias_method :call, :call_with_instrumentation
+          end
+        end
+      end
+    end
+  end
+end

data/lib/strumbar/instrumentation.rb

@@ -0,0 +1,13 @@
+module Strumbar
+  module Instrumentation
+    autoload :Redis, 'strumbar/instrumentation/redis'
+    autoload :ActionController, 'strumbar/instrumentation/action_controller'
+    autoload :ActiveRecord, 'strumbar/instrumentation/active_record'
+
+    def self.load
+      Strumbar::Instrumentation::ActionController.load if defined? ::ActionController
+      Strumbar::Instrumentation::ActiveRecord.load if defined? ::ActiveRecord
+      Strumbar::Instrumentation::Redis.load if defined? ::Redis
+    end
+  end
+end

data/lib/strumbar/version.rb

@@ -0,0 +1,3 @@
+module Strumbar
+  VERSION = "0.0.1"
+end

data/lib/strumbar.rb

@@ -0,0 +1,46 @@
+require 'strumbar/version'
+require 'strumbar/configuration'
+require 'strumbar/client'
+require 'strumbar/instrumentation'
+
+require 'active_support'
+require 'active_support/core_ext/object/try'
+
+module Strumbar
+  class << self
+    attr_reader :configuration
+
+    def configure
+      @configuration = Configuration.new
+      yield @configuration
+      Instrumentation.load
+    end
+
+    def client
+      @client ||= Client.new host, port
+    end
+
+    def host
+      configuration.try(:host) || 'localhost'
+    end
+
+    def port
+      configuration.try(:port) || 8125
+    end
+
+    def application
+      configuration.try(:application) || 'my_awesome_app'
+    end
+
+    def subscribe identifier
+      ActiveSupport::Notifications.subscribe identifier do |*args|
+        event = ActiveSupport::Notifications::Event.new(*args)
+        yield client, event
+      end
+    end
+
+    def strum event, payload, &block
+      ActiveSupport::Notifications.instrument event, payload, &block
+    end
+  end
+end

data/spec/instrumentation/redis_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Strumbar::Instrumentation::Redis do
+  before do
+    class Redis
+      class Client
+        def call command, &block
+          
+        end
+
+        def validate
+          true
+        end
+      end
+    end
+    Strumbar::Instrumentation::Redis.load
+  end
+
+  after do
+    ActiveSupport::Notifications.unsubscribe('query.redis')
+    Object.send :remove_const, :Redis
+  end
+
+  it 'adds a wrapper around Redis#call to instrument redis calls' do
+    Strumbar.should_receive(:strum).with('query.redis', { command: 'SET' })
+    Redis::Client.new.call 'SET'
+  end
+
+  it 'subscribes to query.redis notifications' do
+    Strumbar.client.should_receive(:increment).with('query.redis')
+    Strumbar.strum 'query.redis', {}
+  end
+
+  it 'passes blocks in #call accordingly' do
+    client = Redis::Client.new
+    client.call 'foo'
+  end
+end

data/spec/instrumentation_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Strumbar::Instrumentation do
+  describe '#load' do
+    def undefine klass
+      Object.send :remove_const, klass
+    end
+
+    it 'loads the ActionController subscription if ActionController is defined' do
+
+      ActionController = true
+
+      Strumbar::Instrumentation::ActionController.should_receive :load
+      Strumbar::Instrumentation.load
+
+      undefine :ActionController
+    end
+
+    it 'does not load ActionController subscription if not defined' do
+      Strumbar::Instrumentation::ActionController.should_not_receive :load
+      Strumbar::Instrumentation.load
+    end
+
+    it 'loads the ActiveRecord subscription if ActiveRecord is loaded' do
+      ActiveRecord = true
+
+      Strumbar::Instrumentation::ActiveRecord.should_receive :load
+      Strumbar::Instrumentation.load
+
+      undefine :ActiveRecord
+    end
+
+    it 'does not load ActiveRecord subscription if not defined' do
+      Strumbar::Instrumentation::ActiveRecord.should_not_receive :load
+      Strumbar::Instrumentation.load
+    end
+
+    it 'loads the Redis subscription if Redis is defined' do
+      class Redis
+        class Client
+          def process ; end
+        end
+      end
+
+      Strumbar::Instrumentation::Redis.should_receive :load
+      Strumbar::Instrumentation.load
+
+      undefine :Redis
+    end
+
+    it 'does not load Redis subscription if not defined' do
+      Strumbar::Instrumentation::Redis.should_not_receive :load
+      Strumbar::Instrumentation.load
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'strumbar'

data/spec/strumbar_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+
+describe Strumbar do
+  it 'loads' do
+    true
+  end
+
+  after do
+    Strumbar.instance_variable_set(:@configuration, nil)
+  end
+
+  describe '#client' do
+    after do
+      Strumbar.instance_variable_set(:@client, nil)
+    end
+
+    it { Strumbar.client.should be_a_kind_of Strumbar::Client }
+
+    it 'defaults host to localhost' do
+      Strumbar.client.host.should == 'localhost'
+    end
+
+    it 'defaults port to 8125' do
+      Strumbar.client.port.should == 8125
+    end
+
+    it 'uses the Strumbar configuration if configuration is present' do
+      Strumbar.configure do |config|
+        config.port = 12345
+        config.host = '127.0.0.1'
+      end
+
+      Strumbar.client.port.should == 12345
+      Strumbar.client.host.should == '127.0.0.1'
+    end
+  end
+
+  describe '#configure' do
+    it 'yields a Configuration object' do
+      Strumbar.configure do |config|
+        config.should be_a_kind_of Strumbar::Configuration
+      end
+    end
+
+    it 'loads relevant Instrumentation' do
+      Strumbar::Instrumentation.should_receive(:load)
+      Strumbar.configure { |c| }
+    end
+
+    it 'assigns the configuration object to Strumbar' do
+      @config_object = nil
+      Strumbar.configure do |config|
+        config.port = 12345
+        config.host = '127.0.0.1'
+        @config_object = config
+      end
+
+      Strumbar.configuration.should == @config_object
+    end
+  end
+
+  describe "#application" do
+    it "returns the configured value" do
+      Strumbar.configure { |c| c.application = "foobar" }
+      Strumbar.application.should == "foobar"
+    end
+    it "defaults to something comically bad so you'll change it" do
+      Strumbar.application.should == "my_awesome_app"
+    end
+  end
+
+  describe "#host" do
+    it "returns the configured value" do
+      Strumbar.configure { |c| c.host = "statsd.app" }
+      Strumbar.host.should == "statsd.app"
+    end
+    it "defaults to localhost" do
+      Strumbar.host.should == "localhost"
+    end
+  end
+
+  describe "#port" do
+    it "returns the configured port" do
+      Strumbar.configure { |c| c.port = 9999 }
+      Strumbar.port.should == 9999
+    end
+    it "defaults to 8125" do
+      Strumbar.port.should == 8125
+    end
+  end
+
+  describe '#subscribe' do
+    it 'should wrap ActiveSupport::Notifications' do
+      ActiveSupport::Notifications.should_receive(:subscribe).with('foo')
+      Strumbar.subscribe 'foo'
+    end
+
+    it 'should yield an event and client on instrument call' do
+      Strumbar.subscribe 'foo' do |client, event|
+        event.should be_a_kind_of ActiveSupport::Notifications::Event
+        client.should be_a_kind_of Strumbar::Client
+      end
+      ActiveSupport::Notifications.instrument 'foo'
+    end
+  end
+
+  describe "#strum" do
+    it "is syntactic sugar for ActiveSupport::Notifications.instrument" do
+      ActiveSupport::Notifications.should_receive(:instrument).with("event_name", { :payload => :yeah })
+      Strumbar.strum("event_name", { payload: :yeah })
+    end
+    it "handles the block correctly and all that jazz" do
+      foo = nil
+      ActiveSupport::Notifications.should_receive(:instrument).and_yield
+      Strumbar.strum("mah.event", {}) do
+        foo = 7
+      end
+      foo.should == 7
+    end
+  end
+end

data/strumbar.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/strumbar/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Andrew Nordman", "Matthew Wilson"]
+  gem.email         = ["anordman@majorleaguegaming.com", "mwilson@majorleaguegaming.com"]
+  gem.description   = %q{An instrumentation utility.}
+  gem.summary       = %q{Helper library to strum along in your application.}
+  gem.homepage      = "http://instrument.majorleaguegaming.com"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "strumbar"
+  gem.require_paths = ["lib"]
+  gem.version       = Strumbar::VERSION
+
+  gem.add_dependency 'activesupport'
+  gem.add_dependency 'statsd'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: strumbar
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Nordman
+- Matthew Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70176768352560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70176768352560
+- !ruby/object:Gem::Dependency
+  name: statsd
+  requirement: &70176768351540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70176768351540
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70176768365400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70176768365400
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70176768363780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70176768363780
+description: An instrumentation utility.
+email:
+- anordman@majorleaguegaming.com
+- mwilson@majorleaguegaming.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/strumbar.rb
+- lib/strumbar/client.rb
+- lib/strumbar/configuration.rb
+- lib/strumbar/instrumentation.rb
+- lib/strumbar/instrumentation/action_controller.rb
+- lib/strumbar/instrumentation/active_record.rb
+- lib/strumbar/instrumentation/redis.rb
+- lib/strumbar/version.rb
+- spec/instrumentation/redis_spec.rb
+- spec/instrumentation_spec.rb
+- spec/spec_helper.rb
+- spec/strumbar_spec.rb
+- strumbar.gemspec
+homepage: http://instrument.majorleaguegaming.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4388880023280648677
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4388880023280648677
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Helper library to strum along in your application.
+test_files:
+- spec/instrumentation/redis_spec.rb
+- spec/instrumentation_spec.rb
+- spec/spec_helper.rb
+- spec/strumbar_spec.rb