cabin 0.3.6 → 0.3.7

data/lib/cabin/channel.rb

@@ -47,6 +47,18 @@ class Cabin::Channel
   include Cabin::Mixins::Logger
   attr_accessor :metrics
 
+  # Get a channel for a given identifier. If this identifier has never been
+  # used, a new channel is created for it.
+  # The default identifier is the application executable name.
+  #
+  # This is useful for using the same Cabin::Channel across your
+  # entire application.
+  public
+  def self.get(identifier=$0)
+    @channels ||= Hash.new { |h,k| h[k] = Cabin::Channel.new }
+    return @channels[identifier]
+  end # def Cabin::Channel.get
+
   # Create a new logging channel.
   # The default log level is 'info'
   public

data/lib/cabin/inspectable.rb

@@ -0,0 +1,56 @@
+require "cabin/namespace"
+
+module Cabin
+  module Inspectable
+    # Provide a saner inspect method that's easier to configure.
+    #
+    # By default, will inspect all instance variables. You can tune
+    # this by setting @inspectables to an array of ivar symbols, like:
+    #     [ :@hello, :@world ]
+    #
+    #     class Foo
+    #       include Cabin::Inspectable
+    #
+    #       def initialize
+    #         @inspectables = [:@foo, :@bar]
+    #         @foo = 123
+    #         @bar = "hello"
+    #         @baz = "ok"
+    #       end
+    #     end
+    #
+    #     foo = Foo.new
+    #     foo.inspect == '<Foo(1) @foo=123 @bar="hello" >'
+    def inspect
+      if instance_variable_defined?(:inspectables)
+        ivars = @inspectables
+      else
+        ivars = instance_variables
+      end
+      str = "<#{self.class.name}(@#{self.object_id}) "
+      ivars.each do |ivar|
+        str << "#{ivar}=#{instance_variable_get(ivar).inspect} "
+      end
+      str << ">"
+      return str
+    end
+  end
+
+  def self.__Inspectable(*ivars)
+    mod = Module.new
+    mod.instance_eval do
+      define_method(:inspect) do
+        ivars = instance_variables if ivars.empty?
+        str = "<#{self.class.name}(@#{self.object_id}) "
+        ivars.each do |ivar|
+          str << "#{ivar}=#{instance_variable_get(ivar).inspect} "
+        end
+        str << ">"
+        return str
+      end
+    end
+    return mod
+  end # def Cabin.Inspectable
+end # module Cabin
+
+

data/lib/cabin/metrics.rb

@@ -45,6 +45,7 @@ require "cabin/metrics/histogram"
 class Cabin::Metrics
   include Enumerable
 
+  # Get us a new metrics container.
   public
   def initialize
     @metrics = {}
@@ -52,26 +53,45 @@ class Cabin::Metrics
   
   private
   def create(instance, name, metric_object)
-    #p :newmetric => [name, instance]
-    #p [instance, instance.class, instance.class.class]
-    return @metrics[[instance, name]] = metric_object
+    if !instance.is_a?(String)
+      instance = "#{instance.class.name}<#{instance.object_id}>"
+    end
+
+    if name.nil?
+      metric = instance.to_s
+    else
+      metric = "#{instance}/#{name}"
+    end
+    return @metrics[metric] = metric_object
   end # def create
 
+  # Create a new Counter metric
+  # 'instance' is usually an object owning this metric, but it can be a string.
+  # 'name' is the name of the metric.
   public
   def counter(instance, name=nil)
     return create(instance, name, Cabin::Metrics::Counter.new)
   end # def counter
 
+  # Create a new Meter metric
+  # 'instance' is usually an object owning this metric, but it can be a string.
+  # 'name' is the name of the metric.
   public
   def meter(instance, name=nil)
     return create(instance, name, Cabin::Metrics::Meter.new)
   end # def meter
 
+  # Create a new Histogram metric
+  # 'instance' is usually an object owning this metric, but it can be a string.
+  # 'name' is the name of the metric.
   public
   def histogram(instance, name=nil)
     return create(instance, name, Cabin::Metrics::Histogram.new)
   end # def histogram
 
+  # Create a new Timer metric
+  # 'instance' is usually an object owning this metric, but it can be a string.
+  # 'name' is the name of the metric.
   public
   def timer(instance, name=nil)
     return create(instance, name, Cabin::Metrics::Timer.new)

data/lib/cabin/metrics/counter.rb

@@ -1,12 +1,16 @@
 require "cabin/namespace"
+require "cabin/inspectable"
 require "thread"
 
 class Cabin::Metrics::Counter
+  include Cabin::Inspectable
+
   # A new Counter. 
   #
   # Counters can be incremented and decremented only by 1 at a time..
   public
   def initialize
+    @inspectables = [ :@value ]
     @value = 0
     @lock = Mutex.new
   end # def initialize

data/lib/cabin/metrics/gauge.rb

@@ -1,9 +1,13 @@
 require "cabin/namespace"
+require "cabin/inspectable"
 
 class Cabin::Metrics::Gauge
+  include Cabin::Inspectable
+
   # A new Gauge. The block given will be called every time the metric is read.
   public
   def initialize(&block)
+    @inspectables = [ ]
     @block = block
   end # def initialize
 

data/lib/cabin/metrics/histogram.rb

@@ -1,11 +1,15 @@
 require "cabin/namespace"
+require "cabin/inspectable"
 require "thread"
 
 class Cabin::Metrics::Histogram
+  include Cabin::Inspectable
+
   # A new Histogram. 
   public
   def initialize
     @lock = Mutex.new
+    @inspectables = [ :@total, :@min, :@max, :@count, :@mean ]
 
     # Histogram should track many things, including:
     # - percentiles (50, 75, 90, 95, 99?)

data/lib/cabin/metrics/meter.rb

@@ -1,12 +1,16 @@
 require "cabin/namespace"
+require "cabin/inspectable"
 require "thread"
 
 class Cabin::Metrics::Meter
+  include Cabin::Inspectable
+
   # A new Meter 
   #
   # Counters can be incremented and decremented only by 1 at a time..
   public
   def initialize
+    @inspectables = [ :@value ]
     @value = 0
     @lock = Mutex.new
   end # def initialize

data/lib/cabin/metrics/timer.rb

@@ -1,4 +1,5 @@
 require "cabin/namespace"
+require "cabin/inspectable"
 require "cabin/metrics/histogram"
 require "thread"
 

data/lib/cabin/outputs/stdlib-logger.rb

@@ -13,10 +13,18 @@ class Cabin::Outputs::StdlibLogger
 
   # Receive an event
   public
-  def <<(data)
-    method = data[:level].downcase.to_sym || :info
+  def <<(event)
+    if !event.include?(:level)
+      event[:level] = :info
+    end
+    method = event[:level].downcase.to_sym || :info
+    event.delete(:level)
 
-    message = "#{data[:message]} #{data.to_json}"
+    data = event.clone
+    # delete things from the 'data' portion that's not really data.
+    data.delete(:message)
+    data.delete(:timestamp)
+    message = "#{event[:message]} #{data.to_json}"
 
     #p [@logger.level, logger.class::DEBUG]
     # This will call @logger.info(data) or something similar.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cabin
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-07 00:00:00.000000000 Z
+date: 2012-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &15419600 !ruby/object:Gem::Requirement
+  requirement: &15693460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15419600
+  version_requirements: *15693460
 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!
@@ -42,6 +42,7 @@ files:
 - lib/cabin/metrics/gauge.rb
 - lib/cabin/metrics/histogram.rb
 - lib/cabin/metrics/meter.rb
+- lib/cabin/inspectable.rb
 - lib/cabin/timer.rb
 - lib/cabin/metrics.rb
 - lib/cabin/context.rb