cabin 0.4.4 → 0.5.0

data/lib/cabin/metrics.rb

@@ -51,6 +51,7 @@ class Cabin::Metrics
   # Get us a new metrics container.
   public
   def initialize
+    @metrics_lock = Mutex.new
     @metrics = {}
   end # def initialize
 
@@ -76,7 +77,9 @@ class Cabin::Metrics
     if @channel
       @channel.debug("Created metric", :instance => instance, :type => metric_object.class)
     end
-    return @metrics[metric_name] = metric_object
+    return @metrics_lock.synchronize do
+      @metrics[metric_name] = metric_object
+    end
   end # def create
 
   # Create a new Counter metric
@@ -114,6 +117,8 @@ class Cabin::Metrics
   # iterate over each metric. yields identifer, metric
   def each(&block)
     # delegate to the @metrics hash until we need something fancier
-    @metrics.each(&block)
+    @metrics_lock.synchronize do
+      @metrics.each(&block)
+    end
   end # def each
 end # class Cabin::Metrics

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

@@ -1,11 +1,8 @@
 require "cabin"
-require "json"
 require "eventmachine"
 
 # Wrap Ruby stdlib's logger and make it EventMachine friendly. This
-# allows you to output to a normal ruby logger with Cabin. Since
-# Ruby's Logger has a love for strings alone, this wrapper will
-# convert the data/event to json before sending it to Logger.
+# allows you to output to a normal ruby logger with Cabin.
 class Cabin::Outputs::EM::StdlibLogger
   public
   def initialize(logger)
@@ -33,7 +30,7 @@ class Cabin::Outputs::EM::StdlibLogger
   def <<(data)
     line = Hash.new
     line[:method] = data[:level] || "info"
-    line[:message] = "#{data[:message]} #{data.to_json}"
+    line[:message] = "#{data[:message]} #{data.inspect}"
     if EM::reactor_running?
       # Push line onto queue for later sending
       @logger_queue.push(line)

data/lib/cabin/outputs/io.rb

@@ -1,17 +1,16 @@
 require "cabin"
-require "json"
 require "thread"
 
 # Wrap IO objects with a reasonable log output. 
 #
 # If the IO is *not* attached to a tty (io#tty? returns false), then
-# the event will be written in json format terminated by a newline:
+# the event will be written in ruby inspect format terminated by a newline:
 #
-#     { "timestamp": ..., "message": message, ... }
+#     { "timestamp" => ..., "message" => message, ... }
 #
 # If the IO is attached to a TTY, there are # human-friendly in this format:
 #
-#     message {json data}
+#     message { event data }
 #
 # Additionally, colorized output may be available. If the event has :level,
 # :color, or :bold. Any of the Cabin::Mixins::Logger methods (info, error, etc)
@@ -50,7 +49,7 @@ class Cabin::Outputs::IO
   def <<(event)
     @lock.synchronize do
       if !@io.tty?
-        @io.puts(event.to_json)
+        @io.puts(event.inspect)
       else
         tty_write(event)
       end
@@ -77,7 +76,7 @@ class Cabin::Outputs::IO
     if data.empty?
       message = [event[:message]]
     else
-      message = ["#{event[:message]} #{data.to_json}"]
+      message = ["#{event[:message]} #{data.inspect}"]
     end
     message.unshift("\e[#{CODEMAP[color.to_sym]}m") if !color.nil?
     message.unshift("\e[#{CODEMAP[bold]}m") if !bold.nil?

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

@@ -1,9 +1,9 @@
 require "cabin"
-require "json"
 
 # Wrap Ruby stdlib's logger. This allows you to output to a normal ruby logger
 # with Cabin. Since Ruby's Logger has a love for strings alone, this 
-# wrapper will convert the data/event to json before sending it to Logger.
+# wrapper will convert the data/event to ruby inspect format before sending it
+# to Logger.
 class Cabin::Outputs::StdlibLogger
   public
   def initialize(logger)
@@ -24,7 +24,7 @@ class Cabin::Outputs::StdlibLogger
     # delete things from the 'data' portion that's not really data.
     data.delete(:message)
     data.delete(:timestamp)
-    message = "#{event[:message]} #{data.to_json}"
+    message = "#{event[:message]} #{data.inspect}"
 
     #p [@logger.level, logger.class::DEBUG]
     # This will call @logger.info(data) or something similar.

data/lib/cabin/outputs/zeromq.rb

@@ -0,0 +1,96 @@
+require 'cabin'
+require 'ffi-rzmq'
+
+# Output to a zeromq socket.
+class Cabin::Outputs::ZeroMQ
+  DEFAULTS = {
+    :topology => "pushpull",
+    :hwm => 0, # zeromq default: no limit
+    :linger => -1, # zeromq default: wait until all messages are sent.
+    :topic => ""
+  }
+
+  CONTEXT = ZMQ::Context.new
+
+  attr_reader :socket, :topology, :topic
+
+  # Create a new ZeroMQ output.
+  #
+  # arguments:
+  # addresses A list of addresses to connect to. These are round-robined by zeromq.
+  # 
+  # :topology Either 'pushpull' or 'pubsub'. Specifies which zeromq socket type to use. Default pushpull.
+  # :hwm Specifies the High Water Mark for the socket. Default 0, which means there is none.
+  # :linger Specifies the linger time in milliseconds for the socket. Default -1, meaning wait forever for the socket to close.
+  # :topic Specifies the topic for a pubsub topology. This can be a string or a proc with the event as the only argument.
+  def initialize(addresses, options={})
+    options = DEFAULTS.merge(options)
+
+    @topology = options[:topology].to_s
+    case @topology
+    when "pushpull"
+      socket_type = ZMQ::PUSH
+    when "pubsub"
+      socket_type = ZMQ::PUB
+    end
+
+    @topic = options[:topic]
+    @socket = CONTEXT.socket(socket_type)
+    
+    Array(addresses).each do |address|
+      error_check @socket.connect(address), "connecting to #{address}"
+    end
+
+    error_check @socket.setsockopt(ZMQ::LINGER, options[:linger]), "while setting ZMQ::LINGER to #{options[:linger]}"
+    error_check @socket.setsockopt(ZMQ::HWM, options[:hwm]), "while setting ZMQ::HWM to #{options[:hwm]}"
+
+    #TODO use cabin's teardown when it exists
+    at_exit do
+      teardown
+    end
+
+    #define_finalizer
+  end
+
+  def linger
+    array = []
+    error_check @socket.getsockopt(ZMQ::LINGER, array), "while getting ZMQ::LINGER"
+    array.first
+  end
+
+  def hwm
+    array = []
+    error_check @socket.getsockopt(ZMQ::HWM, array), "while getting ZMQ::HWM"
+    array.first
+  end
+
+  def <<(event)
+    if @socket.name == "PUB"
+      topic = @topic.is_a?(Proc) ? @topic.call(event) : @topic
+      error_check @socket.send_string(topic, ZMQ::SNDMORE), "in topic send_string"
+    end
+    error_check @socket.send_string(event.inspect), "in send_string"
+  end
+
+  def teardown
+    @socket.close if @socket
+  end
+
+  private
+  def error_check(rc, doing)
+    unless ZMQ::Util.resultcode_ok?(rc)
+      raise "ZeroMQ Error while #{doing}"
+    end
+  end
+
+  # This causes the following message on exit:
+  # File exists (epoll.cpp:69)
+  # [1]    26175 abort      bundle exec irb
+  # def define_finalizer
+  #   ObjectSpace.define_finalizer(self, self.class.finalize(@socket))
+  # end
+
+  # def self.finalize(socket)
+  #   Proc.new { puts "finalizing"; socket.close unless socket.nil?; puts "done" }
+  # end
+end

data/test/all.rb

@@ -9,5 +9,9 @@ SimpleCov.start
 dir = File.dirname(File.expand_path(__FILE__))
 Dir.glob(File.join(dir, "**", "test_*.rb")).each do |path|
   puts "Loading tests from #{path}"
+  if path =~ /test_zeromq/
+    puts "Skipping zeromq tests because they force ruby to exit if libzmq is not found"
+    next
+  end
   require path
 end

data/test/test_zeromq.rb

