structured-event-logger 0.0.3 → 0.0.4

data/Rakefile

@@ -1,16 +1,5 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
-require 'rubygems/package_task'
-
-gemspec = eval(File.read('structured-event-logger.gemspec'))
-Gem::PackageTask.new(gemspec) do |pkg|
-  pkg.gem_spec = gemspec
-end
-
-desc "Build the gem and release it to rubygems.org"
-task :release => :gem do
-  sh "gem push pkg/structured-event-logger-#{gemspec.version}.gem"
-end
 
 Rake::TestTask.new(:test) do |t|
   t.test_files = Dir.glob('test/**/*_test.rb')

data/lib/structured_event_logger.rb

@@ -1,4 +1,5 @@
 require 'logger'
+require 'securerandom'
 require 'active_support/json'
 require 'active_support/log_subscriber'
 
@@ -69,8 +70,8 @@ class StructuredEventLogger
   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))
-    hash.update(event: event, scope: scope, timestamp: Time.now.utc)
+    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")
   end
 

data/lib/structured_event_logger/version.rb

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

data/structured-event-logger.gemspec

@@ -6,7 +6,7 @@ require 'structured_event_logger/version'
 Gem::Specification.new do |spec|
   spec.name          = "structured-event-logger"
   spec.version       = StructuredEventLogger::VERSION
-  spec.authors       = ["Emilie Noel", "Aaron Olson", "Willem van Bergen"]
+  spec.authors       = ["Emilie Noel", "Aaron Olson", "Willem van Bergen", "Florian Weingarten"]
   spec.email         = ["willem@shopify.com"]
   spec.description   = %q{Structured event logging interface}
   spec.summary       = %q{Structured event logger that writes events to both a human readable log and a JSON formatted log}
@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "mocha"
 end

data/test/structured_event_logger_test.rb

@@ -9,7 +9,9 @@ class StructuredEventLoggerTest < Minitest::Test
     @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-01T05:00:00Z')
+    
+    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
@@ -19,73 +21,100 @@ class StructuredEventLoggerTest < Minitest::Test
   end
 
   def test_should_log_event_to_both_loggers
-    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
+    @event_logger.event "render", "error", {:status => "status", :message => "message"}
+
+    assert_equal "  [render] error: status=status, message=message\n", @nonstructured_io.string
+    assert @json_io.string.end_with?("\n")
+    assert_kind_of Hash, JSON.parse(@json_io.string)
+  end
+
+  def test_default_json_properties
+    @event_logger.event :render, :error
+
+    assert_last_event_contains_value 'render', :event_scope
+    assert_last_event_contains_value 'error', :event_name
+    assert_last_event_contains_value 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee', :event_uuid
+    assert_last_event_contains_value '2012-01-01T05:00:00Z', :event_timestamp
+  end
+
+  def test_overwriting_default_properties
+    @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 '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
-    Timecop.travel(@time) do
-      @event_logger.event "render", "error", {:status => "status", :message => {:first => "first", :second => "second"}}
+    @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
+    assert_equal "  [render] error: status=status, message_first=first, message_second=second\n", @nonstructured_io.string
+    assert_last_event_contains_value 'first',  :message_first
+    assert_last_event_contains_value 'second', :message_second
+    assert_last_event_contains_value 'status', :status
   end
 
   def test_should_log_to_current_context
-    Timecop.travel(@time) do
-      Thread.new do 
-        @event_logger.context[:request_id] = '1'
+    Thread.new do 
+      @event_logger.context[:request_id] = '1'
 
-        Thread.new do 
-          @event_logger.context[:request_id] = '2'
-          @event_logger.event :render, :error
-        end.join
+      Thread.new do 
+        @event_logger.context[:request_id] = '2'
+        @event_logger.event :render, :error
       end.join
-    end
-
-    assert_equal "{\"request_id\":\"2\",\"event\":\"error\",\"scope\":\"render\",\"timestamp\":\"2012-01-01T05:00:00Z\"}\n", @json_io.string
-  end
+    end.join
 
