metricsd 0.2.3 → 0.2.4

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree
+  - jruby
+
+notifications:
+  recipients:
+    - kpumuk@kpumuk.info

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.2.4 (August 11, 2011)
+
+Features:
+
+  - Time metrics should be recorded with ".time" suffix (was "\_time"), status metrics - with ".status" suffix (was "_count")
+  - Added Client#record methods (alias of record_value)
+  - Changed group separator to "." (was "$")
+  - Removed separator option (it was a temporary solution)
+
 ## 0.2.3 (July 27, 2011)
 
 Features:

data/lib/metricsd/client.rb

@@ -44,8 +44,8 @@ module Metricsd
   #
   #   # Group metrics using :group option.
   #   Metricsd::Client.record_success("reads", :source => @hbase_table, :group => 'hbase')
-  #   # Group metrics using special syntax "group$metric".
-  #   Metricsd::Client.record_success("hbase$reads", :source => @hbase_table)
+  #   # Group metrics using special syntax "group.metric".
+  #   Metricsd::Client.record_success("hbase.reads", :source => @hbase_table)
   #
   class Client
     class << self
@@ -60,15 +60,13 @@ module Metricsd
       # @param [Boolean] is_success indicating whether request was successful.
       # @param [Float] time floating point number of seconds.
       # @param [Hash] opts options.
-      # @option opts [String] :sep ("_") separator used to add suffixes +count+ and +time+.
       # @option opts [String] :group metrics group.
       # @option opts [String] :source metric source.
       #
       def record_hit(metric, is_success, time, opts = {})
-        sep = opts[:sep] || opts[:separator] || '_'
         record_internal({
-            "#{metric}#{sep}count" => is_success ? 1 : -1,
-            "#{metric}#{sep}time"  => (time * 1000).round
+            "#{metric}.status" => is_success ? 1 : -1,
+            "#{metric}.time"   => (time * 1000).round
           }, opts
         )
       end
@@ -80,13 +78,11 @@ module Metricsd
       #
       # @param [String] metric is the metric name (like app.docs.upload)
       # @param [Hash] opts options.
-      # @option opts [String] :sep ("_") separator used to add suffixes +count+ and +time+.
       # @option opts [String] :group metrics group.
       # @option opts [String] :source metric source.
       #
       def record_success(metric, opts = {})
-        sep = opts[:sep] || opts[:separator] || '_'
-        record_internal({"#{metric}#{sep}count" => 1}, opts)
+        record_internal({"#{metric}.status" => 1}, opts)
       end
 
       # Record failed boolean event.
@@ -96,13 +92,11 @@ module Metricsd
       #
       # @param [String] metric is the metric name (like app.docs.upload)
       # @param [Hash] opts options.
-      # @option opts [String] :sep ("_") separator used to add suffixes +count+ and +time+.
       # @option opts [String] :group metrics group.
       # @option opts [String] :source metric source.
       #
       def record_failure(metric, opts = {})
-        sep = opts[:sep] || opts[:separator] || '_'
-        record_internal({"#{metric}#{sep}count" => -1}, opts)
+        record_internal({"#{metric}.status" => -1}, opts)
       end
 
       # Record timing info. Time should be a floating point
@@ -114,18 +108,16 @@ module Metricsd
       # @param [String] metric is the metric name (like app.docs.upload)
       # @param [Float] time floating point number of seconds.
       # @param [Hash] opts options.
-      # @option opts [String] :sep ("_") separator used to add suffixes +count+ and +time+.
       # @option opts [String] :group metrics group.
       # @option opts [String] :source metric source.
       #
       def record_time(metric, time = nil, opts = {}, &block)
         opts, time = time, nil if Hash === time
-        sep = opts[:sep] || opts[:separator] || '_'
         if time.nil?
           raise ArgumentError, "You should pass a block if time is not given" unless block_given?
           time = Benchmark.measure(&block).real
         end
-        record_internal({"#{metric}#{sep}time" => (time * 1000).round}, opts)
+        record_internal({"#{metric}.time" => (time * 1000).round}, opts)
       end
 
       # Record an integer value.
@@ -136,13 +128,13 @@ module Metricsd
       # @param [String] metric is the metric name (like app.docs.upload)
       # @param [Integer] value metric value.
       # @param [Hash] opts options.
-      # @option opts [String] :sep ("_") separator used to add suffixes +count+ and +time+.
       # @option opts [String] :group metrics group.
       # @option opts [String] :source metric source.
       #
       def record_value(metric, value, opts = {})
         record_internal({metric => value.round}, opts)
       end
+      alias :record :record_value
 
       # Record multiple integer values.
       #
@@ -151,7 +143,6 @@ module Metricsd
       #
       # @param [Hash] metrics a +Hash+ that maps metrics names to their values.
       # @param [Hash] opts options.
