formatted-metrics 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd05373a844e69ff2e42dc4e24c8c741667a7eb3
-  data.tar.gz: c0ef9a68d1c6a28239d366150f6b38896a3b2f84
+  metadata.gz: b72967d33d3eaeaefa60e66a94b4df665733bb66
+  data.tar.gz: 80529c68a14a80c2f7127385440f090a9f446383
 SHA512:
-  metadata.gz: 4bf4bf9259751cad5a97fbf7aeed66b24ae5900159b798a18e54a171ea87c6a521962c369bbdd9754e5610eb2eec7548104f0992a2e828a6784079d80cba6e98
-  data.tar.gz: e3daad6ab06807c864a4706a423164719e97015ae21338c983d55a69f637a057fea6452ef835c3f05ff3ddb614d462e46734133645ddc244d9133b1bd867370d
+  metadata.gz: 488dfe4484cbc9d34340ae4c307de143472ad257b0db4a0eae5002ca1f55069785ae1967f1d19aed1616e860790ee136b6211bb89d9665f6ff91544cf165bceb
+  data.tar.gz: 957744dc87ce70b5663d4cef80a816e46537b4a7a4c90bad0495b9750c1721a8bd1dd9ad678d99af65b56f09576add7550b8c2eda7cf6fe68b059c018706a7e9

data/formatted-metrics.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'faraday', '~> 0.9.0'
 end

data/lib/faraday/instrumentation.rb

@@ -0,0 +1,36 @@
+require 'metrics'
+require 'faraday'
+
+module Faraday
+  class Instrumentation < Faraday::Middleware
+    include Metrics::MiddlewareHelpers
+
+    def initialize(app, options = {})
+      super(app)
+      @options = { metric: 'faraday.request' }.merge(options)
+    end
+
+    def call(env)
+      time = Time.now
+      response = @app.call(env)
+      duration = (Time.now - time) * 1000.0
+
+      request_metrics response.status, duration, metric: metric, source: source(env)
+
+      response
+    end
+
+  private
+    attr_reader :options
+
+    def source(env)
+      method = env[:method]
+      path   = env[:url].path.gsub(/\//, '.')
+      "#{method}#{path}"
+    end
+
+    def metric
+      options[:metric]
+    end
+  end
+end

data/lib/metrics.rb

@@ -3,15 +3,26 @@ require 'metrics/core_ext'
 require 'metrics/railtie' if defined?(Rails)
 
 module Metrics
-  autoload :Configuration,  'metrics/configuration'
-  autoload :Instrumentable, 'metrics/instrumentable'
-  autoload :Instrumenter,   'metrics/instrumenter'
-  autoload :Grouping,       'metrics/grouping'
-  autoload :Handler,        'metrics/handler'
+  autoload :MiddlewareHelpers, 'metrics/middleware_helpers'
+  autoload :Configuration,     'metrics/configuration'
+  autoload :Instrumentable,    'metrics/instrumentable'
+  autoload :Instrumenter,      'metrics/instrumenter'
+  autoload :Grouping,          'metrics/grouping'
+  autoload :Handler,           'metrics/handler'
 
   module Formatters
-    autoload :Base,         'metrics/formatters/base'
-    autoload :L2Met,        'metrics/formatters/l2met'
+    autoload :Base,            'metrics/formatters/base'
+    autoload :L2Met,           'metrics/formatters/l2met'
+  end
+
+  module Helpers
+    def self.extract_options!(options)
+      if options.last.is_a?(Hash)
+        options.pop
+      else
+        {}
+      end
+    end
   end
 
   class << self

data/lib/metrics/grouping.rb

@@ -2,30 +2,44 @@ 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
+    attr_reader :namespace, :instrumenters, :options
     
     def self.instrument(*args, &block)
       new(*args, &block).instrumenters
     end
 
-    def initialize(namespace = nil, &block)
+    def initialize(namespace = nil, options = {}, &block)
       @instrumenters = []
       @namespace     = namespace
+      @options       = options
       block.call(self)
     end
 
     def increment(metric)
-      instrument metric, 1, type: 'count'
+      instrument metric, 1, options.merge(type: 'count')
     end
 
     def instrument(metric, *args, &block)
       metric = "#{namespace}.#{metric}" if namespace
-      instrumenters.push(Instrumenter.instrument(metric, *args, &block))
+      instrumenters.push(Instrumenter.instrument(metric, *merge_options(args), &block))
     end
 
-    def group(nested_namespace = nil, &block)
+    def group(nested_namespace = nil, *args, &block)
       ns = nested_namespace ? "#{namespace}.#{nested_namespace}" : namespace
-      instrumenters.push(*Grouping.instrument(ns, &block))
+      instrumenters.push(*Grouping.instrument(ns, *merge_options(args), &block))
     end
+
+  private
+
+    def merge_options(args)
+      opts = extract_options!(args)
+      args << options.merge(opts)
+      args
+    end
+
+    def extract_options!(options)
+      Metrics::Helpers.extract_options!(options)
+    end
+
   end
 end

data/lib/metrics/instrumenter.rb

@@ -11,7 +11,7 @@ module Metrics
   class Instrumenter
     TIME_UNITS = 'ms'.freeze
 
-    attr_reader :metric
+    attr_reader :metric, :options
 
     def self.instrument(*args, &block)
       instrument = new(*args, &block)
@@ -53,7 +53,7 @@ module Metrics
     end
 
   private
-    attr_reader :options, :block
+    attr_reader :block
 
     def timing?
       !block.nil?
@@ -68,11 +68,7 @@ module Metrics
     end
 
     def extract_options!(options)
-      if options.last.is_a?(Hash)
-        options.pop
-      else
-        {}
-      end
+      Metrics::Helpers.extract_options!(options)
     end
   end
 end

data/lib/metrics/middleware_helpers.rb

@@ -0,0 +1,32 @@
+require 'metrics/middleware_helpers'
+
+module Metrics
+  module MiddlewareHelpers
+    private
+
+    def request_metrics(status, duration, options = {})
+      metric = options[:metric]
+      source = options[:source]
+
+      group metric, source: source do |group|
+        group.instrument 'time', duration, units: 'ms'
+
+        group.group 'status' do |group|
+          group.increment status
+          group.increment "#{status.to_s[0]}xx"
+
+          group.instrument "#{status}.time", duration, units: 'ms'
+          group.instrument "#{status.to_s[0]}xx.time", duration, units: 'ms'
+        end
+      end
+    end
+
+    def instrument(*args, &block)
+      Metrics.instrument(*args, &block)
+    end
+
+    def group(*args, &block)
+      Metrics.group(*args, &block)
+    end
+  end
+end

data/lib/metrics/version.rb

@@ -1,3 +1,3 @@
 module FormattedMetrics
-  VERSION = '1.1.1'
+  VERSION = '1.1.2'
 end

data/lib/rack/instrumentation.rb

@@ -1,5 +1,9 @@
+require 'metrics/middleware_helpers'
+
 module Rack
   class Instrumentation
+    include Metrics::MiddlewareHelpers
+
     def initialize(app)
       @app = app
     end
@@ -12,7 +16,7 @@ module Rack
         response = @app.call(env)
         duration = (Time.now - time) * 1000.0
 
-        request_metrics response.first, duration
+        request_metrics response.first, duration, metric: 'rack.request'
 
         response
       rescue Exception => raised
@@ -28,28 +32,6 @@ module Rack
 
       instrument 'rack.heroku.queue.wait_time', env['HTTP_X_HEROKU_QUEUE_WAIT_TIME'].to_f, units: 'ms'
     end
-
-    def request_metrics(status, duration)
-      group 'rack.request' do |group|
-        group.instrument 'time', duration, units: 'ms'
-
-        group.group 'status' do |group|
-          group.increment status
-          group.increment "#{status.to_s[0]}xx"
-
-          group.instrument "#{status}.time", duration, units: 'ms'
-          group.instrument "#{status.to_s[0]}xx.time", duration, units: 'ms'
-        end
-      end
-    end
-
-    def instrument(*args, &block)
-      Metrics.instrument(*args, &block)
-    end
-
-    def group(*args, &block)
-      Metrics.group(*args, &block)
-    end
   end
 end
 

data/spec/faraday/instrumentation_spec.rb

@@ -0,0 +1,21 @@
+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) }
+
+  describe '.call' do
+    let(:uri) { URI.parse('http://google.com/v1/foo?param=1') }
+
+    it 'returns the response' do
+      expect(middleware.call(url: uri)).to eq response
+    end
+
+    it 'sets the source' do
+      Metrics.should_receive(:group).with('faraday.request', source: 'get.v1.foo').and_call_original
+      expect(middleware.call(method: :get, url: uri)).to eq response
+    end
+  end
+end

