formatted-metrics 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1b6315788115f3dec6f76777cbd7cc6bb4fb5c5
-  data.tar.gz: fc2d26549dfbfc21f2df6f33342304a888e21ae6
+  metadata.gz: f61de2711adaea249e6fc4f6eb53d9899ed805ef
+  data.tar.gz: 5292dea3deae43f089de2eeb20d0512acbd3aebb
 SHA512:
-  metadata.gz: a9d1a8c00d92e3354ba7ac7fba98ae2648ef789853d88b9e5e87b4b8a9dff16cc2774a74e4791fb5730306a70b8f062d6280f5ad0c2dcf9e967b2733eba748fa
-  data.tar.gz: e1e1b00fbe7724f47a3d492ffd7ad0793d06bec3435197bfc6ad6e923fcdd263e3cb466d3bc39ca7bc0c1331d5298fb9d772e293d5d1859d9b65e597ae22563c
+  metadata.gz: 7c34b9936b1ae2ea1c6504e85432c9c0a7a63384cb063799e1be98f94702c652dec05d993c432152f47f9132d19fc6cc0cb86e945041dc1d4ecc2650d395a931
+  data.tar.gz: 330e3349dbc4848df534f4a9d85bff0ca0a187897cda130500d9bf89f9dcf631cd595634a39c484ed0e46ac3dbe6869112af4ca7617fe78cf9909d2b830d7634

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/remind101/formatted-metrics.png)](https://travis-ci.org/remind101/formatted-metrics) [![Code Climate](https://codeclimate.com/github/remind101/formatted-metrics.png)](https://codeclimate.com/github/remind101/formatted-metrics)
 
-Easily produce metrics that can be consumed by [l2met](https://github.com/ryandotsmith/l2met).
+Easily produce metrics that can be consumed by [l2met](https://github.com/ryandotsmith/l2met) or statsd.
 
 ## Installation
 

data/lib/metrics.rb

@@ -10,9 +10,10 @@ module Metrics
   autoload :Grouping,          'metrics/grouping'
   autoload :Handler,           'metrics/handler'
 
-  module Formatters
-    autoload :Base,            'metrics/formatters/base'
-    autoload :L2Met,           'metrics/formatters/l2met'
+  module Drivers
+    autoload :Base,            'metrics/drivers/base'
+    autoload :L2Met,           'metrics/drivers/l2met'
+    autoload :Statsd,          'metrics/drivers/statsd'
   end
 
   module Helpers
@@ -65,8 +66,9 @@ module Metrics
     #   end
     #
     # Returns nothing.
-    def group(*args, &block)
-      Handler.handle(Grouping.instrument(*args, &block))
+    def group(namespace = nil, options = {}, &block)
+      instrumenters = Grouping.instrument(namespace, &block)
+      Handler.handle(*instrumenters)
     end
 
     def subscribe

data/lib/metrics/configuration.rb

@@ -2,15 +2,24 @@ require 'logger'
 
 module Metrics
   class Configuration
+    # The driver to use.
+    #
+    # Drivers are objects that implement the following method:
+    #
+    #     driver.write(*instrumenters) # => instrumenters written
+    #
+    # Defaults to Metrics::Drivers::L2Met.new(logger, source).
+    attr_accessor :driver
+
     # The stream source to write to. Defaults to STDOUT.
     attr_accessor :logger
 
     # 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 driver
+      @driver ||= Metrics::Drivers::L2Met.new(logger, source)
+    end
 
     def logger
       @logger ||= Logger.new(STDOUT).tap { |log| log.formatter = log_formatter }
@@ -24,9 +33,5 @@ module Metrics
       return @source if defined? @source
       @source = ENV['METRICS_SOURCE'] || ENV['APP_NAME'] || `hostname`.chomp
     end
-
-    def formatter
-      @formatter ||= Metrics::Formatters::L2Met
-    end
   end
 end

data/lib/metrics/{formatters → drivers}/l2met.rb

@@ -1,11 +1,24 @@
-module Metrics::Formatters
+module Metrics::Drivers
   PRECISION = 3.freeze
 
-  class L2Met < Base
+  class L2Met
+    attr_reader :logger, :source_prefix
+    def initialize(logger, source_prefix)
+      @logger = logger
+      @source_prefix = source_prefix
+    end
+
+    def write(*instrumenters)
+      lines(instrumenters).each do |line|
+        logger.info line
+      end
+      instrumenters
+    end
+
     # Example
     # source=web.2 sample#load_avg_1m=0.31 sample#load_avg_5m=0.10 sample#load_avg_15m=0.05
-    def lines
-      groups.map do |source, instrumenters|
+    def lines(instrumenters)
+      groups(instrumenters).map do |source, instrumenters|
         measurements = instrumenters.map { |instrumenter| measurement(instrumenter) }
         Lines.new(full_source(source), measurements).lines
       end.flatten
@@ -15,12 +28,12 @@ module Metrics::Formatters
 
     # Internal: We group the metrics by their source so that we can separate
     # the lines.
-    def groups
+    def groups(instrumenters)
       instrumenters.group_by(&:source)
     end
 
     def full_source(source=nil)
-      [configuration.source, source].reject { |s| blank?(s) }.join('.')
+      [source_prefix, source].reject { |s| blank?(s) }.join('.')
     end
 
     def measurement(instrumenter)

data/lib/metrics/drivers/statsd.rb

@@ -0,0 +1,46 @@
+module Metrics::Drivers
+  class Statsd
+    attr_reader :client, :template, :source_prefix
+
+    def initialize(client, template, source_prefix)
+      @client        = client        # The statsd client
+      @template      = template      # The template for the metric name
+      @source_prefix = source_prefix # Source prefix
+    end
+
+    def write(*instrumenters)
+      instrumenters.each do |instrumenter|
+        emit(instrumenter)
+      end
+      instrumenters
+    end
+
+    def emit(instrumenter)
+      name = name_for(instrumenter)
+      value = instrumenter.value
+
+      case instrumenter.type
+      when 'measure', 'sample'
+        if instrumenter.units == 'ms'
+          client.timing(name, value)
+        else
+          client.gauge(name, value)
+        end
+      when 'count'
+        client.count(name, value)
+      else
+        raise ArgumentError.new("unsupported instrumenter type for statsd: '%s'" % instrumenter.type)
+      end
+    end
+
+    private
+
+    def name_for(instrumenter)
+      template.gsub('{{name}}', instrumenter.metric).gsub('{{source}}', source(instrumenter))
+    end
+
+    def source(instrumenter)
+      [source_prefix, instrumenter.source].compact.join('.')
+    end
+  end
+end

data/lib/metrics/grouping.rb

@@ -3,9 +3,9 @@ module Metrics
   # instruments to output on a single line.
   class Grouping
     attr_reader :namespace, :instrumenters, :options
-    
-    def self.instrument(*args, &block)
-      new(*args, &block).instrumenters
+
+    def self.instrument(namespace = nil, options = {}, &block)
+      new(namespace, options, &block).instrumenters
     end
 
     def initialize(namespace = nil, options = {}, &block)

data/lib/metrics/handler.rb

@@ -1,7 +1,7 @@
 module Metrics
 
   # Internal: Responsible for taking a list or an Array of
-  # Metrics::Instrumenters and passing them to the formatter.
+  # Metrics::Instrumenters and passing them to the driver.
   class Handler
     attr_reader :instrumenters
 
@@ -10,34 +10,27 @@ module Metrics
     end
 
     def initialize(*instrumenters)
-      @instrumenters = instrumenters.flatten
+      @instrumenters = instrumenters
     end
 
-    # Public: Writes all of the instrumenters to STDOUT using the formatter.
+    # Public: Writes all of the instrumenters to the driver.
     #
-    # Returns an Array of Metrics::Instrumenters that were written to STDOUT.
+    # Returns an Array of Metrics::Instrumenters that were written.
     def handle
-      write instrumenters
-      result
+      return write(*instrumenters)
     end
 
   private
+    def write(*instrumenters)
+      driver.write(*instrumenters)
+    end
 
-    def result
-      instrumenters.last.result
+    def driver
+      configuration.driver
     end
 
     def configuration
       Metrics.configuration
     end
-
-    def write(*args, &block)
-      formatter.write(*args, &block)
-    end
-
-    def formatter
-      configuration.formatter
-    end
-  
   end
 end

data/lib/metrics/middleware_helpers.rb

@@ -25,8 +25,8 @@ module Metrics
       Metrics.instrument(*args, &block)
     end
 
-    def group(*args, &block)
-      Metrics.group(*args, &block)
+    def group(namespace, options, &block)
+      Metrics.group(namespace, options, &block)
     end
   end
 end

data/lib/metrics/version.rb

@@ -1,3 +1,3 @@
 module FormattedMetrics
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/spec/faraday/instrumentation_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 require 'faraday/instrumentation'
 
 describe Faraday::Instrumentation do
+
   let(:response) { double('response', status: 200) }
   let(:app) { double('app', call: response) }
   let(:middleware) { described_class.new(app) }

data/spec/metrics/{formatters → drivers}/l2met_spec.rb

@@ -1,19 +1,15 @@
 require 'spec_helper'
 require 'securerandom'
 
-describe Metrics::Formatters::L2Met do
-  let(:formatter) { described_class.new *instrumenters }
-
-  before do
-    Metrics.configuration.stub source: 'app'
-  end
+describe Metrics::Drivers::L2Met do
+  let(:driver) { described_class.new(Logger.new('/dev/null'), 'app') }
 
   def instrumenter(values)
     double Metrics::Instrumenter, { source: nil, type: 'measure' }.merge(values)
   end
 
   describe '.lines' do
-    subject(:lines) { formatter.lines }
+    subject(:lines) { driver.lines(instrumenters) }
 
     context 'with a single instrumenter' do
       let(:instrumenters) { [ instrumenter(metric: 'rack.request.time', value: 10.3333, units: 'ms', type: 'sample') ] }

data/spec/metrics/drivers/statsd_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'securerandom'
+
+describe Metrics::Drivers::Statsd do
+  let(:client) { double }
+
+  def instrumenter(*args)
+    Metrics::Instrumenter.new(*args)
+  end
+
+  def write(*instrumenters)
+    described_class.new(client, '{{name}}.source__{{source}}__', 'app').write(*instrumenters)
+  end
+
+  describe '.write' do
+    context 'metric types' do
+      it 'should call statsd.timing' do
+        client.should_receive(:timing).with('rack.request.time.source__app__', 10.3333)
+        write(instrumenter('rack.request.time', 10.3333, units: 'ms', type: 'sample'))
+      end
+
+      it 'should call statsd.gauge' do
+        client.should_receive(:gauge).with('rack.request.size.source__app__', 10)
+        write(instrumenter('rack.request.size', 10, type: 'measure'))
+      end
+
+      it 'should call statsd.count' do
+        client.should_receive(:count).with('foo.bar.source__app__', 10)
+        write(instrumenter('foo.bar', 10, type: 'count'))
+      end
+    end
+
+    context 'metric sources' do
+      it 'should insert the globally configured source' do
+        client.should_receive(:count).with('foo.bar.source__app__', 10)
+        write(instrumenter('foo.bar', 10, type: 'count'))
+      end
+
+      it 'should append the instrumenter source' do
+        client.should_receive(:count).with('foo.bar.source__app.us__', 10)
+        write(instrumenter('foo.bar', 10, type: 'count', source: 'us'))
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,2 +1,4 @@
 require 'bundler/setup'
 Bundler.require
+
+Metrics.configuration.driver = Metrics::Drivers::L2Met.new(Logger.new('/dev/null'), 'app')

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: formatted-metrics
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Eric J. Holmes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-09 00:00:00.000000000 Z
+date: 2015-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
 description: Easily output formatted metrics to stdout
@@ -73,9 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -86,8 +86,8 @@ files:
 - lib/metrics.rb
 - lib/metrics/configuration.rb
 - lib/metrics/core_ext.rb
-- lib/metrics/formatters/base.rb
-- lib/metrics/formatters/l2met.rb
+- lib/metrics/drivers/l2met.rb
+- lib/metrics/drivers/statsd.rb
 - lib/metrics/grouping.rb
 - lib/metrics/handler.rb
 - lib/metrics/instrumentable.rb
@@ -98,7 +98,8 @@ files:
 - lib/rack/instrumentation.rb
 - lib/sidekiq/middleware/server/instrumentation.rb
 - spec/faraday/instrumentation_spec.rb
-- spec/metrics/formatters/l2met_spec.rb
+- spec/metrics/drivers/l2met_spec.rb
+- spec/metrics/drivers/statsd_spec.rb
 - spec/metrics/grouping_spec.rb
 - spec/metrics/instrumentable_spec.rb
 - spec/metrics/instrumenter_spec.rb
@@ -115,26 +116,28 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Easily output formatted metrics to stdout
 test_files:
 - spec/faraday/instrumentation_spec.rb
-- spec/metrics/formatters/l2met_spec.rb
+- spec/metrics/drivers/l2met_spec.rb
+- spec/metrics/drivers/statsd_spec.rb
 - spec/metrics/grouping_spec.rb
 - spec/metrics/instrumentable_spec.rb
 - spec/metrics/instrumenter_spec.rb
 - spec/metrics_spec.rb
 - spec/rack/instrumentation_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/lib/metrics/formatters/base.rb

@@ -1,31 +0,0 @@
-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