formatted-metrics 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/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Eric J. Holmes
+
+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,53 @@
+# Formatted Metrics
+
+Easily produce metrics that can be consumed by [l2met](https://github.com/ryandotsmith/l2met).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'formatted-metrics'
+```
+
+## Usage
+
+### Rails
+
+You're done!
+
+### Rack
+
+Call `Metrics.setup` when you app boots.
+
+### Instrument
+
+Use `Metrics.instrument` to instrument events to STDOUT.
+
+```ruby
+Metrics.instrument 'rack.request' do
+  @app.call(env)
+end
+# => 'source=app measure.rack.request=50ms'
+
+Metrics.instrument 'workers.busy', 10, units: 'workers'
+# => 'source=app measure.workers.busy=10workers'
+
+Metrics.instrument 'sidekiq.queue', source: 'background' do
+  yield
+end
+# => 'source=app.background measure.sidekiq.queue=500ms'
+```
+
+## TODO
+
+* Add Rack middleware for outputting rack performance metrics.
+* Instrument some default rails stuff.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default => [:spec]
+
+require 'rspec/core/rake_task'
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/formatted-metrics.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'formatted-metrics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "formatted-metrics"
+  spec.version       = FormattedMetrics::VERSION
+  spec.authors       = ["Eric J. Holmes"]
+  spec.email         = ["eric@ejholmes.net"]
+  spec.description   = %q{Easily output formatted metrics to stdout}
+  spec.summary       = %q{Easily output formatted metrics to stdout}
+  spec.homepage      = "http://github.com/remind101/formatted-metrics"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport', '~> 3.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+end

data/lib/formatted-metrics/configuration.rb

@@ -0,0 +1,25 @@
+module Metrics
+  class Configuration
+    # The stream source to write to. Defaults to STDOUT.
+    attr_accessor :stream
+
+    # The base source for all metrics.
+    attr_accessor :source
+
+    # The formatter to use. Only needs to be a class that responds to `to_s`.
+    # Defaults to Metrics::Formatter.
+    attr_accessor :formatter
+
+    def stream
+      @stream ||= STDOUT
+    end
+
+    def source
+      @source ||= ENV['METRICS_SOURCE'] || ENV['APP_NAME'] || `hostname`.chomp.underscore
+    end
+
+    def formatter
+      @formatter ||= Metrics::Formatter
+    end
+  end
+end

data/lib/formatted-metrics/formatter.rb

@@ -0,0 +1,53 @@
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/string/inflections'
+
+module Metrics
+
+  # Internal: Responsible for taking an event and formatting it to be consumed
+  # by l2met.
+  #
+  # Example
+  #
+  #   Formatter.new(event).to_s
+  #   # => "source=my-app measure.rack.request=50ms"
+  #
+  # Returns a Metrics::Formatter.to_s
+  class Formatter
+    DEFAULT_UNITS = 'ms'.freeze
+
+    # An object that conforms to the same public interface as
+    # ActiveSupport::Notifications::Event
+    attr_reader :event
+
+    def initialize(event)
+      @event = event
+    end
+
+    def to_s
+      "source=#{source} measure.#{event_name}=#{value}"
+    end
+
+  private
+
+    delegate :name, :payload, :duration, to: :event, prefix: true
+    delegate :configuration, to: :'Metrics'
+
+    def value
+      case measurement = event_payload[:measure]
+      when true
+        [event_duration, DEFAULT_UNITS].join('')
+      else
+        if units = event_payload[:units]
+          [measurement, units].join('')
+        else
+          measurement
+        end
+      end
+    end
+
+    def source
+      [configuration.source, Array(event_payload[:source])].flatten.join('.')
+    end
+  end
+
+end

data/lib/formatted-metrics/handler.rb

@@ -0,0 +1,35 @@
+require 'active_support/core_ext/module/delegation'
+
+module Metrics
+
+  # Internal: Responsible for handling an ActiveSupport::Notifications message.
+  class Handler
+    attr_reader :args
+
+    def initialize(*args)
+      @args = args
+    end
+
+    def handle
+      log if trackable?
+    end
+
+  private
+
+    delegate :configuration, to: :'Metrics'
+
+    def trackable?
+      event.payload[:measure]
+    end
+
+    def event
+      @event ||= ActiveSupport::Notifications::Event.new(*args)
+    end
+
+    def log
+      configuration.stream.puts configuration.formatter.new(event).to_s
+    end
+
+  end
+
+end

data/lib/formatted-metrics/metrics.rb

@@ -0,0 +1,67 @@
+require 'active_support/notifications'
+require 'active_support/core_ext/array/extract_options'
+
+require 'formatted-metrics/railtie' if defined?(Rails)
+
+module Metrics
+  autoload :Configuration, 'formatted-metrics/configuration'
+  autoload :Handler,       'formatted-metrics/handler'
+  autoload :Formatter,     'formatted-metrics/formatter'
+
+  class << self
+
+    # Public: Instrument a metric.
+    #
+    # metric - The name of the metric (e.g. rack.request)
+    # source - A source to append to the default source.
+    #
+    # Example
+    #
+    #   # Instrument the duration of an event.
+    #   Metrics.instrument 'rack.request' do
+    #     @app.call(env)
+    #   end
+    #
+    #   # Instrument a specific value.
+    #   Metrics.instrument 'workers.busy', 10, units: 'workers'
+    #
+    #   # Instrument something with a specific source.
+    #   Metrics.instrument 'sidekiq.queue', source: 'background' do
+    #     yield
+    #   end
+    #
+    # Returns nothing.
+    def instrument(metric, *args, &block)
+      options = args.extract_options!
+      measure = !args.empty? ? args.first : true
+      ActiveSupport::Notifications.instrument \
+        metric,
+        options.merge(measure: measure, source: options[:source]),
+        &block
+    end
+
+    # Public: Subscribe to all ActiveSupport::Notifications events. Only events
+    # that have a payload with a :measure key that is truthy will be processed
+    # and logged to stdout.
+    #
+    # Example
+    #
+    #   Metrics.setup
+    #
+    # Returns nothing.
+    def subscribe
+      ActiveSupport::Notifications.subscribe /.*/ do |*args|
+        Metrics::Handler.new(*args).handle
+      end
+    end
+
+    def configuration
+      @configuration || Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
+  end
+end

data/lib/formatted-metrics/railtie.rb

@@ -0,0 +1,7 @@
+module Metrics
+  class Railtie < ::Rails::Railtie
+    initializer 'metrics.subscribe' do
+      Metrics.subscribe
+    end
+  end
+end

data/lib/formatted-metrics/version.rb

@@ -0,0 +1,3 @@
+module FormattedMetrics
+  VERSION = '0.0.1'
+end

data/lib/formatted-metrics.rb

@@ -0,0 +1 @@
+require 'formatted-metrics/metrics'

data/spec/formatted-metrics/formatter_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Metrics::Formatter do
+  let(:event    ) { double ActiveSupport::Notifications::Event, name: 'rack.request', payload: { measure: true } }
+  let(:formatter) { described_class.new event }
+
+  before do
+    formatter.stub_chain :configuration, source: 'app'
+  end
+
+  describe '.to_s' do
+    subject { formatter.to_s }
+
+    context 'with a duration' do
+      before { event.stub duration: 10 }
+      it { should eq 'source=app measure.rack.request=10ms' }
+    end
+
+    context 'with a measurement' do
+      context 'with units' do
+        before { event.stub payload: { measure: 1, units: 's' } }
+        it { should eq 'source=app measure.rack.request=1s' }
+      end
+
+      context 'without units' do
+        before { event.stub payload: { measure: 50 } }
+        it { should eq 'source=app measure.rack.request=50' }
+      end
+    end
+
+    context 'with a source' do
+      before { event.stub name: 'workers.busy', payload: { measure: 10, source: 'sidekiq' } }
+      it { should eq 'source=app.sidekiq measure.workers.busy=10' }
+    end
+  end
+end

data/spec/formatted-metrics/handler_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Metrics::Handler do
+  let(:args     ) { ['event args'] * 5 }
+  let(:handler  ) { described_class.new *args }
+
+  let(:event    ) { double ActiveSupport::Notifications::Event }
+  let(:formatter) { double Metrics.configuration.formatter }
+
+  describe '.handle' do
+    before do
+      ActiveSupport::Notifications::Event.stub new: event
+      Metrics.configuration.formatter.stub new: formatter
+    end
+
+    context 'when the event is trackable' do
+      before do
+        event.stub payload: { measure: true }
+      end
+
+      it 'should handle the event' do
+        Metrics.configuration.stream.should_receive(:puts).with(formatter.to_s)
+        handler.handle
+      end
+    end
+
+    context 'when the event is not trackable' do
+      before do
+        event.stub payload: { }
+      end
+
+      it 'should not handle the event' do
+        Metrics.configuration.stream.should_receive(:puts).never
+        handler.handle
+      end
+    end
+  end
+end

data/spec/formatted-metrics/metrics_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Metrics do
+  let(:instrumenter) { ActiveSupport::Notifications }
+
+  describe '#instrument' do
+    context 'with a block' do
+      it 'instruments the duration' do
+        instrumenter.should_receive(:instrument).with('rack.request', measure: true, source: nil)
+        Metrics.instrument 'rack.request' do
+          'foo'
+        end
+      end
+
+      it 'instruments the duration with a source' do
+        instrumenter.should_receive(:instrument).with('rack.request', measure: true, source: 'foo')
+        Metrics.instrument 'rack.request', source: 'foo' do
+          'do something long'
+        end
+      end
+    end
+
+    context 'with a measurement' do
+      it 'instruments the measurement' do
+        instrumenter.should_receive(:instrument).with('rack.request', measure: 10, source: nil)
+        Metrics.instrument 'rack.request', 10
+      end
+
+      it 'instruments the measurement with a source' do
+        instrumenter.should_receive(:instrument).with('rack.request', measure: 10, source: 'foo')
+        Metrics.instrument 'rack.request', 10, source: 'foo'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'bundler/setup'
+Bundler.require

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: formatted-metrics
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eric J. Holmes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Easily output formatted metrics to stdout
+email:
+- eric@ejholmes.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- formatted-metrics.gemspec
+- lib/formatted-metrics.rb
+- lib/formatted-metrics/configuration.rb
+- lib/formatted-metrics/formatter.rb
+- lib/formatted-metrics/handler.rb
+- lib/formatted-metrics/metrics.rb
+- lib/formatted-metrics/railtie.rb
+- lib/formatted-metrics/version.rb
+- spec/formatted-metrics/formatter_spec.rb
+- spec/formatted-metrics/handler_spec.rb
+- spec/formatted-metrics/metrics_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/remind101/formatted-metrics
+licenses:
+- MIT
+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: -1041896361416376265
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1041896361416376265
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Easily output formatted metrics to stdout
+test_files:
+- spec/formatted-metrics/formatter_spec.rb
+- spec/formatted-metrics/handler_spec.rb
+- spec/formatted-metrics/metrics_spec.rb
+- spec/spec_helper.rb