data/spec/metrics/grouping_spec.rb

@@ -38,5 +38,23 @@ describe Metrics::Grouping do
 
       expect(group.instrumenters.first.metric).to eq 'rack.request.time'
     end
+
+    it 'allows for options to be passed' do
+      group = described_class.new 'rack', source: 'foo' do |group|
+        group.instrument 'request.time', 500, units: 'ms'
+      end
+
+      expect(group.instrumenters.first.options).to eq(source: 'foo', units: 'ms')
+    end
+
+    it 'allows for top level options to be passed to nested groups' do
+      group = described_class.new 'rack', source: 'foo' do |group|
+        group.group 'request' do |g|
+          g.instrument 'time', 500, units: 'ms'
+        end
+      end
+
+      expect(group.instrumenters.first.options).to eq(source: 'foo', units: 'ms')
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formatted-metrics
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Eric J. Holmes
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !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
 email:
 - eric@ejholmes.net
@@ -67,6 +81,7 @@ files:
 - README.md
 - Rakefile
 - formatted-metrics.gemspec
+- lib/faraday/instrumentation.rb
 - lib/formatted-metrics.rb
 - lib/metrics.rb
 - lib/metrics/configuration.rb
@@ -77,10 +92,12 @@ files:
 - lib/metrics/handler.rb
 - lib/metrics/instrumentable.rb
 - lib/metrics/instrumenter.rb
+- lib/metrics/middleware_helpers.rb
 - lib/metrics/railtie.rb
 - lib/metrics/version.rb
 - lib/rack/instrumentation.rb
 - lib/sidekiq/middleware/server/instrumentation.rb
+- spec/faraday/instrumentation_spec.rb
 - spec/metrics/formatters/l2met_spec.rb
 - spec/metrics/grouping_spec.rb
 - spec/metrics/instrumentable_spec.rb
@@ -113,6 +130,7 @@ 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/grouping_spec.rb
 - spec/metrics/instrumentable_spec.rb