-      # @option opts [String] :sep ("_") separator used to add suffixes +count+ and +time+.
       # @option opts [String] :group metrics group.
       # @option opts [String] :source metric source.
       #
@@ -225,7 +216,7 @@ module Metricsd
       # protocol.
       def pack(key, value, opts)
         group = opts[:group] || Metricsd.default_group || ''
-        key = "#{group}$#{key}" unless group.empty?
+        key = "#{group}.#{key}" unless group.empty?
         opts[:source].empty? ? "#{key}:#{value}" : "#{opts[:source]}@#{key}:#{value}"
       end
     end

data/lib/metricsd/version.rb

@@ -1,3 +1,3 @@
 module Metricsd
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/spec/client_spec.rb

@@ -34,98 +34,83 @@ describe Metricsd::Client do
 
   describe '.record_hit' do
     it 'should send two metrics in a single packet' do
-      @socket.should_receive(:send).with('all@custom.metric_count:1;all@custom.metric_time:450', 0)
+      @socket.should_receive(:send).with('all@custom.metric.status:1;all@custom.metric.time:450', 0)
       Metricsd::Client.record_hit('custom.metric', true, 0.45)
     end
 
     it 'should handle is_success=false' do
-      @socket.should_receive(:send).with('all@custom.metric_count:-1;all@custom.metric_time:450', 0)
+      @socket.should_receive(:send).with('all@custom.metric.status:-1;all@custom.metric.time:450', 0)
       Metricsd::Client.record_hit('custom.metric', false, 0.45)
     end
 
-    it 'should change separator if :sep option is specified' do
-      @socket.should_receive(:send).with('all@custom.metric!count:1;all@custom.metric!time:450', 0)
-      Metricsd::Client.record_hit('custom.metric', true, 0.45, :sep => '!')
-    end
-
     it 'should apply group to both the metrics' do
-      @socket.should_receive(:send).with('all@test$custom.metric_count:1;all@test$custom.metric_time:450', 0)
+      @socket.should_receive(:send).with('all@test.custom.metric.status:1;all@test.custom.metric.time:450', 0)
       Metricsd::Client.record_hit('custom.metric', true, 0.45, :group => 'test')
     end
 
     it 'should apply source if empty string passed' do
-      @socket.should_receive(:send).with('test@custom.metric_count:1;test@custom.metric_time:450', 0)
+      @socket.should_receive(:send).with('test@custom.metric.status:1;test@custom.metric.time:450', 0)
       Metricsd::Client.record_hit('custom.metric', true, 0.45, :source => '')
     end
 
     it 'should apply source if specified' do
-      @socket.should_receive(:send).with('test2@custom.metric_count:1;test2@custom.metric_time:450', 0)
+      @socket.should_receive(:send).with('test2@custom.metric.status:1;test2@custom.metric.time:450', 0)
       Metricsd::Client.record_hit('custom.metric', true, 0.45, :source => 'test2')
     end
   end
 
   describe '.record_success' do
     it 'should record successes' do
-      @socket.should_receive(:send).with('all@custom.metric_count:1', 0)
+      @socket.should_receive(:send).with('all@custom.metric.status:1', 0)
       Metricsd::Client.record_success('custom.metric')
     end
 
-    it 'should change separator if :sep option is specified' do
-      @socket.should_receive(:send).with('all@custom.metric!count:1', 0)
-      Metricsd::Client.record_success('custom.metric', :sep => '!')
-    end
-
     it 'should apply group if specified' do
-      @socket.should_receive(:send).with('all@test$custom.metric_count:1', 0)
+      @socket.should_receive(:send).with('all@test.custom.metric.status:1', 0)
       Metricsd::Client.record_success('custom.metric', :group => 'test')
     end
 
     it 'should apply source if empty string passed' do
-      @socket.should_receive(:send).with('test@custom.metric_count:1', 0)
+      @socket.should_receive(:send).with('test@custom.metric.status:1', 0)
       Metricsd::Client.record_success('custom.metric', :source => '')
     end
 
     it 'should apply source specified' do
-      @socket.should_receive(:send).with('test2@custom.metric_count:1', 0)
+      @socket.should_receive(:send).with('test2@custom.metric.status:1', 0)
       Metricsd::Client.record_success('custom.metric', :source => 'test2')
     end
   end
 
   describe '.record_failure' do
     it 'should record failures' do
-      @socket.should_receive(:send).with('all@custom.metric_count:-1', 0)
+      @socket.should_receive(:send).with('all@custom.metric.status:-1', 0)
       Metricsd::Client.record_failure('custom.metric')
     end
 
-    it 'should change separator if :sep option is specified' do
-      @socket.should_receive(:send).with('all@custom.metric!count:-1', 0)
-      Metricsd::Client.record_failure('custom.metric', :sep => '!')
-    end
-
     it 'should apply group if specified' do