@@ -0,0 +1,99 @@
+$: << File.dirname(__FILE__)
+$: << File.join(File.dirname(__FILE__), "..", "lib")
+
+require "rubygems"
+require "minitest-patch"
+require "cabin/outputs/zeromq"
+require "minitest/autorun" if __FILE__ == $0
+
+describe Cabin::Outputs::ZeroMQ do
+
+  def error_check(rc, doing)
+    unless ZMQ::Util.resultcode_ok?(rc)
+      raise "ZeroMQ Error while #{doing}"
+    end
+  end
+
+  NonBlockingFlag = (ZMQ::LibZMQ.version2? ? ZMQ::NOBLOCK : ZMQ::DONTWAIT) unless defined?(NonBlockingFlag)
+  def receive(socket)
+    received = ""
+    error_check socket.recv_string(received, NonBlockingFlag), "receiving"
+    received
+  end
+
+  before do
+    @logger = Cabin::Channel.new
+    @address = "inproc://zeromq-output"
+    @pull   = Cabin::Outputs::ZeroMQ::CONTEXT.socket(ZMQ::PULL)
+    @sub    = Cabin::Outputs::ZeroMQ::CONTEXT.socket(ZMQ::SUB)
+  end
+
+  after do
+    @pull.close
+    @sub.close
+    @output.teardown if @output
+  end
+
+  test 'push messages' do
+    @pull.bind(@address); sleep 0.1 # sleeps are necessary for inproc transport
+    @output = Cabin::Outputs::ZeroMQ.new(@address)
+    @logger.subscribe(@output)
+    @logger.info("hello")
+    @logger.info("hello2")
+    assert_equal "hello", JSON.parse(receive(@pull))['message']
+    assert_equal "hello2", JSON.parse(receive(@pull))['message']
+  end
+
+  test "pub messages" do
+    @sub.bind(@address); sleep 0.1
+    error_check @sub.setsockopt(ZMQ::SUBSCRIBE, ""), "subscribing"
+    @output = Cabin::Outputs::ZeroMQ.new(@address, :topology => "pubsub")
+    @logger.subscribe(@output)
+    @logger.info("hi")
+    assert_equal "", receive(@sub)
+    assert_equal "hi", JSON.parse(receive(@sub))['message']
+  end
+
+  test "pub messages on a topic" do
+    @sub.bind(@address); sleep 0.1
+    error_check @sub.setsockopt(ZMQ::SUBSCRIBE, "topic"), "subscribing"
+    @output = Cabin::Outputs::ZeroMQ.new(@address, :topology => "pubsub", :topic => "topic")
+    @logger.subscribe(@output)
+    @logger.info("hi")
+    assert_equal "topic", receive(@sub)
+    assert_equal "hi", JSON.parse(receive(@sub))['message']
+  end
+
+  test "topic proc" do
+    @sub.bind(@address); sleep 0.1
+    error_check @sub.setsockopt(ZMQ::SUBSCRIBE, "topic2"), "subscribing"
+    @output = Cabin::Outputs::ZeroMQ.new(@address, :topology => "pubsub", :topic => Proc.new { |event| event[:message] })
+    @logger.subscribe(@output)
+    @logger.info("topic1")
+    @logger.info("topic2")
+    assert_equal "topic2", receive(@sub)
+    assert_equal "topic2", JSON.parse(receive(@sub))['message']
+  end
+
+  test "multiple addresses" do
+    @pull.bind(@address); sleep 0.1
+    @pull2 = Cabin::Outputs::ZeroMQ::CONTEXT.socket(ZMQ::PULL)
+    @pull2.bind(@address.succ); sleep 0.1
+
+    @output = Cabin::Outputs::ZeroMQ.new([@address, @address.succ])
+    @logger.subscribe(@output)
+    @logger.info("yo")
+    @logger.info("yo")
+
+    assert_equal "yo", JSON.parse(receive(@pull))['message']
+    assert_equal "yo", JSON.parse(receive(@pull2))['message']
+  end
+
+  test "options" do
+    @pull.bind(@address); sleep 0.1
+    @output = Cabin::Outputs::ZeroMQ.new(@address, :hwm => 10, :linger => 100)
+
+    assert_equal 10, @output.hwm
+    assert_equal 100, @output.linger
+  end
+end

metadata

@@ -1,35 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: cabin
 version: !ruby/object:Gem::Version
-  version: 0.4.4
-  prerelease: 
+  prerelease:
+  version: 0.5.0
 platform: ruby
 authors:
 - Jordan Sissel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-03-23 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  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!
+date: 2012-11-09 00:00:00.000000000 Z
+dependencies: []
+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!
 email:
 - jls@semicomplete.com
 executables:
