metriks 0.9.8.4 → 0.9.9

data/README.md

@@ -14,7 +14,9 @@ the gem.
 
 To install, add this to your `Gemfile`:
 
-    gem 'metriks'
+``` ruby
+gem 'metriks'
+```
 
 and re-run `bundle`.
 
@@ -287,7 +289,7 @@ How to get metrics out of the process.
 
 Sends metrics to Graphite every 60 seconds.
 
-```ruby
+``` ruby
   reporter = Metriks::Reporter::Graphite.new 'localhost', 3004
   reporter.start
 ```
@@ -297,7 +299,7 @@ Sends metrics to Graphite every 60 seconds.
 
 Send metrics to a logger every 60 seconds.
 
-```
+``` ruby
   reporter = Metriks::Reporter::Logger.new(:logger => Logger.new('log/metrics.log'))
   reporter.start
 ```
@@ -307,7 +309,7 @@ Send metrics to a logger every 60 seconds.
 
 Send metrics to Librato Metrics every 60 seconds.
 
-```
+``` ruby
   reporter = Metriks::Reporter::LibratoMetrics.new('email', 'token')
   reporter.start
 ```
@@ -318,7 +320,7 @@ Send metrics to Librato Metrics every 60 seconds.
 Provides a simple way to get up-to-date statistics from a process by
 updating the proctitle every 5 seconds (default).
 
-```ruby
+``` ruby
   reporter = Metriks::Reporter::ProcTitle.new :interval => 5
   reporter.add 'reqs', 'sec' do
     Metriks.meter('rack.requests').one_minute_rate

data/lib/metriks.rb

@@ -1,6 +1,6 @@
 
 module Metriks
-  VERSION = '0.9.8.4'
+  VERSION = '0.9.9'
 
   def self.get(name)
     Metriks::Registry.default.get(name)
@@ -21,6 +21,10 @@ module Metriks
   def self.meter(name)
     Metriks::Registry.default.meter(name)
   end
+
+  def self.histogram(name)
+    Metriks::Registry.default.histogram(name)
+  end
 end
 
 require 'metriks/registry'

data/lib/metriks/registry.rb

@@ -120,6 +120,23 @@ module Metriks
       add_or_get(name, Metriks::UtilizationTimer)
     end
 
+    # Public: Fetch or create a new histogram metric. Histograms record values
+    # and expose statistics about the distribution of the data like median and
+    # 95th percentile.
+    #
+    # name - The String name of the metric to define or fetch
+    #
+    # Examples
+    #
+    #   registry.histogram('backlog.wait')
+    #
+    # Returns the Metricks::Histogram identified by the name.
+    def histogram(name)
+      add_or_get(name, Metriks::Histogram) do
+        Metriks::Histogram.new_exponentially_decaying
+      end
+    end
+
     # Public: Fetch an existing metric.
     #
     # name - The String name of the metric to fetch
@@ -157,7 +174,7 @@ module Metriks
     end
 
     protected
-    def add_or_get(name, klass)
+    def add_or_get(name, klass, &create_metric)
       @mutex.synchronize do
         if metric = @metrics[name]
           if !metric.is_a?(klass)
@@ -166,7 +183,7 @@ module Metriks
             return metric
           end
         else
-          @metrics[name] = klass.new
+          @metrics[name] = create_metric ? create_metric.call : klass.new
         end
       end
     end

data/lib/metriks/reporter/graphite.rb

@@ -76,6 +76,12 @@ module Metriks::Reporter
           ], [
             :median, :get_95th_percentile
           ]
+        when Metriks::Histogram
+          write_metric name, metric, [
+            :count, :min, :max, :mean, :stddev
+          ], [
+            :median, :get_95th_percentile
+          ]
         end
       end
     end

data/lib/metriks/reporter/librato_metrics.rb

@@ -1,3 +1,4 @@
+require 'metriks/time_tracker'
 require 'net/https'
 
 module Metriks::Reporter
@@ -12,14 +13,14 @@ module Metriks::Reporter
       @source = options[:source]
 
       @registry  = options[:registry] || Metriks::Registry.default
-      @interval  = options[:interval] || 60
+      @time_tracker = Metriks::TimeTracker.new(options[:interval] || 60)
       @on_error  = options[:on_error] || proc { |ex| }
     end
 
     def start
       @thread ||= Thread.new do
         loop do
-          sleep @interval
+          @time_tracker.sleep
 
           Thread.new do
             begin
@@ -73,10 +74,20 @@ module Metriks::Reporter
           ], [
             :median, :get_95th_percentile
           ]
+        when Metriks::Histogram
+          prepare_metric name, metric, [
+            :count, :min, :max, :mean, :stddev
+          ], [
+            :median, :get_95th_percentile
+          ]
         end
       end
 
-      submit(form_data(gauges.flatten))
+      gauges.flatten!
+
+      unless gauges.empty?
+        submit(form_data(gauges.flatten))
+      end
     end
 
     def submit(data)
@@ -100,9 +111,11 @@ module Metriks::Reporter
       end
     end
 
-    def form_data(gauges)
+    def form_data(metrics)
       data = {}
 
+      gauges = metrics.select { |m| m[:type] == "gauge" }
+
       gauges.each_with_index do |gauge, idx|
         gauge.each do |key, value|
           if value
@@ -111,12 +124,22 @@ module Metriks::Reporter
         end
       end
 
+      counters = metrics.select { |m| m[:type] == "counter" }
+
+      counters.each_with_index do |counter, idx|
+        counter.each do |key, value|
+          if value
+            data["counters[#{idx}][#{key}]"] = value.to_s
+          end
+        end
+      end
+
       data
     end
 
     def prepare_metric(base_name, metric, keys, snapshot_keys = [])
       results = []
-      time = Time.now.to_i
+      time = @time_tracker.now_floored
 
       base_name = base_name.to_s.gsub(/ +/, '_')
       if @prefix
@@ -128,9 +151,10 @@ module Metriks::Reporter
         value = metric.send(key)
 
         results << {
+          :type => name.to_s == "count" ? "counter" : "gauge",
           :name => "#{base_name}.#{name}",
           :source => @source,
-          :time => time,
+          :measure_time => time,
           :value => value
         }
       end
@@ -142,9 +166,10 @@ module Metriks::Reporter
           value = snapshot.send(key)
 
           results << {
+            :type => name.to_s == "count" ? "counter" : "gauge",
             :name => "#{base_name}.#{name}",
             :source => @source,
-            :time => time,
+            :measure_time => time,
             :value => value
           }
         end

data/lib/metriks/reporter/logger.rb

@@ -1,4 +1,5 @@
 require 'logger'
+require 'metriks/time_tracker'
 
 module Metriks::Reporter
   class Logger
@@ -10,7 +11,7 @@ module Metriks::Reporter
       @prefix    = options[:prefix]    || 'metriks:'
 
       @registry     = options[:registry] || Metriks::Registry.default
-      @time_tracker = TimeTracker.new(options[:interval] || 60)
+      @time_tracker = Metriks::TimeTracker.new(options[:interval] || 60)
       @on_error     = options[:on_error] || proc { |ex| }
     end
 
@@ -76,6 +77,12 @@ module Metriks::Reporter
           ], [
             :median, :get_95th_percentile
           ]
+        when Metriks::Histogram
+          log_metric name, 'histogram', metric, [
+            :count, :min, :max, :mean, :stddev
+          ], [
+            :median, :get_95th_percentile
+          ]
         end
       end
     end
@@ -114,25 +121,5 @@ module Metriks::Reporter
         end
       end.join(' ')
     end
-
-    class TimeTracker
-      def initialize(interval)
-        @interval = interval
-        @next_time = Time.now.to_f
-      end
-
-      def sleep
-        sleep_time = next_time - Time.now.to_f
-        if sleep_time > 0
-          Kernel.sleep(sleep_time)
-        end
-      end
-
-      def next_time
-        now = Time.now.to_f
-        @next_time = now if @next_time <= now
-        @next_time += @interval - (@next_time % @interval)
-      end
-    end
   end
-end
+end

data/lib/metriks/reporter/riemann.rb

@@ -81,6 +81,12 @@ module Metriks::Reporter
           ], [
             :median, :get_95th_percentile
           ]
+        when Metriks::Histogram
+          send_metric name, 'histogram', metric, [
+            :count, :min, :max, :mean, :stddev
+          ], [
+            :median, :get_95th_percentile
+          ]
         end
       end
     end

data/lib/metriks/time_tracker.rb

@@ -0,0 +1,26 @@
+module Metriks
+  class TimeTracker
+    def initialize(interval)
+      @interval = interval
+      @next_time = Time.now.to_f
+    end
+
+    def sleep
+      sleep_time = next_time - Time.now.to_f
+      if sleep_time > 0
+        Kernel.sleep(sleep_time)
+      end
+    end
+
+    def now_floored
+      time = Time.now.to_i
+      time - (time % @interval)
+    end
+
+    def next_time
+      now = Time.now.to_f
+      @next_time = now if @next_time <= now
+      @next_time += @interval - (@next_time % @interval)
+    end
+  end
+end

data/metriks.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'metriks'
-  s.version           = '0.9.8.4'
-  s.date              = '2012-05-20'
+  s.version           = '0.9.9'
+  s.date              = '2012-06-29'
 
   ## Make sure your summary is short. The description may be as long
   ## as you like.
@@ -72,6 +72,7 @@ Gem::Specification.new do |s|
     lib/metriks/reporter/riemann.rb
     lib/metriks/simple_moving_average.rb
     lib/metriks/snapshot.rb
+    lib/metriks/time_tracker.rb
     lib/metriks/timer.rb
     lib/metriks/uniform_sample.rb
     lib/metriks/utilization_timer.rb

data/test/graphite_reporter_test.rb

@@ -27,6 +27,7 @@ class GraphiteReporterTest < Test::Unit::TestCase
     @registry.meter('meter.testing').mark
     @registry.counter('counter.testing').increment
     @registry.timer('timer.testing').update(1.5)
+    @registry.histogram('histogram.testing').update(1.5)
     @registry.utilization_timer('utilization_timer.testing').update(1.5)
 
     @reporter.write

data/test/librato_metrics_reporter_test.rb

@@ -24,6 +24,7 @@ class LibratoMetricsReporterTest < Test::Unit::TestCase
     @registry.meter('meter.testing').mark
     @registry.counter('counter.testing').increment
     @registry.timer('timer.testing').update(1.5)
+    @registry.histogram('histogram.testing').update(1.5)
     @registry.utilization_timer('utilization_timer.testing').update(1.5)
 
     @reporter.expects(:submit)

data/test/logger_reporter_test.rb

@@ -21,6 +21,7 @@ class LoggerReporterTest < Test::Unit::TestCase
     @registry.meter('meter.testing').mark
     @registry.counter('counter.testing').increment
     @registry.timer('timer.testing').update(1.5)
+    @registry.histogram('histogram.testing').update(1.5)
     @registry.utilization_timer('utilization_timer.testing').update(1.5)
   end
 

data/test/metriks_test.rb

@@ -24,4 +24,8 @@ class MetriksTest < Test::Unit::TestCase
   def test_utilization_timer
     assert_not_nil Metriks.utilization_timer('testing')
   end
+
+  def test_histogram
+    assert_not_nil Metriks.histogram('testing')
+  end
 end

data/test/registry_test.rb

@@ -27,6 +27,18 @@ class RegistryTest < Test::Unit::TestCase
     assert_not_nil @registry.utilization_timer('testing')
   end
 
+  def test_histogram
+    assert_not_nil @registry.histogram('testing')
+  end
+
+  def test_mismatched_metrics
+    @registry.histogram('histogram')
+    assert_raises(RuntimeError) { @registry.timer('histogram') }
+
+    @registry.timer('timer')
+    assert_raises(RuntimeError) { @registry.histogram('timer') }
+  end
+
   def test_calling_counter_twice
     assert_not_nil @registry.counter('testing')
   end

data/test/riemann_reporter_test.rb

@@ -34,6 +34,7 @@ class RiemannReporterTest < Test::Unit::TestCase
     @registry.meter('meter.testing').mark
     @registry.counter('counter.testing').increment
     @registry.timer('timer.testing').update(1.5)
+    @registry.histogram('histogram.testing').update(1.5)
     @registry.utilization_timer('utilization_timer.testing').update(1.5)
 
     @reporter.client.expects(:<<).at_least_once
@@ -58,6 +59,13 @@ class RiemannReporterTest < Test::Unit::TestCase
       :tags => ["timer"],
       :ttl => 90
     )
+    @reporter.client.expects(:<<).with(
+      :host => "h",
+      :service => "histogram.testing max",
+      :metric => 1.5,
+      :tags => ["histogram"],
+      :ttl => 90
+    )
     @reporter.client.expects(:<<).with(
       :host => "h",
       :service => "utilization_timer.testing mean",

metadata

@@ -5,9 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 9
-  - 8
-  - 4
-  version: 0.9.8.4
+  - 9
+  version: 0.9.9
 platform: ruby
 authors: 
 - Eric Lindvall
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-20 00:00:00 -07:00
+date: 2012-06-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -100,6 +99,7 @@ files:
 - lib/metriks/reporter/riemann.rb
 - lib/metriks/simple_moving_average.rb
 - lib/metriks/snapshot.rb
+- lib/metriks/time_tracker.rb
 - lib/metriks/timer.rb
 - lib/metriks/uniform_sample.rb
 - lib/metriks/utilization_timer.rb