-      @socket.should_receive(:send).with('all@test$custom.metric_count:-1', 0)
+      @socket.should_receive(:send).with('all@test.custom.metric.status:-1', 0)
       Metricsd::Client.record_failure('custom.metric', :group => 'test')
     end
 
     it 'should apply source if empty string passed' do
-      @socket.should_receive(:send).with('test@custom.metric_count:-1', 0)
+      @socket.should_receive(:send).with('test@custom.metric.status:-1', 0)
       Metricsd::Client.record_failure('custom.metric', :source => '')
     end
 
     it 'should apply source specified' do
-      @socket.should_receive(:send).with('test2@custom.metric_count:-1', 0)
+      @socket.should_receive(:send).with('test2@custom.metric.status:-1', 0)
       Metricsd::Client.record_failure('custom.metric', :source => 'test2')
     end
   end
 
   describe '.record_time' do
     it 'should record time if specified' do
-      @socket.should_receive(:send).with('all@custom.metric_time:450', 0)
+      @socket.should_receive(:send).with('all@custom.metric.time:450', 0)
       Metricsd::Client.record_time('custom.metric', 0.45)
     end
 
     it 'should yield a block if time is not specified' do
-      @socket.should_receive(:send).with(match(/all@custom.metric_time:1\d{2}/), 0)
+      @socket.should_receive(:send).with(match(/all@custom.metric.time:1\d{2}/), 0)
       yielded = false
       Metricsd::Client.record_time('custom.metric') do
         yielded = true
@@ -135,7 +120,7 @@ describe Metricsd::Client do
     end
 
     it 'should use options if time is not specified' do
-      @socket.should_receive(:send).with(match(/all@custom.metric_time:\d+/), 0)
+      @socket.should_receive(:send).with(match(/all@custom.metric.time:\d+/), 0)
       yielded = false
       Metricsd::Client.record_time('custom.metric', {}) do
         yielded = true
@@ -143,23 +128,18 @@ describe Metricsd::Client do
       yielded.should be_true
     end
 
-    it 'should change separator if :sep option is specified' do
-      @socket.should_receive(:send).with('all@custom.metric!time:450', 0)
-      Metricsd::Client.record_time('custom.metric', 0.45, :sep => '!')
-    end
-
     it 'should apply group if specified' do
-      @socket.should_receive(:send).with('all@test$custom.metric_time:450', 0)
+      @socket.should_receive(:send).with('all@test.custom.metric.time:450', 0)
       Metricsd::Client.record_time('custom.metric', 0.45, :group => 'test')
     end
 
     it 'should apply source if empty string passed' do
-      @socket.should_receive(:send).with('test@custom.metric_time:450', 0)
+      @socket.should_receive(:send).with('test@custom.metric.time:450', 0)
       Metricsd::Client.record_time('custom.metric', 0.45, :source => '')
     end
 
     it 'should apply source specified' do
-      @socket.should_receive(:send).with('test2@custom.metric_time:450', 0)
+      @socket.should_receive(:send).with('test2@custom.metric.time:450', 0)
       Metricsd::Client.record_time('custom.metric', 0.45, :source => 'test2')
     end
   end
@@ -171,7 +151,7 @@ describe Metricsd::Client do
     end
 
     it 'should apply group if specified' do
-      @socket.should_receive(:send).with('all@test$custom.metric:23', 0)
+      @socket.should_receive(:send).with('all@test.custom.metric:23', 0)
       Metricsd::Client.record_value('custom.metric', 23, :group => 'test')
     end
 
@@ -187,13 +167,13 @@ describe Metricsd::Client do
 
     it 'should apply default group if specified' do
       Metricsd.default_group = 'grp'
-      @socket.should_receive(:send).with('all@grp$custom.metric:23', 0)
+      @socket.should_receive(:send).with('all@grp.custom.metric:23', 0)
       Metricsd::Client.record_value('custom.metric', 23)
     end
 
     it 'should override default group with the specified one' do
       Metricsd.default_group = 'grp'
-      @socket.should_receive(:send).with('all@group$custom.metric:23', 0)
+      @socket.should_receive(:send).with('all@group.custom.metric:23', 0)
       Metricsd::Client.record_value('custom.metric', 23, :group => 'group')
     end
 
@@ -211,7 +191,7 @@ describe Metricsd::Client do
     end
 
     it 'should apply group if specified' do
-      @socket.should_receive(:send).with('all@test$another.metric:47;all@test$custom.metric:23', 0)
+      @socket.should_receive(:send).with('all@test.another.metric:47;all@test.custom.metric:23', 0)
       Metricsd::Client.record_values({'custom.metric' => 23, 'another.metric' => 47}, :group => 'test')
     end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: metricsd
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 2
-  - 3
-  version: 0.2.3
+  - 4
+  version: 0.2.4
 platform: ruby
 authors: 
 - Dmytro Shteflyuk
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-27 00:00:00 -04:00
+date: 2011-08-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -100,6 +100,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - .rvmrc
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - Guardfile