lograge 0.2.2 → 0.3.0

data/.travis.yml

@@ -2,4 +2,5 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0
 script: bundle exec rspec

data/CHANGES.md

@@ -0,0 +1,11 @@
+### 0.3.0
+
+* #47: Add formatter for l2met (<https://github.com/BRMatt>)
+
+* #55: Update Logstash formatter for Logstash 1.2 format (<https://github.com/msaffitz>)
+
+* #56: Add JSON formatter (<https://github.com/i0rek>)
+
+* #59: Add `before_format` hook (<https://github.com/i0rek>)
+
+* #60: Add Ruby 2.1.0 for testing on Travis CI (<https://github.com/salimane>)

data/README.md

@@ -75,6 +75,19 @@ MyApp::Application.configure do
 end
 ```
 
+Or you can add a timestamp:
+
+```ruby
+MyApp::Application.configure do
+  config.lograge.enabled = true
+
+  # add time to lograge
+  config.lograge.custom_options = lambda do |event|
+    {:time => event.time}
+  end
+end
+```
+
 You can then add custom variables to the event to be used in custom_options
 
 ```ruby

data/lib/lograge/formatters/json.rb

@@ -0,0 +1,10 @@
+require 'json'
+module Lograge
+  module Formatters
+    class Json
+      def call(data)
+        ::JSON.dump(data)
+      end
+    end
+  end
+end

data/lib/lograge/formatters/key_value.rb

@@ -7,23 +7,32 @@ module Lograge
       ]
 
       def call(data)
-        fields  = LOGRAGE_FIELDS
-        fields += (data.keys - LOGRAGE_FIELDS)
+        fields = fields_to_display(data)
 
         event = fields.inject([]) do |message, key|
           next message unless data.has_key?(key)
-          # Exactly preserve the previous output
-          # Parsing this can be ambigious if the error messages contains
-          # a single quote
-          data[key] = "'#{data[key]}'" if key == :error
-          # Ensure that we always have exactly two decimals
-          data[key] = "%.2f" % data[key] if data[key].is_a? Float
 
-          message << "#{key}=#{data[key]}"
+          message << format(key, data[key])
           message
         end
         event.join(" ")
       end
+
+      def fields_to_display(data)
+        LOGRAGE_FIELDS + (data.keys - LOGRAGE_FIELDS)
+      end
+
+      def format(key, value)
+        # Exactly preserve the previous output
+        # Parsing this can be ambigious if the error messages contains
+        # a single quote
+        value = "'#{value}'" if key == :error
+
+        # Ensure that we always have exactly two decimals
+        value = "%.2f" % value if value.is_a? Float
+
+        "#{key}=#{value}"
+      end
     end
   end
-end
+end

data/lib/lograge/formatters/l2met.rb

@@ -0,0 +1,38 @@
+require 'lograge/formatters/key_value'
+
+module Lograge
+  module Formatters
+    class L2met < KeyValue
+      L2MET_FIELDS = [
+        :method, :path, :format, :source, :status, :error,
+        :duration, :view, :db, :location
+      ]
+
+      def call(data)
+        super(modify_payload(data))
+      end
+
+      def format(key, value)
+        key = "measure#page.#{key}" if value.kind_of?(Float)
+
+        super(key, value)
+      end
+
+      def fields_to_display(data)
+        L2MET_FIELDS + (data.keys - L2MET_FIELDS) - [:controller, :action]
+      end
+
+      def modify_payload(data)
+        if data[:controller] && data[:action]
+          data[:source] = source_field(data)
+        end
+
+        data
+      end
+
+      def source_field(data)
+        "#{data[:controller].to_s.gsub('/','-')}:#{data[:action]}"
+      end
+    end
+  end
+end

data/lib/lograge/formatters/logstash.rb

@@ -3,7 +3,8 @@ module Lograge
     class Logstash
       def call(data)
         load_dependencies
-        event = LogStash::Event.new("@fields" => data)
+        event = LogStash::Event.new(data)
+  
         event.message = "[#{data[:status]}] #{data[:method]} #{data[:path]} (#{data[:controller]}##{data[:action]})"
         event.to_json
       end
@@ -16,4 +17,4 @@ module Lograge
       end
     end
   end
-end
+end

data/lib/lograge/log_subscriber.rb

@@ -7,7 +7,7 @@ module Lograge
   class RequestLogSubscriber < ActiveSupport::LogSubscriber
     def process_action(event)
       return if Lograge.ignore?(event)
-      
+
       payload = event.payload
 
       data      = extract_request(payload)
@@ -16,6 +16,7 @@ module Lograge
       data.merge! location(event)
       data.merge! custom_options(event)
 
+      data = before_format(data, payload)
       formatted_message = Lograge.formatter.call(data)
       logger.send(Lograge.log_level, formatted_message)
     end
@@ -67,6 +68,10 @@ module Lograge
       Lograge.custom_options(event) || {}
     end
 
+    def before_format(data, payload)
+      Lograge.before_format(data, payload)
+    end
+
     def runtimes(event)
       {
         :duration => event.duration,

data/lib/lograge/version.rb

@@ -1,3 +1,3 @@
 module Lograge
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/lograge.rb

@@ -1,7 +1,9 @@
 require 'lograge/version'
 require 'lograge/formatters/cee'
+require 'lograge/formatters/json'
 require 'lograge/formatters/graylog2'
 require 'lograge/formatters/key_value'
+require 'lograge/formatters/l2met'
 require 'lograge/formatters/logstash'
 require 'lograge/formatters/raw'
 require 'lograge/log_subscriber'
@@ -30,6 +32,18 @@ module Lograge
     end
   end
 
+  # Before format allows you to change the structure of the output.
+  # You've to pass in something callable
+  #
+  mattr_writer :before_format
+  self.before_format = nil
+
+  def self.before_format(data, payload)
+    result = nil
+    result = @@before_format.call(data, payload) if @@before_format
+    result || data
+  end
+
   # Set conditions for events that should be ignored
   #
   # Currently supported formats are:
@@ -38,7 +52,7 @@ module Lograge
   #  - An object that responds to call with an event argument and returns
   #    true iff the event should be ignored.
   #
-  # The action ignores are given to 'ignore_actions'. The callable ignores 
+  # The action ignores are given to 'ignore_actions'. The callable ignores
   # are given to 'ignore'.  Both methods can be called multiple times, which
   # just adds more ignore conditions to a list that is checked before logging.
 
@@ -104,6 +118,7 @@ module Lograge
     Lograge.remove_existing_log_subscriptions
     Lograge::RequestLogSubscriber.attach_to :action_controller
     Lograge.custom_options = app.config.lograge.custom_options
+    Lograge.before_format = app.config.lograge.before_format
     Lograge.log_level = app.config.lograge.log_level || :info
     self.support_deprecated_config(app) # TODO: Remove with version 1.0
     Lograge.formatter = app.config.lograge.formatter || Lograge::Formatters::KeyValue.new

data/spec/formatters/json_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+require 'lograge'
+
+describe Lograge::Formatters::Json do
+  it { expect( subject.call({ custom: 'data' })).to eq('{"custom":"data"}') }
+end

data/spec/formatters/key_value_spec.rb

@@ -12,12 +12,11 @@ describe Lograge::Formatters::KeyValue do
       action: 'index'
     }
   end
+
   subject { described_class.new.call(payload) }
 
-  it { should include('method=GET') }
-  it { should include('path=/') }
   it { should include('controller=welcome') }
   it { should include('action=index') }
-  it { should include('status=200') }
-  it { should include('custom=data') }
-end
+
+  it_behaves_like "a key value formatter"
+end

data/spec/formatters/l2met_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'lograge'
+
+describe Lograge::Formatters::L2met do
+  let(:payload) do
+    {
+      custom: 'data',
+      status: 200,
+      method: 'GET',
+      path: '/',
+      controller: 'admin/welcome',
+      action: 'index',
+      db: 20.00,
+      view: 10.00, 
+      duration: 30.00,
+      cache: 40.00
+    }
+  end
+
+  it_behaves_like "a key value formatter"
+
+  subject { described_class.new.call(payload) }
+
+  it { should include('source=admin-welcome:index') }
+  it { should_not include('controller=admin/welcome') }
+  it { should_not include('action=index') }
+  it { should include('measure#page.duration=30.00') }
+  it { should include('measure#page.view=10.00') }
+  it { should include('measure#page.db=20.00') }
+  it { should include('measure#page.cache=40.00') }
+end

data/spec/formatters/logstash_spec.rb

@@ -13,13 +13,10 @@ describe Lograge::Formatters::Logstash do
     }
   end
   subject { described_class.new.call(payload) }
-  it { should match(/"@source":"unknown"/) }
-  it { should match(/"@tags":\[\]/) }
-  it { should match(/"@fields":{/) }
   it { should match(/"custom":"data"/) }
   it { should match(/"status":200/) }
   it { should match(/"method":"GET"/) }
   it { should match(/"path":"\/"/) }
   it { should match(/"controller":"welcome"/) }
   it { should match(/"action":"index"/) }
-end
+end

data/spec/lograge_logsubscriber_spec.rb

@@ -162,6 +162,27 @@ describe Lograge::RequestLogSubscriber do
     end
   end
 
+  describe "with before_format configured for lograge output" do
+    before do
+      Lograge.formatter = Lograge::Formatters::KeyValue.new
+      Lograge.before_format = nil
+    end
+
+    it "should output correctly" do
+      Lograge.before_format = lambda { |data, payload|
+        Hash[*data.first].merge(Hash[*payload.first])
+      }
+      subscriber.process_action(event)
+      log_output.string.should include("method=GET")
+      log_output.string.should include("status=200")
+    end
+    it "should work if the method returns nil" do
+      Lograge.before_format = lambda {|data, payload| nil}
+      subscriber.process_action(event)
+      log_output.string.should be_present
+    end
+  end
+
   describe "with ignore configured" do
     before do
       # Lograge::log_format = :lograge

data/spec/spec_helper.rb

@@ -5,6 +5,7 @@
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 require 'action_pack'
+require 'support/examples'
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true

data/spec/support/examples.rb

@@ -0,0 +1,20 @@
+
+shared_examples_for "a key value formatter" do
+  let(:payload) do
+    {
+      custom: 'data',
+      status: 200,
+      method: 'GET',
+      path: '/',
+      controller: 'welcome',
+      action: 'index'
+    }
+  end
+
+  subject { described_class.new.call(payload) }
+
+  it { should include('method=GET') }
+  it { should include('path=/') }
+  it { should include('status=200') }
+  it { should include('custom=data') }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lograge
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-17 00:00:00.000000000 Z
+date: 2014-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -101,6 +101,7 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGES.md
 - Gemfile
 - Guardfile
 - README.md
@@ -108,7 +109,9 @@ files:
 - lib/lograge.rb
 - lib/lograge/formatters/cee.rb
 - lib/lograge/formatters/graylog2.rb
+- lib/lograge/formatters/json.rb
 - lib/lograge/formatters/key_value.rb
+- lib/lograge/formatters/l2met.rb
 - lib/lograge/formatters/logstash.rb
 - lib/lograge/formatters/raw.rb
 - lib/lograge/log_subscriber.rb
@@ -118,12 +121,15 @@ files:
 - lograge.gemspec
 - spec/formatters/cee_spec.rb
 - spec/formatters/graylog2_spec.rb
+- spec/formatters/json_spec.rb
 - spec/formatters/key_value_spec.rb
+- spec/formatters/l2met_spec.rb
 - spec/formatters/logstash_spec.rb
 - spec/formatters/raw_spec.rb
 - spec/lograge_logsubscriber_spec.rb
 - spec/lograge_spec.rb
 - spec/spec_helper.rb
+- spec/support/examples.rb
 homepage: https://github.com/roidrage/lograge
 licenses: []
 post_install_message: 
@@ -151,10 +157,13 @@ summary: Tame Rails' multi-line logging into a single line per request
 test_files:
 - spec/formatters/cee_spec.rb
 - spec/formatters/graylog2_spec.rb
+- spec/formatters/json_spec.rb
 - spec/formatters/key_value_spec.rb
+- spec/formatters/l2met_spec.rb
 - spec/formatters/logstash_spec.rb
 - spec/formatters/raw_spec.rb
 - spec/lograge_logsubscriber_spec.rb
 - spec/lograge_spec.rb
 - spec/spec_helper.rb
+- spec/support/examples.rb
 has_rdoc: