structured-event-logger 0.0.1 → 0.0.2

data/lib/structured_event_logger.rb

@@ -1,13 +1,22 @@
 require 'logger'
 require 'active_support/json'
+require 'active_support/log_subscriber'
 
 class StructuredEventLogger
-  
-  attr_reader :json_logger, :unstructured_logger
+  CLEAR   = "\e[0m"
+  BOLD    = "\e[1m"
 
-  def initialize(json_logger, unstructured_logger = nil)
-    @json_logger, @unstructured_logger = json_logger, unstructured_logger
+  # Colors
+  MAGENTA = "\e[35m"
+  CYAN    = "\e[36m"
+  WHITE   = "\e[37m"
+
+  attr_reader :json_io, :unstructured_logger, :colorize_logging
+
+  def initialize(json_io, unstructured_logger = nil)
+    @json_io, @unstructured_logger = json_io, unstructured_logger
     @thread_contexts = {}
+    @colorize_logging = ActiveSupport::LogSubscriber.colorize_logging
   end
 
   def log(msg = nil)
@@ -15,7 +24,7 @@ class StructuredEventLogger
   end
 
   def event(scope, event, content = {})
-    log_event({:scope => scope, :event => event}.merge(flatten_hash(content)))
+    log_event scope, event, flatten_hash(content)
   end
 
   def context
@@ -24,8 +33,14 @@ class StructuredEventLogger
 
   private
 
-  def format_hash(hash, separator = ', ')
-    "[Event Logger] " + hash.map {|k, v| "#{k}=#{escape(v)}"}.join(separator)
+  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)
@@ -50,11 +65,12 @@ class StructuredEventLogger
     flat_hash
   end
 
-  def log_event(hash)
-    unstructured_logger.add(nil, format_hash(hash)) if unstructured_logger
+  def log_event(scope, event, hash)
+    unstructured_logger.add(nil, format_hash(scope, event, hash)) if unstructured_logger
+
     hash = hash.merge(context)
-    hash[:timestamp] ||= Time.now.utc
-    json_logger.add(nil, ActiveSupport::JSON.encode(hash))
+    hash.update(event: event, scope: scope, timestamp: Time.now.utc)
+    json_io.write("#{MultiJson.encode(hash)}\n")
   end
 
   def thread_key

data/lib/structured_event_logger/version.rb

@@ -1,3 +1,3 @@
 class StructuredEventLogger
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/structured-event-logger.gemspec

@@ -19,10 +19,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "activesupport", "~> 3.2"
+  spec.add_runtime_dependency "multi_json"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "timecop"
 end

data/test/structured_event_logger_test.rb

@@ -3,39 +3,40 @@ require 'stringio'
 
 class StructuredEventLoggerTest < Minitest::Test
   def setup
-    @json_logger     = Logger.new(StringIO.new)
-    @buffered_logger = Logger.new(StringIO.new)
-    @event_logger    = StructuredEventLogger.new(@json_logger, @buffered_logger)
+    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)
+    @time = Time.parse('2012-01-01')
   end
 
   def test_should_log_msg_to_buffered_logger
-    @buffered_logger.expects(:add).with(nil, "a message")
-    @json_logger.expects(:add).never
-
     @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
-    Timecop.freeze(Time.now) do
-      @buffered_logger.expects(:add).with(nil, "[Event Logger] scope=render, event=error, status=status, message=message")
-      @json_logger.expects(:add).with(nil, "{\"scope\":\"render\",\"event\":\"error\",\"status\":\"status\",\"message\":\"message\",\"timestamp\":\"#{Time.now.utc.strftime('%FT%TZ')}\"}")
-
+    Timecop.travel(@time) do
       @event_logger.event "render", "error", {:status => "status", :message => "message"}
+      assert_equal "{\"status\":\"status\",\"message\":\"message\",\"event\":\"error\",\"scope\":\"render\",\"timestamp\":\"2012-01-01T05:00:00Z\"}\n", @json_io.string
+      assert_equal "  [render] error: status=status, message=message\n", @nonstructured_io.string
     end
   end
 
   def test_should_log_flatten_hash
-    Timecop.travel(Time.now) do
-      @buffered_logger.expects(:add).with(nil, "[Event Logger] scope=render, event=error, status=status, message_first=first, message_second=second")
-      @json_logger.expects(:add).with(nil, "{\"scope\":\"render\",\"event\":\"error\",\"status\":\"status\",\"message_first\":\"first\",\"message_second\":\"second\",\"timestamp\":\"#{Time.now.utc.strftime('%FT%TZ')}\"}")
+    Timecop.travel(@time) do
       @event_logger.event "render", "error", {:status => "status", :message => {:first => "first", :second => "second"}}
+
+      assert_equal "{\"status\":\"status\",\"message_first\":\"first\",\"message_second\":\"second\",\"event\":\"error\",\"scope\":\"render\",\"timestamp\":\"2012-01-01T05:00:00Z\"}\n", @json_io.string
+      assert_equal "  [render] error: status=status, message_first=first, message_second=second\n", @nonstructured_io.string      
     end
   end
 
   def test_should_log_to_current_context
-    Timecop.freeze(Time.now) do
-      @json_logger.expects(:add).with(nil, "{\"scope\":\"render\",\"event\":\"error\",\"request_id\":\"2\",\"timestamp\":\"#{Time.now.utc.strftime('%FT%TZ')}\"}")
-      
+    Timecop.travel(@time) do
       Thread.new do 
         @event_logger.context[:request_id] = '1'
 
@@ -45,22 +46,24 @@ class StructuredEventLoggerTest < Minitest::Test
         end.join
       end.join
     end
+
+    assert_equal "{\"request_id\":\"2\",\"event\":\"error\",\"scope\":\"render\",\"timestamp\":\"2012-01-01T05:00:00Z\"}\n", @json_io.string
   end
 
-  def test_should_delete_context
-    
-    Timecop.freeze(Time.now) do
-      order = sequence('log message order')
-      @json_logger.expects(:add).with(nil, "{\"scope\":\"render\",\"event\":\"error\",\"request_id\":\"1\",\"timestamp\":\"#{Time.now.utc.strftime('%FT%TZ')}\"}").in_sequence(order)
-      @json_logger.expects(:add).with(nil, "{\"scope\":\"render\",\"event\":\"error\",\"timestamp\":\"#{Time.now.utc.strftime('%FT%TZ')}\"}").in_sequence(order)
+  def test_should_clear_context    
+    Timecop.travel(@time) do
       
       Thread.new do 
         @event_logger.context[:request_id] = '1'
-        @event_logger.event :render, :error
+        @event_logger.event :render, :in_thread
         @event_logger.context.clear
       end.join
 
-      @event_logger.event :render, :error
+      @event_logger.event :render, :out_thread
+
+      log_lines = @json_io.string.lines.entries
+      assert_equal "{\"request_id\":\"1\",\"event\":\"in_thread\",\"scope\":\"render\",\"timestamp\":\"2012-01-01T05:00:00Z\"}\n", log_lines[0]
+      assert_equal "{\"event\":\"out_thread\",\"scope\":\"render\",\"timestamp\":\"2012-01-01T05:00:00Z\"}\n", log_lines[1]
     end
   end
 end

data/test/test_helper.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: structured-event-logger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -30,39 +30,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -78,21 +78,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement