amqp_logging 0.3.0

data/README.rdoc

@@ -0,0 +1,44 @@
+=AMQPLogging
+
+
+A ruby logger class that logs to an {AMQP}[http://www.amqp.org/] exchange in addition to your default log device.
+
+==Basic Configuration
+By default the logs are routed to the host, exchange and key specified in DEFAULT_OPTIONS.
+You can change the configuration when creating the logger object by specifying an argument hash:
+
+	require 'amqp_logging'
+
+	logging_config = { :routing_key => "applogging",
+	                   :host => AppConfig.amqp_logging.host,
+	                   :exchange => AppConfig.amqp_logging.exchange }
+
+	logger = AMQPLogging::Logger.new(config.log_path, logging_config)
+	config.logger = logger
+
+==Routing Keys
+
+You can set the routing key with a string or use a generator that respondes to call,
+receives the logline as the first argument and returns the routing key.
+
+Example:
+
+	# You can use a lambda or whatever responds to #call as the routing key generator
+	AMQPRoutingKeyGenerator = lambda do |logline|
+	  if logline =~ /(?:engine\[([^\]]*)\])\: (Completed in|Processing|Session ID)?/
+	    key = "logs.app.#{$1}"
+	    key << ".statistics" unless $2.nil?
+	  else
+	    key = "logs.app.system"
+	  end
+	  key
+	end
+
+	AMQPLogging::Logger.new($stdout, :routing_key => AMQPRoutingKeyGenerator)
+
+==License
+
+Copyright © 2010 Pascal Friederich
+Copyright © 2010 XING AG
+
+See LICENSES for details.

data/lib/amqp_logging.rb

@@ -0,0 +1,84 @@
+require 'bunny'
+require 'active_support'
+
+module AMQPLogging
+
+  DEFAULT_OPTIONS = {
+    :shift_age    => 0,
+    :shift_size   => 1048576,
+    :host         => "localhost",
+    :exchange     => "logging_exchange",
+    :queue        => "logging_queue",
+    :routing_key  => "logs"
+  }
+
+  RETRY_AFTER = 10.seconds
+
+  class Logger < ::Logger
+    attr_accessor :extra_attributes
+    attr_accessor :errback
+
+    def initialize(logdev, *args)
+      options = args.first.is_a?(Hash) ? DEFAULT_OPTIONS.merge(args.first) : DEFAULT_OPTIONS
+      super(logdev, options[:shift_age], options[:shift_size])
+      @logdev = AMQPLogDevice.new(@logdev, options)
+      @logdev.logger = self
+    end
+  end
+
+  class AMQPLogDevice
+    attr_reader :exchange, :configuration
+    attr_accessor :logger
+
+    def initialize(dev, opts = {})
+      @configuration = opts
+      @fallback_logdev = dev
+    end
+
+    def write(msg)
+      begin
+        if !@paused || @paused <= RETRY_AFTER.ago
+          routing_key = configuration[:routing_key].respond_to?(:call) ? configuration[:routing_key].call(msg).to_s : configuration[:routing_key]
+          exchange.publish(msg, :key => routing_key)
+        end
+      rescue Exception => exception
+        pause_amqp_logging(exception)
+      ensure
+        @fallback_logdev.write(msg)
+      end
+    end
+
+    def close
+      @fallback_logdev.close
+    end
+
+    private
+      def pause_amqp_logging(exception)
+        @paused = Time.now
+        reset_amqp
+        logger.errback.call(exception) if logger.errback && logger.errback.respond_to?(:call)
+      end
+
+      def reset_amqp
+        begin
+          bunny.stop if bunny.connected?
+        rescue
+          # if bunny throws an exception here, its not usable anymore anyway
+        ensure
+          @exchange = @bunny = nil
+        end
+      end
+
+      def exchange
+        bunny.start unless bunny.connected?
+        @exchange ||= bunny.exchange(configuration[:exchange], :type => :topic)
+      end
+
+      def bunny
+        @bunny ||= Bunny.new(:host => @configuration[:host])
+        @bunny
+      end
+  end
+
+end
+

data/test/amqp_logger_test.rb

