structured-event-logger 0.0.4 → 0.0.5

data/README.md

@@ -1,6 +1,7 @@
 # StructuredEventLogger
 
-Structured event logger that writes events to both a human readable log and a JSON formatted log
+Structured event logger that submits events to a list of listeners, including
+human readable logs, json formatted event streams, and other endpoints.
 
 ## Installation
 
@@ -18,10 +19,13 @@ Or install it yourself as:
 
 ## Usage
 
-    # Creating an instance
-    json_logger = File.open(Rails.root.join("log", "event.log"), "a")
-    human_readable_logger = Rails.logger
-    event_logger = StructuredEventLogger.new(json_logger, human_readable_logger)
+    # Creating an instance of a StructuredEventLogger with several endpoints.
+    # The listeners provided to the constructors should respond to #log_event.
+    json_io = File.open(Rails.root.join("log", "event.log"), "a")
+    event_logger = StructuredEventLogger.new([
+        StructuredEventLogger::HumanReadableLogger.new(Rails.logger),
+        StructuredEventLogger::JsonWriter.new(json_io)
+    ])
 
     # Basic usage
     event_logger.event('scope', event, field: 'value', other_field: 'other value')
@@ -36,6 +40,18 @@ Or install it yourself as:
     # later, while processing a request inside that filter
     event_logger.event('scope', 'event', other_value: 'blah') # will also include { my_value: 'whatever' }
 
+## Fields
+
+The default event fields that this library sets are prefixed with `event_`:
+
+- `event_scope`: scope of the event, the first parameter to the `event` call.
+- `event_name`: name of the event, the second parameter to the `event` call.
+- `event_uuid`: A unique identifier for the event generated using `SecureRandom.uuid`.
+- `event_timestamp`: The timestamp of the event, set to `Time.now.utc`.
+
+All these fields can be overriden by passing new values to the context hash, i.e. the
+third parameter to the `event` call.
+
 ## Contributing
 
 1. Fork it

data/lib/structured_event_logger.rb

@@ -1,28 +1,13 @@
-require 'logger'
 require 'securerandom'
-require 'active_support/json'
-require 'active_support/log_subscriber'
 
 class StructuredEventLogger
-  CLEAR   = "\e[0m"
-  BOLD    = "\e[1m"
+  attr_reader :endpoints, :default_context
 
-  # Colors
-  MAGENTA = "\e[35m"
-  CYAN    = "\e[36m"
-  WHITE   = "\e[37m"
+  def initialize(endpoints = [])
+    @endpoints = endpoints
 
-  attr_reader :json_io, :unstructured_logger, :colorize_logging, :default_context
-
-  def initialize(json_io, unstructured_logger = nil)
-    @json_io, @unstructured_logger = json_io, unstructured_logger
     @thread_contexts = {}
     @default_context = {}
-    @colorize_logging = ActiveSupport::LogSubscriber.colorize_logging
-  end
-
-  def log(msg = nil)
-    unstructured_logger.add(nil, msg)
   end
 
   def event(scope, event, content = {})
@@ -35,25 +20,6 @@ class StructuredEventLogger
 
   private
 
-  def format_hash(scope, event, hash, separator = ', ')
-    @odd = !@odd
-    message = hash.map {|k, v| "#{k}=#{escape(v)}"}.join(separator)
-    if @colorize_logging
-      "  #{@odd ? CYAN : MAGENTA}#{BOLD}[#{scope}] #{event}: #{WHITE}#{message}#{CLEAR}"
-    else
-      "  [#{scope}] #{event}: #{message}"
-    end
-  end
-
-  def escape(value)
-    output = value.to_s
-    if output =~ /[\s"\\]/
-      '"' + output.gsub('\\', '\\\\\\').gsub('"', '\\"') + '"'
-    else
-      output
-    end
-  end
-
   def flatten_hash(hash, keys = nil, separator = "_")
     flat_hash = {}
     hash.each_pair do |key, val|
@@ -68,14 +34,23 @@ class StructuredEventLogger
   end
 
   def log_event(scope, event, hash)
-    unstructured_logger.add(nil, format_hash(scope, event, hash)) if unstructured_logger
-
-    hash = hash.merge(@default_context.merge(context)).merge(event_name: event, event_scope: scope, event_uuid: SecureRandom.uuid)
-    hash = { event_timestamp: Time.now.utc }.merge(hash)
-    json_io.write("#{MultiJson.encode(hash)}\n")
+    record = @default_context.merge(context)
+    record.update(event_name: event, event_scope: scope, event_uuid: SecureRandom.uuid, event_timestamp: Time.now.utc)
+    record.update(hash)
+
+    endpoints.each do |endpoint|
+      begin
+        endpoint.call(scope, event, hash, record)
+      rescue => e
+        $stderr.write("Failed to submit event #{scope}/#{event} to #{endpoint.inspect}: #{e.message}.\n")
+      end
+    end
   end
 
   def thread_key
     Thread.current
   end
 end
+
+require 'structured_event_logger/json_writer'
+require 'structured_event_logger/human_readable_logger'

data/lib/structured_event_logger/human_readable_logger.rb

@@ -0,0 +1,40 @@
+require 'active_support/log_subscriber'
+
+class StructuredEventLogger::HumanReadableLogger
+
+  CLEAR   = "\e[0m"
+  BOLD    = "\e[1m"
+
+  # Colors
+  MAGENTA = "\e[35m"
+  CYAN    = "\e[36m"
+  WHITE   = "\e[37m"
+   
+  attr_accessor :logger, :colorize, :log_level
+
+  def initialize(logger, colorize = ActiveSupport::LogSubscriber.colorize_logging, log_level = nil)
+    @logger, @colorize, @log_level = logger, colorize, log_level
+  end
+
+
+  def call(scope, event, hash, decorated_hash)
+    logger.add(log_level, format_hash(scope, event, hash))
+  end
+
+  private
+
+  def format_hash(scope, event, hash, separator = ', ')
+    @odd = !@odd
+    message = hash.map {|k, v| "#{k}=#{escape(v)}"}.join(separator)
+    if @colorize
+      "  #{@odd ? CYAN : MAGENTA}#{BOLD}[#{scope}] #{event}: #{WHITE}#{message}#{CLEAR}"
+    else
+      "  [#{scope}] #{event}: #{message}"
+    end
+  end
+
+  def escape(value)
+    output = value.to_s
+    output =~ /[\s"\\]/ ? output.inspect : output
+  end
+end

data/lib/structured_event_logger/json_writer.rb

@@ -0,0 +1,15 @@
+require 'multi_json'
+require 'active_support/json'
+
+class StructuredEventLogger::JsonWriter
+
+  attr_reader :io
+
+  def initialize(io)
+    @io = io
+  end
+
+  def call(scope, event, hash, record)
+    io.write(MultiJson.encode(record) + "\n")
+  end
+end

data/lib/structured_event_logger/version.rb

@@ -1,3 +1,3 @@
 class StructuredEventLogger
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/structured_event_logger_test.rb

@@ -4,22 +4,19 @@ require 'stringio'
 class StructuredEventLoggerTest < Minitest::Test
   def setup
     ActiveSupport::LogSubscriber.colorize_logging = false
-
-    @json_io = StringIO.new
+    
     @unstructured_logger = Logger.new(@nonstructured_io = StringIO.new)
     @unstructured_logger.formatter = proc { |_, _, _, msg| "#{msg}\n" }
-    @event_logger = StructuredEventLogger.new(@json_io, @unstructured_logger)
+    
+    @event_logger = StructuredEventLogger.new([
+      StructuredEventLogger::HumanReadableLogger.new(@unstructured_logger),
+      StructuredEventLogger::JsonWriter.new(@json_io = StringIO.new)
+    ])
     
     Time.stubs(:now).returns(Time.parse('2012-01-01T05:00:00Z'))
     SecureRandom.stubs(:uuid).returns('aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee')
   end
 
-  def test_should_log_msg_to_buffered_logger
-    @event_logger.log "a message"
-    assert_equal "a message\n", @nonstructured_io.string
-    assert @json_io.string.empty?
-  end
-
   def test_should_log_event_to_both_loggers
     @event_logger.event "render", "error", {:status => "status", :message => "message"}
 
@@ -37,14 +34,25 @@ class StructuredEventLoggerTest < Minitest::Test
     assert_last_event_contains_value '2012-01-01T05:00:00Z', :event_timestamp
   end
 
-  def test_overwriting_default_properties
+  def test_overwriting_default_properties_using_hash
     @event_logger.event :original, :original, :event_scope => 'overwritten', :event_name => 'overwritten',
             :event_timestamp => Time.parse('1912-01-01T04:00:00Z'), :event_uuid => 'overwritten'
 
+    assert_last_event_contains_value 'overwritten', :event_scope
+    assert_last_event_contains_value 'overwritten', :event_name
+    assert_last_event_contains_value 'overwritten', :event_uuid
+    assert_last_event_contains_value '1912-01-01T04:00:00Z', :event_timestamp
+  end
+
+  def test_overwriting_default_properties_using_context
+    @event_logger.default_context[:event_name] = 'overwritten'
+    Thread.new do
+      @event_logger.context[:event_scope] = 'overwritten'
+      @event_logger.event :original, :original
+    end.join
+
     assert_last_event_contains_value 'original', :event_scope
     assert_last_event_contains_value 'original', :event_name
-    assert_last_event_contains_value 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee', :event_uuid
-    assert_last_event_contains_value '1912-01-01T04:00:00Z', :event_timestamp
   end
 
   def test_should_log_flatten_hash

data/test/test_helper.rb

@@ -2,6 +2,7 @@ require 'bundler/setup'
 require 'minitest/autorun'
 require 'minitest/pride'
 require 'mocha/setup'
+require 'logger'
 
 $LOAD_PATH.unshift File.expand_path('../lib', File.dirname(__FILE__))
 require 'structured_event_logger'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: structured-event-logger
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-09 00:00:00.000000000 Z
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -125,6 +125,8 @@ files:
 - Rakefile
 - lib/structured-event-logger.rb
 - lib/structured_event_logger.rb
+- lib/structured_event_logger/human_readable_logger.rb
+- lib/structured_event_logger/json_writer.rb
 - lib/structured_event_logger/version.rb
 - structured-event-logger.gemspec
 - test/structured_event_logger_test.rb