@@ -37,65 +19,101 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/cabin/metrics/histogram.rb
-- lib/cabin/metrics/timer.rb
-- lib/cabin/metrics/gauge.rb
-- lib/cabin/metrics/meter.rb
-- lib/cabin/metrics/counter.rb
-- lib/cabin/publisher.rb
-- lib/cabin/channel.rb
-- lib/cabin/mixins/logger.rb
-- lib/cabin/mixins/colors.rb
-- lib/cabin/mixins/dragons.rb
-- lib/cabin/mixins/CAPSLOCK.rb
-- lib/cabin/mixins/timer.rb
-- lib/cabin/mixins/timestamp.rb
-- lib/cabin/timer.rb
-- lib/cabin/metric.rb
-- lib/cabin/metrics.rb
-- lib/cabin/namespace.rb
-- lib/cabin/inspectable.rb
-- lib/cabin/outputs/io.rb
-- lib/cabin/outputs/stdlib-logger.rb
-- lib/cabin/outputs/em/stdlib-logger.rb
-- lib/cabin/context.rb
-- lib/cabin.rb
-- examples/fibonacci-timing.rb
-- examples/sinatra-logging.rb
-- examples/sample.rb
-- examples/metrics.rb
-- test/test_logging.rb
-- test/test_metrics.rb
-- test/minitest-patch.rb
-- test/all.rb
+- !binary |-
+  bGliL2NhYmluLnJi
+- !binary |-
+  bGliL2NhYmluL2NoYW5uZWwucmI=
+- !binary |-
+  bGliL2NhYmluL2NvbnRleHQucmI=
+- !binary |-
+  bGliL2NhYmluL2luc3BlY3RhYmxlLnJi
+- !binary |-
+  bGliL2NhYmluL21ldHJpYy5yYg==
+- !binary |-
+  bGliL2NhYmluL21ldHJpY3MucmI=
+- !binary |-
+  bGliL2NhYmluL25hbWVzcGFjZS5yYg==
+- !binary |-
+  bGliL2NhYmluL3B1Ymxpc2hlci5yYg==
+- !binary |-
+  bGliL2NhYmluL3RpbWVyLnJi
+- !binary |-
+  bGliL2NhYmluL21ldHJpY3MvY291bnRlci5yYg==
+- !binary |-
+  bGliL2NhYmluL21ldHJpY3MvZ2F1Z2UucmI=
+- !binary |-
+  bGliL2NhYmluL21ldHJpY3MvaGlzdG9ncmFtLnJi
+- !binary |-
+  bGliL2NhYmluL21ldHJpY3MvbWV0ZXIucmI=
+- !binary |-
+  bGliL2NhYmluL21ldHJpY3MvdGltZXIucmI=
+- !binary |-
+  bGliL2NhYmluL21peGlucy9DQVBTTE9DSy5yYg==
+- !binary |-
+  bGliL2NhYmluL21peGlucy9jb2xvcnMucmI=
+- !binary |-
+  bGliL2NhYmluL21peGlucy9kcmFnb25zLnJi
+- !binary |-
+  bGliL2NhYmluL21peGlucy9sb2dnZXIucmI=
+- !binary |-
+  bGliL2NhYmluL21peGlucy90aW1lci5yYg==
+- !binary |-
+  bGliL2NhYmluL21peGlucy90aW1lc3RhbXAucmI=
+- !binary |-
+  bGliL2NhYmluL291dHB1dHMvaW8ucmI=
+- !binary |-
+  bGliL2NhYmluL291dHB1dHMvc3RkbGliLWxvZ2dlci5yYg==
+- !binary |-
+  bGliL2NhYmluL291dHB1dHMvemVyb21xLnJi
+- !binary |-
+  bGliL2NhYmluL291dHB1dHMvZW0vc3RkbGliLWxvZ2dlci5yYg==
+- !binary |-
+  ZXhhbXBsZXMvZmlib25hY2NpLXRpbWluZy5yYg==
+- !binary |-
+  ZXhhbXBsZXMvbWV0cmljcy5yYg==
+- !binary |-
+  ZXhhbXBsZXMvc2FtcGxlLnJi
+- !binary |-
+  ZXhhbXBsZXMvc2luYXRyYS1sb2dnaW5nLnJi
+- !binary |-
+  dGVzdC9hbGwucmI=
+- !binary |-
+  dGVzdC9taW5pdGVzdC1wYXRjaC5yYg==
+- !binary |-
+  dGVzdC90ZXN0X2xvZ2dpbmcucmI=
+- !binary |-
+  dGVzdC90ZXN0X21ldHJpY3MucmI=
+- !binary |-
+  dGVzdC90ZXN0X3plcm9tcS5yYg==
 - LICENSE
 - CHANGELIST
 - bin/rubygems-cabin-test
 homepage: https://github.com/jordansissel/ruby-cabin
 licenses:
 - Apache License (2.0)
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: !binary |-
+        MA==
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: !binary |-
+        MA==
+  none: false
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.18
-signing_key: 
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
 specification_version: 3
 summary: Experiments in structured and contextual logging
 test_files: []
-has_rdoc: