formatted-metrics 0.1.2 → 0.2.0

data/README.md

@@ -39,6 +39,18 @@ Metrics.instrument 'sidekiq.queue', source: 'background' do
   yield
 end
 # => 'source=app.background measure.sidekiq.queue=500ms'
+
+Metrics.group 'sidekiq' do
+  instrument 'queues.process', 100, units: 'jobs'
+  instrument 'workers.busy', 10, units: 'workers'
+
+  instrument 'queue.time', source: 'worker.1' do
+    sleep 1
+  end
+end
+
+# => 'source=app measure.sidekiq.queues.processed=100jobs measure.sidekiq.workers.busy=10workers'
+# => 'source=app.worker.1 measure.sidekiq.queue.time=1000.00ms'
 ```
 
 ## TODO

data/formatted-metrics.gemspec

@@ -18,8 +18,6 @@ Gem::Specification.new do |spec|
   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'

data/lib/metrics/configuration.rb

@@ -21,11 +21,11 @@ module Metrics
     end
 
     def source
-      @source ||= ENV['METRICS_SOURCE'] || ENV['APP_NAME'] || `hostname`.chomp.underscore
+      @source ||= ENV['METRICS_SOURCE'] || ENV['APP_NAME'] || `hostname`.chomp
     end
 
     def formatter
-      @formatter ||= Metrics::Formatter
+      @formatter ||= Metrics::Formatters::L2Met
     end
   end
 end

data/lib/metrics/formatters/base.rb

@@ -0,0 +1,31 @@
+module Metrics::Formatters
+  class Base
+    attr_reader :instrumenters
+
+    def self.write(*instrumenters)
+      new(*instrumenters).write
+    end
+
+    def initialize(*instrumenters)
+      @instrumenters = instrumenters.flatten
+    end
+
+    def write
+      lines.each do |line|
+        configuration.logger.info line
+      end
+      instrumenters
+    end
+
+    def lines
+      raise NotImplementedError
+    end
+
+  private
+
+    def configuration
+      Metrics.configuration
+    end
+
+  end
+end

data/lib/metrics/formatters/l2met.rb

@@ -0,0 +1,28 @@
+module Metrics::Formatters
+  class L2Met < Base
+    def lines
+      groups.map do |source, instrumenters|
+        [
+          "source=#{full_source(source)}",
+          instrumenters.map { |instrumenter| "measure.#{instrumenter.metric}=#{instrumenter.value}#{instrumenter.units}" }.join(' ')
+        ].flatten.join(' ')
+      end
+    end
+
+  private
+
+    # Internal: We group the metrics by their source so that we can separate
+    # the lines.
+    def groups
+      instrumenters.group_by(&:source)
+    end
+
+    def full_source(source=nil)
+      if source
+        [configuration.source, source].join('.')
+      else
+        configuration.source
+      end
+    end
+  end
+end

data/lib/metrics/grouping.rb

@@ -0,0 +1,22 @@
+module Metrics
+  # Public: Starts a new Grouping context, which allows for multiple
+  # instruments to output on a single line.
+  class Grouping
+    attr_reader :namespace, :instrumenters
+    
+    def self.instrument(*args, &block)
+      new(*args, &block).instrumenters
+    end
+
+    def initialize(namespace = nil, &block)
+      @instrumenters = []
+      @namespace     = namespace
+      instance_eval &block
+    end
+
+    def instrument(metric, *args, &block)
+      metric = "#{namespace}.#{metric}" if namespace
+      instrumenters << Instrumenter.instrument(metric, *args, &block)
+    end
+  end
+end

data/lib/metrics/handler.rb

@@ -1,35 +1,38 @@
-require 'active_support/core_ext/module/delegation'
-
 module Metrics
 
-  # Internal: Responsible for handling an ActiveSupport::Notifications message.
+  # Internal: Responsible for taking a list or an Array of
+  # Metrics::Instrumenters and passing them to the formatter.
   class Handler
-    attr_reader :args
+    attr_reader :instrumenters
+
+    def self.handle(*instrumenters)
+      new(*instrumenters).handle
+    end
 
-    def initialize(*args)
-      @args = args
+    def initialize(*instrumenters)
+      @instrumenters = instrumenters.flatten
     end
 
+    # Public: Writes all of the instrumenters to STDOUT using the formatter.
+    #
+    # Returns an Array of Metrics::Instrumenters that were written to STDOUT.
     def handle
-      log if trackable?
+      write instrumenters
     end
 
   private
 
-    delegate :configuration, to: :'Metrics'
-
-    def trackable?
-      event.payload[:measure]
+    def configuration
+      Metrics.configuration
     end
 
-    def event
-      @event ||= ActiveSupport::Notifications::Event.new(*args)
+    def write(*args, &block)
+      formatter.write(*args, &block)
     end
 
-    def log
-      configuration.logger.info configuration.formatter.new(event).to_s
+    def formatter
+      configuration.formatter
     end
-
+  
   end
-
 end

data/lib/metrics/instrumentable.rb

@@ -1,8 +1,9 @@
-require 'active_support/concern'
-
 module Metrics
   module Instrumentable
-    extend ActiveSupport::Concern
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
 
     # Public: See Metrics.instrument.
     #

data/lib/metrics/instrumenter.rb

@@ -0,0 +1,64 @@
+module Metrics
+  # Public: Responsible for sampling a measurement of something.
+  #
+  # metric - The name of the metric to measure (e.g. rack.request.time)
+  #
+  # Returns a new Metrics::Instrumenter.
+  class Instrumenter
+    TIME_UNITS = 'ms'.freeze
+
+    attr_reader :metric
+
+    def self.instrument(*args, &block)
+      instrument = new(*args, &block)
+      instrument.value
+      instrument
+    end
+
+    def initialize(metric, *args, &block)
+      @metric  = metric
+      @options = extract_options!(args)
+      @block   = block
+      @value   = args.first if args.length > 0
+    end
+
+    # Public: Runs the instrumenter.
+    #
+    # Returns the run time if a block was supplied.
+    # Returns the value if the 
+    def value
+      timing? ? time : @value
+    end
+
+    def units
+      timing? ? TIME_UNITS : options[:units]
+    end
+
+    def source
+      options[:source]
+    end
+
+  private
+    attr_reader :options, :block
+
+    def timing?
+      !block.nil?
+    end
+
+    def time
+      @time ||= begin
+        start = Time.now
+        block.call
+        (Time.now - start) * 1000.0
+      end
+    end
+
+    def extract_options!(options)
+      if options.last.is_a?(Hash)
+        options.pop
+      else
+        {}
+      end
+    end
+  end
+end

data/lib/metrics/version.rb

@@ -1,3 +1,3 @@
 module FormattedMetrics
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/metrics.rb

@@ -1,24 +1,21 @@
-require 'active_support/notifications'
-require 'active_support/core_ext/array/extract_options'
-require 'active_support/dependencies/autoload'
-
 require 'metrics/railtie' if defined?(Rails)
 
 module Metrics
-  extend ActiveSupport::Autoload
+  autoload :Configuration,  'metrics/configuration'
+  autoload :Instrumentable, 'metrics/instrumentable'
+  autoload :Instrumenter,   'metrics/instrumenter'
+  autoload :Grouping,       'metrics/grouping'
+  autoload :Handler,        'metrics/handler'
 
-  autoload :Configuration
-  autoload :Handler
-  autoload :Formatter
-  autoload :Instrumentable
+  module Formatters
+    autoload :Base,         'metrics/formatters/base'
+    autoload :L2Met,        'metrics/formatters/l2met'
+  end
 
   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.
@@ -35,35 +32,28 @@ module Metrics
     #   end
     #
     # Returns nothing.
-    def instrument(metric, *args, &block)
-      options = args.extract_options!
-
-      measure = if args.empty?
-        block_given? ? true : 1
-      else
-        args.first
-      end
-
-      ActiveSupport::Notifications.instrument(
-        metric,
-        options.merge(measure: measure, source: options[:source]),
-        &block
-      )
+    def instrument(*args, &block)
+      Handler.handle(Instrumenter.instrument(*args, &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.
+    # Public: Group multiple instruments.
     #
     # Example
     #
-    #   Metrics.setup
+    #   Metrics.group 'sidekiq' do
+    #     instrument 'request.time' do
+    #       begin
+    #         @app.call(env)
+    #       rescue Exception => e
+    #         instrument 'exceptions', 1
+    #         raise
+    #       end
+    #     end
+    #   end
     #
     # Returns nothing.
-    def subscribe
-      ActiveSupport::Notifications.subscribe /.*/ do |*args|
-        Metrics::Handler.new(*args).handle
-      end
+    def group(*args, &block)
+      Handler.handle(Grouping.instrument(*args, &block))
     end
 
     def configuration

data/spec/metrics/formatters/l2met_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Metrics::Formatters::L2Met do
+  let(:formatter) { described_class.new *instrumenters }
+
+  before do
+    Metrics.configuration.stub source: 'app'
+  end
+
+  def instrumenter(values)
+    double Metrics::Instrumenter, { source: nil }.merge(values)
+  end
+
+  describe '.lines' do
+    subject(:format) { formatter.lines }
+
+    context 'with a single instrumenter' do
+      let(:instrumenters) { [ instrumenter(metric: 'rack.request.time', value: 10, units: 'ms') ] }
+      it { should eq ['source=app measure.rack.request.time=10ms'] }
+    end
+
+    context 'with multiple instrumenters' do
+      let(:instrumenters) do
+        [ instrumenter(metric: 'rack.request.time', value: 10, units: 'ms'),
+          instrumenter(metric: 'jobs.busy', value: 10, units: 'jobs') ]
+      end
+
+      it { should eq ['source=app measure.rack.request.time=10ms measure.jobs.busy=10jobs'] }
+    end
+
+    context 'with multiple metrics from different sources' do
+      let(:instrumenters) do
+        [ instrumenter(metric: 'rack.request.time', value: 10, units: 'ms'),
+          instrumenter(metric: 'jobs.queued', value: 15, units: 'jobs', source: 'foo'),
+          instrumenter(metric: 'jobs.busy', value: 10, units: 'jobs', source: 'foo') ]
+      end
+
+      it { should eq ['source=app measure.rack.request.time=10ms', 'source=app.foo measure.jobs.queued=15jobs measure.jobs.busy=10jobs'] }
+    end
+  end
+end

data/spec/metrics/grouping_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Metrics::Grouping do
+  describe '.instrumenters' do
+    it 'builds instruments' do
+      group = described_class.new do
+        instrument 'jobs.busy', 10
+        instrument 'rack.request.time', 500, units: 'ms'
+      end
+
+      expect(group.instrumenters).to have(2).instrumenters
+    end
+
+    it 'allows a namespace to be provided' do
+      group = described_class.new 'rack' do
+        instrument 'request.time', 500, units: 'ms'
+      end
+
+      expect(group.instrumenters.first.metric).to eq 'rack.request.time'
+    end
+  end
+end

data/spec/metrics/instrumenter_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Metrics::Instrumenter do
+  let(:instrumenter) { described_class.new('rack.request') { } }
+
+  describe '.value' do
+    subject { instrumenter.value }
+
+    context 'with a value' do
+      let(:instrumenter) { described_class.new('rack.request', 500) }
+      it { should eq 500 }
+    end
+
+    context 'with a block' do
+      before { Time.should_receive(:now).and_return(Time.at(1), Time.at(3)) }
+      it { should eq 2000.0 }
+    end
+  end
+
+  describe '.units' do
+    subject { instrumenter.units }
+
+    context 'with a block' do
+      it { should eq 'ms' }
+    end
+
+    context 'when specified' do
+      let(:instrumenter) { described_class.new('jobs.busy', 10, units: 'jobs') }
+      it { should eq 'jobs' }
+    end
+  end
+
+  describe '.source' do
+    subject { instrumenter.source }
+
+    context 'by default' do
+      it { should be_nil }
+    end
+
+    context 'when specified' do
+      let(:instrumenter) { described_class.new('jobs.busy', 10, units: 'jobs', source: 'sidekiq') }
+      it { should eq 'sidekiq' }
+    end
+  end
+end

data/spec/metrics_spec.rb

@@ -1,42 +1,21 @@
 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
+    it 'delegates to Metrics::Instrumenter' do
+      instrumenter = double Metrics::Instrumenter
+      Metrics::Instrumenter.should_receive(:instrument).with('rack.request', 10).and_return(instrumenter)
+      Metrics::Handler.should_receive(:handle).with(instrumenter)
+      Metrics.instrument 'rack.request', 10
     end
+  end
 
-    context 'with empty no block and no measurement' do
-      it 'instruments with a measurement of 1' do
-        instrumenter.should_receive(:instrument).with('exception', measure: 1, source: nil)
-        Metrics.instrument 'exception'
-      end
+  describe '#group' do
+    it 'delegates to Metrics::Grouping' do
+      grouping = double Metrics::Grouping
+      Metrics::Grouping.should_receive(:instrument).and_return(grouping)
+      Metrics::Handler.should_receive(:handle).with(grouping)
+      Metrics.group { instrument 'rack.request', 10 }
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formatted-metrics
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-06 00:00:00.000000000 Z
+date: 2013-08-07 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
@@ -93,14 +77,18 @@ files:
 - lib/formatted-metrics.rb
 - lib/metrics.rb
 - lib/metrics/configuration.rb
-- lib/metrics/formatter.rb
+- lib/metrics/formatters/base.rb
+- lib/metrics/formatters/l2met.rb
+- lib/metrics/grouping.rb
 - lib/metrics/handler.rb
 - lib/metrics/instrumentable.rb
+- lib/metrics/instrumenter.rb
 - lib/metrics/railtie.rb
 - lib/metrics/version.rb
-- spec/metrics/formatter_spec.rb
-- spec/metrics/handler_spec.rb
+- spec/metrics/formatters/l2met_spec.rb
+- spec/metrics/grouping_spec.rb
 - spec/metrics/instrumentable_spec.rb
+- spec/metrics/instrumenter_spec.rb
 - spec/metrics_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/remind101/formatted-metrics
@@ -118,7 +106,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1246572699261836643
+      hash: -1552981004150797655
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -127,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1246572699261836643
+      hash: -1552981004150797655
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -135,8 +123,9 @@ signing_key:
 specification_version: 3
 summary: Easily output formatted metrics to stdout
 test_files:
-- spec/metrics/formatter_spec.rb
-- spec/metrics/handler_spec.rb
+- spec/metrics/formatters/l2met_spec.rb
+- spec/metrics/grouping_spec.rb
 - spec/metrics/instrumentable_spec.rb
+- spec/metrics/instrumenter_spec.rb
 - spec/metrics_spec.rb
 - spec/spec_helper.rb

data/lib/metrics/formatter.rb

@@ -1,53 +0,0 @@
-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/spec/metrics/formatter_spec.rb

@@ -1,36 +0,0 @@
-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/metrics/handler_spec.rb

@@ -1,38 +0,0 @@
-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.logger.should_receive(:info).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.logger.should_receive(:info).never
-        handler.handle
-      end
-    end
-  end
-end