structured-event-logger 0.0.6 → 0.1.0

data/lib/structured_event_logger.rb

@@ -1,17 +1,32 @@
 require 'securerandom'
 
 class StructuredEventLogger
+
+  class Error < ::StandardError; end
+
+  class EndpointException < StructuredEventLogger::Error
+    attr_reader :name, :wrapped_exception
+    def initialize(name, wrapped_exception)
+      @name, @wrapped_exception = name, wrapped_exception
+      super("Endpoint #{name} failed - #{wrapped_exception.class.name}: #{wrapped_exception.message}")
+    end
+  end
+
   attr_reader :endpoints, :default_context
+  attr_accessor :error_handler
 
   def initialize(endpoints = {})
     @endpoints = endpoints
 
     @thread_contexts = {}
     @default_context = {}
+    @error_handler = lambda { |exception| raise(exception) }
   end
 
   def event(scope, event, content = {})
     log_event scope, event, flatten_hash(content)
+  rescue EndpointException => e
+    error_handler.call(e)
   end
 
   def context
@@ -42,7 +57,7 @@ class StructuredEventLogger
       begin
         endpoint.call(scope, event, hash, record)
       rescue => e
-        $stderr.write("Failed to submit event #{scope}/#{event} to #{name} endpoint: #{e.message}.\n")
+        raise EndpointException.new(name, e)
       end
     end
   end
@@ -52,5 +67,6 @@ class StructuredEventLogger
   end
 end
 
+require 'structured_event_logger/syslogger'
 require 'structured_event_logger/json_writer'
 require 'structured_event_logger/human_readable_logger'

data/lib/structured_event_logger/syslogger.rb

@@ -0,0 +1,20 @@
+require 'multi_json'
+require 'active_support/json'
+require 'syslog'
+
+class StructuredEventLogger::Syslogger
+
+  class MessageExceedsMaximumSize < StructuredEventLogger::Error; end
+
+  attr_accessor :log_level, :max_size
+
+  def initialize(log_level = Syslog::LOG_INFO, max_size = 64 * 1024 - 1)
+    @log_level, @max_size = log_level, max_size
+  end
+
+  def call(scope, event, hash, record)
+    message = MultiJson.encode(record)
+    raise MessageExceedsMaximumSize, "Event too big to be submitted to syslog" if message.bytesize > max_size
+    Syslog.log(log_level, '%s', message)
+  end
+end

data/lib/structured_event_logger/version.rb

@@ -1,3 +1,3 @@
 class StructuredEventLogger
-  VERSION = "0.0.6"
+  VERSION = "0.1.0"
 end

data/test/structured_event_logger_test.rb

@@ -15,6 +15,11 @@ class StructuredEventLoggerTest < Minitest::Test
     
     Time.stubs(:now).returns(Time.parse('2012-01-01T05:00:00Z'))
     SecureRandom.stubs(:uuid).returns('aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee')
+    Syslog.open('test_structured_event_logger') unless Syslog.opened?
+  end
+
+  def teardown
+    Syslog.close
   end
 
   def test_should_log_event_to_both_loggers
@@ -112,6 +117,47 @@ class StructuredEventLoggerTest < Minitest::Test
     assert_last_event_does_not_contain :request_id
   end
 
+  def test_should_submit_events_to_syslog
+    Syslog.expects(:log).with do |log_level, format_string, argument|
+      event_data = JSON.parse(argument)
+      assert_equal Syslog::LOG_INFO, log_level
+      assert_equal '%s', format_string
+      assert_equal 'test', event_data['event_scope']
+      assert_equal 'syslog', event_data['event_name']
+      assert_equal 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee', event_data['event_uuid']
+      assert_equal '2012-01-01T05:00:00Z', event_data['event_timestamp']
+      assert_equal 'test', event_data['message']
+    end
+
+    @event_logger.endpoints[:syslog] = StructuredEventLogger::Syslogger.new
+    @event_logger.event(:test, :syslog, message: 'test')
+  end
+
+  def test_should_fail_when_syslog_message_is_too_large
+    @event_logger.endpoints[:syslog] = StructuredEventLogger::Syslogger.new
+    assert_raises(StructuredEventLogger::EndpointException) do
+      @event_logger.event(:test, :syslog, message: 'a' * (64 * 1024 + 1))
+    end
+  end
+
+  def test_should_execute_a_custom_error_handler_on_failure
+    @event_logger.endpoints[:failer] = proc { raise "FAIL" }
+    @event_logger.error_handler = mock()
+    @event_logger.error_handler.expects(:call).with do |exception|
+      assert_kind_of StructuredEventLogger::EndpointException, exception
+      assert_equal 'FAIL', exception.wrapped_exception.message
+      assert_equal 'Endpoint failer failed - RuntimeError: FAIL', exception.message
+    end
+    @event_logger.event(:test, :fail)
+  end
+
+  def test_should_raise_exception_when_endpoint_fails
+    @event_logger.endpoints[:failer] = proc { raise "FAIL" }
+    assert_raises(StructuredEventLogger::EndpointException) do
+      @event_logger.event(:test, :fail)
+    end
+  end  
+
   private 
 
   def assert_last_event_contains_value(value, key)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: structured-event-logger
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -127,6 +127,7 @@ files:
 - lib/structured_event_logger.rb
 - lib/structured_event_logger/human_readable_logger.rb
 - lib/structured_event_logger/json_writer.rb
+- lib/structured_event_logger/syslogger.rb
 - lib/structured_event_logger/version.rb
 - structured-event-logger.gemspec
 - test/structured_event_logger_test.rb