cabin 0.3.8 → 0.4.1

data/examples/metrics.rb

@@ -0,0 +1,41 @@
+require "rubygems"
+require "cabin"
+require "logger"
+
+# Logging::... is something I'm implemented and experimenting with.
+@logger = Cabin::Channel.new
+
+# Metrics can be subscribed-to as well.
+@logger.subscribe(Logger.new(STDOUT))
+
+counter = @logger.metrics.counter("mycounter")
+counter.incr
+counter.incr
+counter.incr
+counter.decr
+
+meter = @logger.metrics.meter("something", "hello-world")
+meter.mark
+meter.mark
+meter.mark
+
+# If nil is passed as the 'instance' then the metric class name will be
+# used instead.
+timer = @logger.metrics.timer("ticktock")
+5.times do
+  timer.time do
+    sleep rand * 2
+  end
+end
+
+3.times do
+  # Another way to do timing.
+  clock = timer.time
+  sleep rand * 2
+  clock.stop
+end
+
+# Loop through all metrics:
+@logger.metrics.each do |metric|
+  @logger.info(metric.inspect)
+end

data/lib/cabin/channel.rb

@@ -45,6 +45,8 @@ require "logger"
 #
 class Cabin::Channel
   include Cabin::Mixins::Logger
+
+  # All channels come with a metrics provider.
   attr_accessor :metrics
 
   # Get a channel for a given identifier. If this identifier has never been
@@ -67,6 +69,7 @@ class Cabin::Channel
     @data = {}
     @level = :info
     @metrics = Cabin::Metrics.new
+    @metrics.channel = self
   end # def initialize
 
   # Subscribe a new input

data/lib/cabin/inspectable.rb

@@ -22,7 +22,7 @@ module Cabin
     #     foo = Foo.new
     #     foo.inspect == '<Foo(1) @foo=123 @bar="hello" >'
     def inspect
-      if instance_variable_defined?(:inspectables)
+      if instance_variable_defined?(:@inspectables)
         ivars = @inspectables
       else
         ivars = instance_variables

data/lib/cabin/metric.rb

@@ -0,0 +1,22 @@
+require "cabin/namespace"
+require "cabin/publisher"
+require "cabin/inspectable"
+
+module Cabin::Metric
+  include Cabin::Inspectable
+  include Cabin::Publisher
+
+  def instance=(instance)
+    @instance = instance
+  end # def instance=
+
+  def instance
+    return @instance
+  end # def instance
+
+  def emit
+    if !@channel.nil?
+      @channel.publish({ :metric => instance }.merge(to_hash))
+    end
+  end # def emit
+end # module Cabin::Metric

data/lib/cabin/metrics.rb

@@ -4,6 +4,8 @@ require "cabin/metrics/meter"
 require "cabin/metrics/counter"
 require "cabin/metrics/timer"
 require "cabin/metrics/histogram"
+require "cabin/publisher"
+require "cabin/channel"
 
 # What type of metrics do we want?
 #
@@ -44,13 +46,14 @@ require "cabin/metrics/histogram"
 # and management tools.
 class Cabin::Metrics
   include Enumerable
+  include Cabin::Publisher
 
   # Get us a new metrics container.
   public
   def initialize
     @metrics = {}
   end # def initialize
-  
+
   private
   def create(instance, name, metric_object)
     if !instance.is_a?(String)
@@ -58,11 +61,22 @@ class Cabin::Metrics
     end
 
     if name.nil?
-      metric = instance.to_s
+      # If no name is given, use the class name of the metric.
+      # For example, if we invoke Metrics#timer("foo"), the metric
+      # name will be "foo/timer"
+      metric_name = "#{instance}/#{metric_object.class.name.split("::").last.downcase}"
     else
-      metric = "#{instance}/#{name}"
+      # Otherwise, use "instance/name" as the name.
+      metric_name = "#{instance}/#{name}"
+    end
+
+    metric_object.channel = @channel
+    metric_object.instance = metric_name
+
+    if @channel
+      @channel.debug("Created metric", :instance => instance, :type => metric_object.class)
     end
-    return @metrics[metric] = metric_object
+    return @metrics[metric_name] = metric_object
   end # def create
 
   # Create a new Counter metric

data/lib/cabin/metrics/counter.rb

@@ -1,9 +1,9 @@
 require "cabin/namespace"
-require "cabin/inspectable"
+require "cabin/metric"
 require "thread"
 
 class Cabin::Metrics::Counter
-  include Cabin::Inspectable
+  include Cabin::Metric
 
   # A new Counter. 
   #
@@ -18,11 +18,13 @@ class Cabin::Metrics::Counter
   # increment this counter
   def incr
     @lock.synchronize { @value += 1 }
+    emit
   end # def incr
 
   # decrement this counter
   def decr
     @lock.synchronize { @value -= 1 }
+    emit
   end # def decr
 
   # Get the value of this metric.

data/lib/cabin/metrics/gauge.rb

@@ -1,8 +1,8 @@
 require "cabin/namespace"
-require "cabin/inspectable"
+require "cabin/metric"
 
 class Cabin::Metrics::Gauge
-  include Cabin::Inspectable
+  include Cabin::Metric
 
   # A new Gauge. The block given will be called every time the metric is read.
   public

data/lib/cabin/metrics/histogram.rb

@@ -1,9 +1,9 @@
 require "cabin/namespace"
-require "cabin/inspectable"
+require "cabin/metric"
 require "thread"
 
 class Cabin::Metrics::Histogram
-  include Cabin::Inspectable
+  include Cabin::Metric
 
   # A new Histogram. 
   public
@@ -20,8 +20,8 @@ class Cabin::Metrics::Histogram
     #
     # Sliding values of all of these?
     @total = 0
-    @min = 0
-    @max = 0
+    @min = nil
+    @max = nil
     @count = 0
     @mean = 0.0
   end # def initialize
@@ -31,12 +31,17 @@ class Cabin::Metrics::Histogram
     @lock.synchronize do
       @count += 1
       @total += value
-      @min = value if value < @min
-      @max = value if value > @max
+      if @min.nil? or value < @min
+        @min = value
+      end
+      if @max.nil? or value > @max
+        @max = value
+      end
       @mean = @total / @count
       # TODO(sissel): median
       # TODO(sissel): percentiles
     end
+    emit
   end # def record
 
   # This is a very poor way to access the metric data.

data/lib/cabin/metrics/meter.rb

@@ -1,9 +1,9 @@
 require "cabin/namespace"
-require "cabin/inspectable"
+require "cabin/metric"
 require "thread"
 
 class Cabin::Metrics::Meter
-  include Cabin::Inspectable
+  include Cabin::Metric
 
   # A new Meter 
   #
@@ -21,6 +21,7 @@ class Cabin::Metrics::Meter
       @value += 1
       # TODO(sissel): Keep some moving averages?
     end
+    emit
   end # def mark
 
   # Get the value of this metric.

data/lib/cabin/metrics/timer.rb

@@ -1,7 +1,5 @@
 require "cabin/namespace"
-require "cabin/inspectable"
 require "cabin/metrics/histogram"
-require "thread"
 
 class Cabin::Metrics::Timer < Cabin::Metrics::Histogram
   # Start timing something.

data/lib/cabin/namespace.rb

@@ -3,5 +3,6 @@ module Cabin
     module EM; end
   end
   module Mixins; end
+  module Emitters; end
   class Metrics; end
 end

data/lib/cabin/publisher.rb

@@ -0,0 +1,20 @@
+require "cabin/namespace"
+
+# This mixin allows you to easily give channel and publish features
+# to a class.
+module Cabin::Publisher
+  # Set the channel
+  def channel=(channel)
+    @channel = channel
+  end # def channel=
+
+  # Get the channel
+  def channel
+    return @channel
+  end # def channel
+
+  # Publish to the channel
+  def publish(object)
+    @channel << object
+  end # def publish
+end # module Cabin::Publisher

data/test/test_metrics.rb

@@ -44,6 +44,13 @@ describe Cabin::Metrics do
 
   test "meter time-based averages" # TODO(sissel): implement
 
+  test "timer first-run has max == min" do
+    timer = @metrics.timer(self)
+    timer.time { true }
+    assert_equal(timer.to_hash[:min], timer.to_hash[:max],
+                 "With a single event, min and max must be equal")
+  end
+
   test "timer counter" do
     timer = @metrics.timer(self)
     30.times do |i|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cabin
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-10 00:00:00.000000000 Z
+date: 2012-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &15416680 !ruby/object:Gem::Requirement
+  requirement: &5144860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15416680
+  version_requirements: *5144860
 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!
@@ -34,6 +34,7 @@ extra_rdoc_files: []
 files:
 - lib/cabin/inspectable.rb
 - lib/cabin/context.rb
+- lib/cabin/metric.rb
 - lib/cabin/timer.rb
 - lib/cabin/outputs/stdlib-logger.rb
 - lib/cabin/outputs/em/stdlib-logger.rb
@@ -47,11 +48,13 @@ files:
 - lib/cabin/metrics/meter.rb
 - lib/cabin/metrics/counter.rb
 - lib/cabin/metrics.rb
+- lib/cabin/publisher.rb
 - lib/cabin/channel.rb
 - lib/cabin.rb
 - examples/fibonacci-timing.rb
 - examples/sinatra-logging.rb
 - examples/sample.rb
+- examples/metrics.rb
 - test/test_logging.rb
 - test/minitest-patch.rb
 - test/test_metrics.rb