cabin 0.3.1 → 0.3.2

data/lib/cabin/metrics.rb

@@ -3,8 +3,7 @@ require "cabin/metrics/gauge"
 require "cabin/metrics/meter"
 require "cabin/metrics/counter"
 require "cabin/metrics/timer"
-
-
+require "cabin/metrics/histogram"
 
 # What type of metrics do we want?
 #
@@ -31,8 +30,7 @@ require "cabin/metrics/timer"
 #     like meter, but takes values more than simply '1'
 #     as a result, exposes percentiles, median, etc.
 #   timers
-#     combination of meter + histogram
-#     meter for invocations, histogram for duration
+#     a time-observing interface on top of histogram.
 #
 # With the exception of gauges, all the other metrics are all active/pushed.
 # Gauges take callbacks, so their values are pulled, not pushed. The active

data/lib/cabin/metrics/histogram.rb

@@ -0,0 +1,57 @@
+require "cabin/namespace"
+require "thread"
+
+class Cabin::Metrics::Histogram
+  # A new Histogram. 
+  public
+  def initialize
+    @lock = Mutex.new
+
+    # Histogram should track many things, including:
+    # - percentiles (50, 75, 90, 95, 99?)
+    # - median
+    # - max
+    # - min
+    # - total sum
+    #
+    # Sliding values of all of these?
+    @total = 0
+    @min = 0
+    @max = 0
+    @count = 0
+    @mean = 0.0
+  end # def initialize
+
+  public
+  def record(value)
+    @lock.synchronize do
+      @count += 1
+      @total += value
+      @min = value if value < @min
+      @max = value if value > @max
+      @mean = @total / @count
+      # TODO(sissel): median
+      # TODO(sissel): percentiles
+    end
+  end # def record
+
+  # This is a very poor way to access the metric data.
+  # TODO(sissel): Need to figure out a better interface.
+  public
+  def value
+    return @lock.synchronize { @count }
+  end # def value
+
+  public
+  def to_hash
+    return @lock.synchronize do
+      { 
+        :count => @count,
+        :total => @total,
+        :min => @min,
+        :max => @max,
+        :mean => @mean,
+      }
+    end
+  end # def to_hash
+end # class Cabin::Metrics::Histogram

data/lib/cabin/metrics/timer.rb

@@ -1,19 +1,8 @@
 require "cabin/namespace"
+require "cabin/metrics/histogram"
 require "thread"
 
-class Cabin::Metrics::Timer
-  # A new Timer metric 
-  #
-  # Timers behave like a combination of Meter and Histogram. Every Timer
-  # invocation is metered and the duration of the timer is put into the
-  # Histogram.
-  public
-  def initialize
-    @invocations = 0
-    @total_duration = 0.0
-    @lock = Mutex.new
-  end # def initialize
-
+class Cabin::Metrics::Timer < Cabin::Metrics::Histogram
   # Start timing something.
   #
   # If no block is given
@@ -34,37 +23,6 @@ class Cabin::Metrics::Timer
     record(Time.now - start)
   end # def time_block
 
-  public
-  def record(duration)
-    # TODO(sissel): histogram the duration
-    @lock.synchronize do
-      @invocations += 1
-      @total_duration += duration
-    end
-  end # def record
-
-  # Get the number of times this timer has been used
-  public
-  def count
-    return @lock.synchronize { @invocations }
-  end # def value
-
-  # TODO(sissel): Until I find a good API.
-  public
-  def value
-    return count
-  end # def value
-
-  public
-  def to_hash
-    return @lock.synchronize do
-      { 
-        :count => @invocations, 
-        :duration_sum => @total_duration 
-      }
-    end
-  end # def to_hash
-
   class TimerContext
     public
     def initialize(&stop_callback)
@@ -78,4 +36,4 @@ class Cabin::Metrics::Timer
       @callback.call(duration)
     end # def stop
   end # class TimerContext
-end # class Cabin::Metrics::Counter
+end # class Cabin::Metrics::Timer

data/test/test_metrics.rb

@@ -47,9 +47,12 @@ describe Cabin::Metrics do
   test "timer counter" do
     timer = @metrics.timer(self)
     30.times do |i|
-      assert_equal(i, timer.count)
+      assert_equal(i, timer.value)
       assert_equal(i, timer.to_hash[:count])
       timer.time { true }
+      assert(timer.to_hash[:total] > 0, "total should be nonzero")
+      assert(timer.to_hash[:mean] > 0, "mean should be nonzero")
+      assert(timer.to_hash[:max] > 0, "max should be nonzero")
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cabin
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &20938580 !ruby/object:Gem::Requirement
+  requirement: &9557240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20938580
+  version_requirements: *9557240
 description: This is an experiment to try and make logging more flexible and more
   consumable. Plain text logs are bullshit, let's emit structured and contextual logs.
   Metrics, too!
@@ -40,6 +40,7 @@ files:
 - lib/cabin/metrics/counter.rb
 - lib/cabin/metrics/timer.rb
 - lib/cabin/metrics/gauge.rb
+- lib/cabin/metrics/histogram.rb
 - lib/cabin/metrics/meter.rb
 - lib/cabin/timer.rb
 - lib/cabin/metrics.rb