@@ -0,0 +1,97 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+
+class TheAMQPLoggerTest < Test::Unit::TestCase
+  def setup
+    @io = StringIO.new
+  end
+
+  test "should be instanciated like a normal logger" do
+    assert_nothing_raised { AMQPLogging::Logger.new(@io) }
+    assert_nothing_raised { AMQPLogging::Logger.new(@io, 2) }
+    assert_nothing_raised { AMQPLogging::Logger.new(@io, 2, 1048576) }
+  end
+
+  test "should be instanciated with an amqp configuration hash" do
+    config = { :queue => "testqueue", :exchange => "testexchange", :host => "testhost", :shift_age => 4, :shift_size => 1338, :routing_key => "foobar" }
+    AMQPLogging::AMQPLogDevice.expects(:new).with(anything, config).returns(stub_everything)
+
+    logger = AMQPLogging::Logger.new(@io, config)
+  end
+
+  test "should write to the default io" do
+    AMQPLogging::AMQPLogDevice.any_instance.stubs(:exchange).returns(stub_everything('test_exchange'))
+    logger = AMQPLogging::Logger.new(@io)
+    logger.debug "logging something"
+    assert_match "logging something", @io.string
+  end
+
+  test "should pause AMQP logging if exceptions during logging occure" do
+    # in case you ask why not just using mocha expectations here: the rescue in the tested code also rescues the mocha exception
+    # this fake exchange object increases a counter everytime publish is executed so we can check the number of executions
+    class TestExchange; attr_reader :counter; def publish(*args); @counter ||= 0; @counter += 1; raise 'Foo'; end; end
+    logger = AMQPLogging::Logger.new(@io)
+    exchange = TestExchange.new
+    AMQPLogging::AMQPLogDevice.any_instance.stubs(:exchange).returns(exchange)
+    AMQPLogging::AMQPLogDevice.any_instance.stubs(:bunny).returns(stub_everything("bunny stub"))
+    2.times { logger.debug "This will raise" }
+
+    assert_equal 1, exchange.counter
+  end
+  
+  test "should call the logger errback with the exception that occured if one is set" do
+    class FooBarException < Exception; end
+    @called = false
+
+    errback = lambda {|exception| begin raise exception; rescue FooBarException; @called = true; end}
+    raising_exchange = mock("mocked exchange")
+    raising_exchange.expects(:publish).raises(FooBarException)
+    AMQPLogging::AMQPLogDevice.any_instance.stubs(:exchange).returns(raising_exchange)
+    logger = AMQPLogging::Logger.new(@io)
+    logger.errback = errback
+
+    assert_nothing_raised do
+      logger.debug("this will raise")
+    end
+    assert @called
+  end
+
+  test "should reset the bunny and exchange instance if a exception occures" do
+    raising_exchange = mock("mocked exchange")
+    raising_exchange.expects(:publish).raises("FFFFFFFFUUUUUUUUUU")
+    AMQPLogging::AMQPLogDevice.any_instance.stubs(:exchange).returns(raising_exchange)
+    logger = AMQPLogging::Logger.new(@io)
+
+    AMQPLogging::AMQPLogDevice.any_instance.expects(:reset_amqp)
+    logger.debug("This will raise and send a notification")
+  end
+
+end
+
+class TheLogDeviceTest < Test::Unit::TestCase
+  test "should initialize the AMQP components correctly" do
+    config = { :queue => "testqueue", :exchange => "testexchange", :host => "testhost", :shift_age => 4, :shift_size => 1338 }
+    bunny_stub = stub_everything("bunny_stub")
+    Bunny.expects(:new).with(:host => "testhost").returns(bunny_stub)
+    bunny_stub.expects(:exchange).with(config[:exchange], :type => :topic).returns(stub("exchange stub"))
+
+    logger = AMQPLogging::Logger.new(StringIO.new, config)
+    logger.debug("foobar")
+  end
+
+  test "should publish the messages with the default routing key" do
+    exchange = mock()
+    exchange.expects(:publish).with("msg\n", :key => "a_routing_key")
+    AMQPLogging::AMQPLogDevice.any_instance.stubs(:exchange).returns(exchange)
+    AMQPLogging::Logger.new(StringIO.new, {:routing_key => "a_routing_key"}).debug("msg")
+  end
+
+  test "should take a proc argument to generate the routing key" do
+    key_generator = lambda {|msg| msg == "a message\n" }
+    exchange = mock()
+    exchange.expects(:publish).with("a message\n", :key => "true")
+    AMQPLogging::AMQPLogDevice.any_instance.stubs(:exchange).returns(exchange)
+    AMQPLogging::Logger.new(StringIO.new, {:routing_key => key_generator}).debug("a message")
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+require 'active_support/testing/declarative'
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/amqp_logging')
+
+begin
+  require 'redgreen' unless ENV['TM_FILENAME']
+rescue LoadError
+end
+
+class Test::Unit::TestCase
+  extend ActiveSupport::Testing::Declarative
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification 
+name: amqp_logging
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Pascal Friederich
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-11 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bunny
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: 
+email: 
+- pascal.friederich@xing.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/amqp_logging.rb
+- README.rdoc
+- test/amqp_logger_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/paukul/amqp-logging
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A ruby logger class that logs to an AMQP exchange in addition to your default log device.
+test_files: 
+- test/amqp_logger_test.rb
+- test/test_helper.rb