json_logger 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+json_logger

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p194

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.4"
+end

data/Gemfile.lock

@@ -0,0 +1,63 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    diff-lcs (1.1.3)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    jeweler (1.8.7)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.7.9)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Alex Dean
+
+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,85 @@
+## JSON Logger
+
+Simple structured logging.
+
+A subclass of Ruby's standard `Logger` which makes it easy to write structured
+data to your log files.
+
+## Basic Usage
+
+```ruby
+instance = JsonLogger.factory(
+  :device => '/tmp/test.log', # anything understood by Logger.new
+  :level => Logger::INFO,
+  :progname => 'foo'
+)
+instance.info('a simple message')
+instance.error(:key => 'value', :other => [1,2,3])
+```
+
+Output in `/tmp/test.log`:
+```json
+{
+  "time":"2013-08-28T20:54:42.048Z",
+  "progname":"foo",
+  "level":"INFO",
+  "level_id":1,
+  "msg":"a simple message"
+}
+{
+  "time":"2013-08-28T20:52:48.321Z",
+  "progname":"foo",
+  "level":"ERROR",
+  "level_id":3,
+  "data":"data",
+  "other":[1,2,3]
+}
+```
+
+Messages are actually written 1 per line (separated by a newline). I added the
+extra newlines here for readability.
+
+## Factory Defaults
+
+You can set some defaults which will be added to every `factory` call. This
+works well from a Rails initializer, for example.
+
+Subsequent calls to `factory` will always include these defaults, though they
+can be overridden if desired.
+
+```ruby
+JsonLogger.factory_defaults = {
+  :device => '/tmp/test.log',
+  :level => Logger::INFO
+}
+instance = JsonLogger.factory(:progname => 'foo')
+instance.info 'a simple message'
+```
+
+## Presets
+
+A `factory` call can include preset values which will be added to any log
+messages created by the returned instance.
+
+```ruby
+instance = JsonLogger.factory(:progname => 'foo', :presets => {:a => 'b', :c => 'd'})
+instance.error('hello')
+```
+
+Output:
+```json
+{
+  "time":"2013-08-28T20:52:48.321Z",
+  "progname":"foo",
+  "level":"ERROR",
+  "level_id":3,
+  "a":"b",
+  "c":"d",
+  "msg":"hello",
+}
+```
+
+## Copyright
+
+Copyright (c) 2013 Alex Dean. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "json_logger"
+  gem.homepage = "http://github.com/alexdean/json_logger"
+  gem.license = "MIT"
+  gem.summary = %Q{Simple structured logging.}
+  gem.description = %Q{A subclass of Ruby's standard `Logger` which makes it easy to write structured data to your log files.}
+  gem.email = "alex@crackpot.org"
+  gem.authors = ["Alex Dean"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "json_logger #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/json_logger.rb

@@ -0,0 +1,56 @@
+require 'logger'
+require 'time'
+require 'json'
+
+class JsonLogger < Logger
+
+  @@factory_defaults = {}
+  def self.factory_defaults=(options)
+    @@factory_defaults = options
+  end
+
+  # return a new JsonLogger
+  #   - file is set in settings
+  #   - progname and level can be set by options. (default level is in settings)
+  def self.factory(options={})
+    device = options[:device] || @@factory_defaults[:device]
+    inst = new(device)
+
+    inst.level = options[:level] || @@factory_defaults[:level] || Logger::WARN
+    inst.progname = options[:progname] || @@factory_defaults[:progname]
+    inst.presets = options[:presets]
+    inst
+  end
+
+  attr_accessor :presets
+
+  def initialize(*args)
+    super
+
+    self.formatter = proc { |severity, datetime, progname, raw|
+      out = {
+        'time' => datetime.utc.iso8601(3),
+        'level' => severity,
+        'level_id' => @levels[severity]
+      }
+
+      if self.presets
+        out.merge!(self.presets)
+      end
+
+      if raw.respond_to?(:to_hash)
+        #TODO: raise error if raw has a key which overrides time, level, or level_id?
+        out.merge!(raw.to_hash)
+      elsif raw.respond_to?(:to_s)
+        out['msg'] = raw.to_s
+      end
+
+      out['progname'] = progname if progname
+
+      out.to_json + "\n"
+    }
+
+    @levels = {}
+    Logger::SEV_LABEL.each_with_index {|label,idx| @levels[label] = idx}
+  end
+end

data/spec/json_logger_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "JsonLogger" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'json_logger'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: json_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Alex Dean
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: A subclass of Ruby's standard `Logger` which makes it easy to write structured
+  data to your log files.
+email: alex@crackpot.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/json_logger.rb
+- spec/json_logger_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/alexdean/json_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'
+      segments:
+      - 0
+      hash: -2689223519216697720
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple structured logging.
+test_files: []