-  def assert_event_contains_value(value, key)
-    @event_logger.event :some_scope, :some_event
-    assert_equal value, JSON.parse(@json_io.string)[key.to_s]
+    assert_last_event_contains_value '2', :request_id
   end
 
   def test_default_context_gets_merged
     @event_logger.default_context[:foo] = 42
-    assert_event_contains_value 42, :foo
+    @event_logger.event :some_scope, :some_event
+    assert_last_event_contains_value 42, :foo
   end
 
   def test_default_context_values_can_be_overriden
     @event_logger.default_context[:foo] = 42
     @event_logger.context[:foo] = 43
-    assert_event_contains_value 43, :foo
+    @event_logger.event :some_scope, :some_event
+    assert_last_event_contains_value 43, :foo
   end
 
   def test_default_context_gets_merged_again_after_clear
     @event_logger.default_context[:foo] = 42
     @event_logger.context.clear
-    assert_event_contains_value 42, :foo
+    @event_logger.event :some_scope, :some_event
+    assert_last_event_contains_value 42, :foo
   end
 
   def test_should_clear_context
-    Timecop.travel(@time) do
-      Thread.new do
-        @event_logger.context[:request_id] = '1'
-        @event_logger.event :render, :in_thread
-        @event_logger.context.clear
-      end.join
+    Thread.new do
+      @event_logger.context[:request_id] = '1'
+      @event_logger.event :render, :in_thread
+      @event_logger.context.clear
+    end.join
 
-      @event_logger.event :render, :out_thread
+    assert_last_event_contains_value '1', :request_id
 
-      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
+    @event_logger.event :render, :out_thread
+    log_lines = @json_io.string.lines.entries
+
+    assert_last_event_does_not_contain :request_id
   end
-end
 
+  private 
+
+  def assert_last_event_contains_value(value, key)
+    assert_equal value, last_parsed_event[key.to_s]
+  end
+
+  def assert_last_event_does_not_contain(key)
+    assert !last_parsed_event.has_key?(key.to_s)
+  end
+
+  def last_parsed_event
+    JSON.parse(@json_io.string.lines.entries[-1])
+  end
+end

data/test/test_helper.rb

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

metadata

@@ -1,20 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: structured-event-logger
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
+  prerelease: 
 platform: ruby
 authors:
 - Emilie Noel
 - Aaron Olson
 - Willem van Bergen
+- Florian Weingarten
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-08 00:00:00.000000000 Z
+date: 2013-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,6 +25,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -29,6 +33,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -36,6 +41,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -43,6 +49,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -50,6 +57,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -57,6 +65,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -64,6 +73,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -71,6 +81,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,13 +89,15 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -92,6 +105,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -118,26 +132,27 @@ files:
 homepage: https://github.com/Shopify/structured-event-logger
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Structured event logger that writes events to both a human readable log and
   a JSON formatted log
 test_files:

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZDcyNDFkNzJlNWFlYTc0NzUxNDE5YzNhMmE3MjgzNmRiOTUwYTlmYw==
-  data.tar.gz: !binary |-
-    YTE4MDdiMDZjNWJmOTAwODk2YTE5YWJiZTMwMjQ1YjA0N2I4NjQ1MA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    MTQwNmQzNGJmMjdjNTZiY2I3ZjYwMjA5NWY4ZGE0NjY0MTk3MWJjM2U1ZWI5
-    OGM2Mzc0MjA1NDdmOTE3NjFjYmJhN2ZmNjI4OGNlN2RjYjk3OTk0YmQ4NzU2
-    MWE0MmRmY2VhOTMzYjczYWYzMmZkMjE0NDhmMzdkYjNiMzc0ZDc=
-  data.tar.gz: !binary |-
-    NWZmMTMyMWU2NWVmZjBiMjJlOTNhODQ0NjVjMmQyM2ZiYmFhOWU2MjM0Mzhi
-    YzVlYWFhNDdkZmYxMGY3OTliNzZiNjMzM2VjMmQ0MDRkOTMxNmJlMzIwNGQw
-    OTQwOGZjNzU2NjA3MmY1NGM3MzlmNjIxMWYzYThlNjJjNWU0NmI=