structured-event-logger 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!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=

data/README.md

@@ -19,23 +19,23 @@ Or install it yourself as:
 ## Usage
 
     # Creating an instance
-    json_logger = Logger.new('events.log')
+    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)
 
     # Basic usage
-    event_logger.event('scope', event, field: 'value', other_field, 'other value')
+    event_logger.event('scope', event, field: 'value', other_field: 'other value')
 
     # Add context per thread/request (e.g. in an around_filter)
     around_filter do
-      event_logger.add_context(my_value: 'whatever')
+      event_logger.context[:my_value] = 'whatever'
       yield
-      event_logger.delete_context  
+      event_logger.context.delete(:my_value)
     end
-    
+
     # later, while processing a request inside that filter
     event_logger.event('scope', 'event', other_value: 'blah') # will also include { my_value: 'whatever' }
-  
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,6 +1,17 @@
 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')
   t.libs << 'test'

data/lib/structured_event_logger.rb

@@ -11,11 +11,12 @@ class StructuredEventLogger
   CYAN    = "\e[36m"
   WHITE   = "\e[37m"
 
-  attr_reader :json_io, :unstructured_logger, :colorize_logging
+  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
 
@@ -68,7 +69,7 @@ class StructuredEventLogger
   def log_event(scope, event, hash)
     unstructured_logger.add(nil, format_hash(scope, event, hash)) if unstructured_logger
 
-    hash = hash.merge(context)
+    hash = hash.merge(@default_context.merge(context))
     hash.update(event: event, scope: scope, timestamp: Time.now.utc)
     json_io.write("#{MultiJson.encode(hash)}\n")
   end

data/lib/structured_event_logger/version.rb

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

data/test/structured_event_logger_test.rb

@@ -9,7 +9,7 @@ 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-01')
+    @time = Time.parse('2012-01-01T05:00:00Z')
   end
 
   def test_should_log_msg_to_buffered_logger
@@ -50,10 +50,31 @@ class StructuredEventLoggerTest < Minitest::Test
     assert_equal "{\"request_id\":\"2\",\"event\":\"error\",\"scope\":\"render\",\"timestamp\":\"2012-01-01T05:00:00Z\"}\n", @json_io.string
   end
 
-  def test_should_clear_context    
+  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]
+  end
+
+  def test_default_context_gets_merged
+    @event_logger.default_context[:foo] = 42
+    assert_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
+  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
+  end
+
+  def test_should_clear_context
     Timecop.travel(@time) do
-      
-      Thread.new do 
+      Thread.new do
         @event_logger.context[:request_id] = '1'
         @event_logger.event :render, :in_thread
         @event_logger.context.clear

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: structured-event-logger
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Emilie Noel
@@ -11,12 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2013-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -24,7 +22,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -32,7 +29,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -40,7 +36,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -48,7 +43,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -56,7 +50,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -64,7 +57,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -72,7 +64,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -80,7 +71,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -88,7 +78,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -96,7 +85,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -104,7 +92,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -131,27 +118,26 @@ 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: 1.8.23
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Structured event logger that writes events to both a human readable log and
   a JSON formatted log
 test_files: