formatted-metrics 1.3.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e34fb0eb47e3322da0002729515a63f9a739f59
-  data.tar.gz: 8c02e2121204d4431cc2a16641ccba75246a5751
+  metadata.gz: 05827edaccbe8c352e7a7917205ab3847358414a
+  data.tar.gz: 8a8f41fcd65745cc921abfc86e2fe121997ef3a6
 SHA512:
-  metadata.gz: 0d33c359d5e6b49ea67bd85b4c1e88d155bcdb99f14655daa386548fc1a94cbbe0a32c6dc5d56ed879dbe1c7c6ef41b9c6cadb1a67100b1730ff491717dd82e8
-  data.tar.gz: 03f173d4bca12f951359a75cce422ea7da12d1bcf2d96b332a1528a273426d8bec91c4dd07dd3c2782c878c7cdf4b14d51bc6db745020c72ba40e19b75486bf0
+  metadata.gz: 884c1f799016fbd47d7fb629d9bd024a3d255c992935413a3c817dc5f11d48e98a931cbe87a35a510584bb4b7d8d8abbac204b80684355fe7c0913211d86966d
+  data.tar.gz: 293a0d7b835fe274f9eec139f6b19c6db6a1a8aa3ac5ef32b6123c342fb16f2fdc1d10dc33db41425930738160c5710f12925f9b7e4ecfd3dfc096212a8c7222

data/lib/metrics.rb

@@ -15,6 +15,7 @@ module Metrics
     autoload :Base,            'metrics/drivers/base'
     autoload :L2Met,           'metrics/drivers/l2met'
     autoload :Statsd,          'metrics/drivers/statsd'
+    autoload :DogStatsd,       'metrics/drivers/dog_statsd'
   end
 
   module Helpers

data/lib/metrics/drivers/dog_statsd.rb

@@ -0,0 +1,32 @@
+module Metrics::Drivers
+  class DogStatsd < Statsd
+
+    def emit(instrumenter)
+      name = name_for(instrumenter)
+      value = instrumenter.value
+      tags = formatted_tags(instrumenter.tags)
+
+      case instrumenter.type
+        when 'histogram'
+          client.histogram(name, value, tags: tags)
+        when 'measure', 'sample'
+          if instrumenter.units == 'ms'
+            client.timing(name, value, tags: tags)
+          else
+            client.gauge(name, value, tags: tags)
+          end
+        when 'count'
+          client.count(name, value, tags: tags)
+        else
+          raise ArgumentError.new("unsupported instrumenter type for dogstatsd: '%s'" % instrumenter.type)
+      end
+    end
+
+    private
+
+    def formatted_tags(tags)
+      tags.map { |k, v| "%s:%s" % [k, v.to_s.tr(' ', '_')] }
+    end
+
+  end
+end

data/lib/metrics/instrumenter.rb

@@ -46,6 +46,10 @@ module Metrics
       options[:source]
     end
 
+    def tags
+      options[:tags] || {}
+    end
+
     def result
       return nil unless block
       return @result if defined?(@result)

data/lib/metrics/version.rb

@@ -1,3 +1,3 @@
 module FormattedMetrics
-  VERSION = '1.3.3'
+  VERSION = '1.4.0'
 end

data/spec/metrics/drivers/dog_statsd_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'securerandom'
+
+describe Metrics::Drivers::DogStatsd 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 'tag support' do
+
+      it 'should pass an empty tag array if no tags are given' do
+        client.should_receive(:timing).with('rack.request.time.source__app__', 10.3333, tags: [])
+        write(instrumenter('rack.request.time', 10.3333, units: 'ms', type: 'sample'))
+      end
+
+      it 'should pass a tag to the dogstatsd-ruby client' do
+        client.should_receive(:gauge).with('rack.request.size.source__app__', 10, tags: ['tag0:long_value_with_lots_of_whitespace'])
+        write(instrumenter('rack.request.size', 10, type: 'measure', tags: {tag0: 'long value with lots of whitespace'}))
+      end
+
+      it 'should pass multiple tags to the dogstatsd-ruby client' do
+        client.should_receive(:count).with('foo.bar.source__app__', 10, tags: ['tag0:value0', 'tag1:a_tag_value', 'tag2:2222'])
+        write(instrumenter('foo.bar', 10, type: 'count', tags: {tag0: 'value0', tag1: :a_tag_value, tag2: 2222}))
+      end
+    end
+
+  end
+end

data/spec/metrics/instrumenter_spec.rb

@@ -43,6 +43,19 @@ describe Metrics::Instrumenter do
     end
   end
 
+  describe '.tags' do
+    subject { instrumenter.tags }
+
+    context 'by default' do
+      it {should eq Hash.new }
+    end
+
+    context 'when specified' do
+      let(:instrumenter) { described_class.new('jobs.busy', 10, units: 'jobs', tags: {tag0: 'value0', tag1: 'value1'}) }
+      it {should eq({tag0: 'value0', tag1: 'value1'})}
+    end
+  end
+
   describe '.result' do
     subject { instrumenter.result }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: formatted-metrics
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Eric J. Holmes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-11 00:00:00.000000000 Z
+date: 2016-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,6 +86,7 @@ files:
 - lib/metrics.rb
 - lib/metrics/configuration.rb
 - lib/metrics/core_ext.rb
+- lib/metrics/drivers/dog_statsd.rb
 - lib/metrics/drivers/l2met.rb
 - lib/metrics/drivers/statsd.rb
 - lib/metrics/grouping.rb
@@ -99,6 +100,7 @@ files:
 - lib/rack/instrumentation.rb
 - lib/sidekiq/middleware/server/instrumentation.rb
 - spec/faraday/instrumentation_spec.rb
+- spec/metrics/drivers/dog_statsd_spec.rb
 - spec/metrics/drivers/l2met_spec.rb
 - spec/metrics/drivers/statsd_spec.rb
 - spec/metrics/grouping_spec.rb
@@ -134,6 +136,7 @@ specification_version: 4
 summary: Easily output formatted metrics to stdout
 test_files:
 - spec/faraday/instrumentation_spec.rb
+- spec/metrics/drivers/dog_statsd_spec.rb
 - spec/metrics/drivers/l2met_spec.rb
 - spec/metrics/drivers/statsd_spec.rb
 - spec/metrics/grouping_spec.rb