cabin 0.4.3 → 0.4.4

data/lib/cabin/channel.rb

@@ -6,7 +6,8 @@ require "cabin/context"
 require "cabin/outputs/stdlib-logger"
 require "cabin/outputs/io"
 require "cabin/metrics"
-require "logger"
+require "logger" # stdlib
+require "thread"
 
 # A wonderful channel for logging.
 #
@@ -46,6 +47,9 @@ require "logger"
 #     I, [2011-10-11T01:00:57.993575 #1209]  INFO -- : {:timestamp=>"2011-10-11T01:00:57.993517-0700", :message=>"Done in foo", :level=>:info}
 #
 class Cabin::Channel
+  @channel_lock = Mutex.new
+  @channels = Hash.new { |h,k| h[k] = Cabin::Channel.new }
+
   class << self
     # Get a channel for a given identifier. If this identifier has never been
     # used, a new channel is created for it.
@@ -54,10 +58,21 @@ class Cabin::Channel
     # This is useful for using the same Cabin::Channel across your
     # entire application.
     def get(identifier=$0)
-      @channels ||= Hash.new { |h,k| h[k] = Cabin::Channel.new }
-      return @channels[identifier]
+      return @channel_lock.synchronize { @channels[identifier] }
     end # def Cabin::Channel.get
 
+    def set(identifier, channel)
+      return @channel_lock.synchronize { @channels[identifier] = channel }
+    end # def Cabin::Channel.set
+
+    def each(&block)
+      @channel_lock.synchronize do
+        @channels.each do |identifier, channel|
+          yield identifier, channel
+        end
+      end
+    end # def Cabin::Channel.each
+
     # Get a list of filters included in this class.
     def filters
       @filters ||= []
@@ -71,8 +86,8 @@ class Cabin::Channel
     end
   end # class << self
 
-  include Cabin::Mixins::Logger
   include Cabin::Mixins::Timestamp
+  include Cabin::Mixins::Logger
   include Cabin::Mixins::Timer
 
   # All channels come with a metrics provider.
@@ -83,16 +98,19 @@ class Cabin::Channel
   # Create a new logging channel.
   # The default log level is 'info'
   def initialize
-    @outputs = []
+    @subscribers = {}
     @data = {}
     @level = :info
     @metrics = Cabin::Metrics.new
     @metrics.channel = self
+    @subscriber_lock = Mutex.new
   end # def initialize
 
   # Subscribe a new input
   # New events will be sent to the subscriber using the '<<' method
   #   foo << event
+  #
+  # Returns a subscription id you can use later to unsubscribe
   def subscribe(output)
     # Wrap ruby stdlib Logger if given.
     if output.is_a?(::Logger)
@@ -100,10 +118,18 @@ class Cabin::Channel
     elsif output.is_a?(::IO)
       output = Cabin::Outputs::IO.new(output)
     end
-    @outputs << output
-    # TODO(sissel): Return a method or object that allows you to easily
-    # unsubscribe?
+    @subscriber_lock.synchronize do
+      @subscribers[output.object_id] = output
+    end
+    return output.object_id
   end # def subscribe
+
+  # Unsubscribe. Takes a 'subscription id' as returned by the subscribe method
+  def unsubscribe(id)
+    @subscriber_lock.synchronize do
+      @subscribers.delete(id)
+    end
+  end # def unsubscribe
  
   # Set some contextual map value
   def []=(key, value)
@@ -129,20 +155,21 @@ class Cabin::Channel
   # is a string ISO8601 timestamp with microsecond precision.
   def publish(data)
     event = {}
-    event.merge!(@data) # Merge any logger context
+    self.class.filters.each do |filter|
+      filter.call(event)
+    end
 
     if data.is_a?(String)
       event[:message] = data
     else
       event.merge!(data)
     end
+    event.merge!(@data) # Merge any logger context
 
-    self.class.filters.each do |filter|
-      filter.call(event)
-    end
-
-    @outputs.each do |out|
-      out << event
+    @subscriber_lock.synchronize do
+      @subscribers.each do |id, output|
+        output << event
+      end
     end
   end # def publish
 
@@ -158,5 +185,5 @@ class Cabin::Channel
     return data
   end # def dataify
 
-  public(:initialize, :context, :subscribe, :[]=, :[], :remove, :publish, :time, :context)
+  public(:initialize, :context, :subscribe, :unsubscribe, :[]=, :[], :remove, :publish, :time, :context)
 end # class Cabin::Channel

data/lib/cabin/mixins/logger.rb

@@ -93,7 +93,7 @@ module Cabin::Mixins::Logger
         data[:exception] = message.class
         data[:backtrace] = message.backtrace
       else
-        data[:message] = message
+        data = { :message => message }.merge(data)
     end
 
     # Add extra debugging bits (file, line, method) if level is debug.

data/lib/cabin/outputs/io.rb

@@ -1,5 +1,6 @@
 require "cabin"
 require "json"
+require "thread"
 
 # Wrap IO objects with a reasonable log output. 
 #
@@ -42,14 +43,17 @@ class Cabin::Outputs::IO
 
   def initialize(io)
     @io = io
+    @lock = Mutex.new
   end # def initialize
 
   # Receive an event
   def <<(event)
-    if !@io.tty?
-      @io.puts(event.to_json)
-    else
-      tty_write(event)
+    @lock.synchronize do
+      if !@io.tty?
+        @io.puts(event.to_json)
+      else
+        tty_write(event)
+      end
     end
   end # def <<
 

data/test/test_logging.rb

@@ -56,12 +56,11 @@ describe Cabin::Channel do
     assert(event[:duration].is_a?(Numeric))
   end
 
-  test "double subscription" do
+  test "double subscription should still only subscribe once" do
     @logger.subscribe(@target)
     @logger.publish("Hello world")
-    assert_equal(2, @target.data.length)
+    assert_equal(1, @target.data.length)
     assert_equal("Hello world", @target.data[0][:message])
-    assert_equal("Hello world", @target.data[1][:message])
   end 
 
   test "context values" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cabin
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-09 00:00:00.000000000 Z
+date: 2012-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &17116580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *17116580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 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!
@@ -88,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.16
+rubygems_version: 1.8.18
 signing_key: 
 specification_version: 3
 summary: Experiments in structured and contextual logging