structured-event-logger 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+script: bundle exec rake
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - rbx-19mode
+  - jruby-19mode
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in structured-event-logger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Shopify Inc.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# StructuredEventLogger
+
+Structured event logger that writes events to both a human readable log and a JSON formatted log
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'structured-event-logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install structured-event-logger
+
+## Usage
+
+    # Creating an instance
+    json_logger = Logger.new('events.log')
+    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')
+
+    # Add context per thread/request (e.g. in an around_filter)
+    around_filter do
+      event_logger.add_context(my_value: 'whatever')
+      yield
+      event_logger.delete_context  
+    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
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+ 
+Rake::TestTask.new(:test) do |t|
+  t.test_files = Dir.glob('test/**/*_test.rb')
+  t.libs << 'test'
+end
+
+task :default => :test

data/lib/structured-event-logger.rb

@@ -0,0 +1 @@
+require 'structured_event_logger'

data/lib/structured_event_logger.rb

@@ -0,0 +1,63 @@
+require 'logger'
+require 'active_support/json'
+
+class StructuredEventLogger
+  
+  attr_reader :json_logger, :unstructured_logger
+
+  def initialize(json_logger, unstructured_logger = nil)
+    @json_logger, @unstructured_logger = json_logger, unstructured_logger
+    @thread_contexts = {}
+  end
+
+  def log(msg = nil)
+    unstructured_logger.add(nil, msg)
+  end
+
+  def event(scope, event, content = {})
+    log_event({:scope => scope, :event => event}.merge(flatten_hash(content)))
+  end
+
+  def context
+    @thread_contexts[thread_key] ||= {}
+  end
+
+  private
+
+  def format_hash(hash, separator = ', ')
+    "[Event Logger] " + hash.map {|k, v| "#{k}=#{escape(v)}"}.join(separator)
+  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|
+      conc_key = keys.nil? ? key : "#{keys}#{separator}#{key}"
+      if val.is_a?(Hash)
+        flat_hash.merge!(flatten_hash(val, conc_key))
+      else
+        flat_hash[conc_key] = val
+      end
+    end
+    flat_hash
+  end
+
+  def log_event(hash)
+    unstructured_logger.add(nil, format_hash(hash)) if unstructured_logger
+    hash = hash.merge(context)
+    hash[:timestamp] ||= Time.now.utc
+    json_logger.add(nil, ActiveSupport::JSON.encode(hash))
+  end
+
+  def thread_key
+    Thread.current
+  end
+end

data/lib/structured_event_logger/version.rb

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

data/structured-event-logger.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.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}
+  spec.homepage      = "https://github.com/Shopify/structured-event-logger"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", "~> 3.2"
+
+  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 "timecop"
+end

data/test/structured_event_logger_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+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)
+  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"
+  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')}\"}")
+
+      @event_logger.event "render", "error", {:status => "status", :message => "message"}
+    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')}\"}")
+      @event_logger.event "render", "error", {:status => "status", :message => {:first => "first", :second => "second"}}
+    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')}\"}")
+      
+      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
+      end.join
+    end
+  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)
+      
+      Thread.new do 
+        @event_logger.context[:request_id] = '1'
+        @event_logger.event :render, :error
+        @event_logger.context.clear
+      end.join
+
+      @event_logger.event :render, :error
+    end
+  end
+end
+

data/test/test_helper.rb

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

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: structured-event-logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Emilie Noel
+- Aaron Olson
+- Willem van Bergen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Structured event logging interface
+email:
+- willem@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/structured-event-logger.rb
+- lib/structured_event_logger.rb
+- lib/structured_event_logger/version.rb
+- structured-event-logger.gemspec
+- test/structured_event_logger_test.rb
+- test/test_helper.rb
+homepage: https://github.com/Shopify/structured-event-logger
+licenses:
+- MIT
+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
+signing_key: 
+specification_version: 3
+summary: Structured event logger that writes events to both a human readable log and
+  a JSON formatted log
+test_files:
+- test/structured_event_logger_test.rb
+- test/test_helper.rb