lograge 0.0.3 → 0.0.4

data/README.md

@@ -7,6 +7,10 @@ default logging output. Rails' default approach to log everything is great
 during development, it's terrible when running it in production. It pretty much
 renders Rails logs useless to me.
 
+Lograge is a work in progress. I appreciate constructive feedback and criticism.
+My main goal is to improve Rails' logging and to show people that they don't
+need to stick with its defaults anymore if they don't want to.
+
 Instead of trying solving the problem of having multiple lines per request by
 switching Rails' logger for something that outputs syslog lines or adds a
 request token, Lograge replaces Rails' request logging entirely, reducing the
@@ -51,7 +55,23 @@ Enable it for the relevant environments, e.g. production:
 ```
 # config/environments/production.rb
 MyApp::Application.configure do
-  config.lograge.enabled = true 
+  config.lograge.enabled = true
+end
+```
+
+You can also add a hook for own custom data
+
+```
+# config/environments/staging.rb
+MyApp::Application.configure do
+  config.lograge.enabled = true
+
+  # custom_options can be a lambda or hash
+  # if it's a lambda then it must return a hash
+  config.lograge.custom_options = lambda do |event|
+    # capture some specific timing values you are interested in
+    {:name => "value", :name => "%2f" % float}
+  end
 end
 ```
 
@@ -79,16 +99,24 @@ While the LogSubscribers encapsulate most logging pretty nicely, there are still
 two lines that show up no matter what. The first line that's output for every
 Rails request, you know, this one:
 
+```
+Started GET "/" for 127.0.0.1 at 2012-03-12 17:10:10 +0100
+```
+
 And the verbose output coming from rack-cache:
 
+```
+cache: [GET /] miss
+```
+
 Both are independent of the LogSubscribers, and both need to be shut up using
 different means.
 
-For the first one, the starting line of every Rails request log, Lograge removes
-the `Rails::Rack::Logger` middleware from the stack. This may look like a drastic
-means, but all the middleware does is log that useless line, log exceptions, and
-create a request transaction id (Rails 3.2). A future version may replace with
-its own middleware, that simply removes the log line.
+For the first one, the starting line of every Rails request log, Lograge
+replaces code in `Rails::Rack::Logger` to remove that particular log line. It's
+not great, but it's just another unnecessary output and would still clutter the
+log files. Maybe a future version of Rails will make this log line an event as
+well.
 
 To remove rack-cache's output (which is only enabled if caching in Rails is
 enabled), Lograge disables verbosity for rack-cache, which is unfortunately
@@ -98,6 +126,9 @@ There, a single line per request. Beautiful.
 
 **What it doesn't do**
 
+Lograge is opinionated, very opinionated. If the stuff below doesn't suit your
+needs, it may not be for you.
+
 Lograge removes ActionView logging, which also includes rendering times for
 partials. If you're into those, Lograge is probably not for you. In my honest
 opinion, those rendering times don't belong in the log file, they should be
@@ -106,6 +137,15 @@ service that allows graphing rendering percentiles. I assume this for everything
 that represents a moving target. That kind of data is better off being
 visualized in graphs than dumped (and ignored) in a log file.
 
+Lograge doesn't yet log the request parameters. This is something I'm actively
+contemplating, mainly because I want to find a good way to include them, a way
+that fits in with the general spirit of the log output generated by Lograge.
+
+**Changes**
+
+* Add `custom_options` to allow adding custom key-value pairs at runtime (Adam
+  Cooper, https://github.com/adamcooper)
+
 **License**
 
 MIT. Code extracted from [Travis CI](http://travis-ci.org).

data/lib/lograge.rb

@@ -5,15 +5,32 @@ require 'active_support/core_ext/string/inflections'
 require 'active_support/ordered_options'
 
 module Lograge
-  mattr_accessor :logger  
+  mattr_accessor :logger
+
+  # Custom options that will be appended to log line
+  #
+  # Currently supported formats are:
+  #  - Hash
+  #  - Any object that responds to call and returns a hash
+  #
+  mattr_writer :custom_options
+  self.custom_options = nil
+
+  def self.custom_options(event)
+    if @@custom_options.respond_to?(:call)
+      @@custom_options.call(event)
+    else
+      @@custom_options
+    end
+  end
 
   def self.remove_existing_log_subscriptions
-    %w(redirect_to process_action start_processing send_data write_fragment exist_fragment? send_file).each do |event|
+    %w(redirect_to process_action start_processing send_data send_file write_fragment read_fragment exist_fragment? expire_fragment expire_page write_page).each do |event|
       unsubscribe_from_event(:action_controller, event)
     end
 
     %w{render_template render_partial render_collection}.each do |event|
-      unsubscribe_from_event(:action_view, event) 
+      unsubscribe_from_event(:action_view, event)
     end
   end
 
@@ -27,10 +44,11 @@ module Lograge
   end
 
   def self.setup(app)
-    app.config.action_dispatch.rack_cache[:verbose] = false
+    app.config.action_dispatch.rack_cache[:verbose] = false if app.config.action_dispatch.rack_cache
     require 'lograge/rails_ext/rack/logger'
     Lograge.remove_existing_log_subscriptions
     Lograge::RequestLogSubscriber.attach_to :action_controller
+    Lograge.custom_options = app.config.lograge.custom_options
   end
 end
 

data/lib/lograge/log_subscriber.rb

@@ -9,6 +9,7 @@ module Lograge
       message << extract_status(payload)
       message << runtimes(event)
       message << location(event)
+      message << custom_options(event)
       logger.info(message)
     end
 
@@ -27,6 +28,14 @@ module Lograge
       end
     end
 
+    def custom_options(event)
+      message = ""
+      (Lograge.custom_options(event) || {}).each do |name, value|
+        message << " #{name}=#{value}"
+      end
+      message
+    end
+
     def runtimes(event)
       message = ""
       {:duration => event.duration,
@@ -40,10 +49,10 @@ module Lograge
     def location(event)
       if location = Thread.current[:lograge_location]
         Thread.current[:lograge_location] = nil
-        "location=#{location}"
+        " location=#{location}"
       else
         ""
       end
-    end  
+    end
   end
 end

data/lib/lograge/version.rb

@@ -1,3 +1,3 @@
 module Lograge
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lograge.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Lograge::VERSION
   s.authors     = ["Mathias Meyer"]
   s.email       = ["meyer@paperplanes.de"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/mattmatt/lograge"
   s.summary     = %q{Tame Rails' multi-line logging into a single line per request}
   s.description = %q{Tame Rails' multi-line logging into a single line per request}
 

data/spec/lograge_logsubscriber_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'lograge'
 require 'lograge/log_subscriber'
 require 'active_support/notifications'
 require 'active_support/core_ext/string'
@@ -14,7 +15,7 @@ describe Lograge::RequestLogSubscriber do
     logger
   }
   before do
-    Lograge::RequestLogSubscriber.logger = logger    
+    Lograge::RequestLogSubscriber.logger = logger
   end
 
   let(:subscriber) {Lograge::RequestLogSubscriber.new}
@@ -44,7 +45,7 @@ describe Lograge::RequestLogSubscriber do
       subscriber.process_action(event)
       log_output.string.starts_with?('GET').should == true
     end
-    
+
     it "should include the status code" do
       subscriber.process_action(event)
       log_output.string.should include('status=200')
@@ -85,7 +86,7 @@ describe Lograge::RequestLogSubscriber do
 
       it "should add the location to the log line" do
         subscriber.process_action(event)
-        log_output.string.should =~ %r{location=http://www.example.com}
+        log_output.string.should =~ %r{ location=http://www.example.com}
       end
 
       it "should remove the thread local variable" do
@@ -93,13 +94,31 @@ describe Lograge::RequestLogSubscriber do
         Thread.current[:lograge_location].should == nil
       end
     end
-    
+
     it "should not include a location by default" do
       subscriber.process_action(event)
       log_output.string.should_not =~ /location=/
     end
   end
 
+  describe "with custom_options configured" do
+    it "should combine the hash properly for the output" do
+      Lograge.custom_options = {:data => "value"}
+      subscriber.process_action(event)
+      log_output.string.should =~ / data=value/
+    end
+    it "should combine the output of a lambda properly" do
+      Lograge.custom_options = lambda {|event| {:data => "value"}}
+      subscriber.process_action(event)
+      log_output.string.should =~ / data=value/
+    end
+    it "should work if the method returns nil" do
+      Lograge.custom_options = lambda {|event| nil}
+      subscriber.process_action(event)
+      log_output.string.should be_present
+    end
+  end
+
   describe "when processing a redirect" do
     it "should store the location in a thread local variable" do
       subscriber.redirect_to(redirect)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lograge
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-11 00:00:00.000000000 Z
+date: 2012-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70153872860480 !ruby/object:Gem::Requirement
+  requirement: &70345743126700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70153872860480
+  version_requirements: *70345743126700
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70153872859680 !ruby/object:Gem::Requirement
+  requirement: &70345743136340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70153872859680
+  version_requirements: *70345743136340
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70153872858340 !ruby/object:Gem::Requirement
+  requirement: &70345743177800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70153872858340
+  version_requirements: *70345743177800
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &70153872856860 !ruby/object:Gem::Requirement
+  requirement: &70345743191500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70153872856860
+  version_requirements: *70345743191500
 description: Tame Rails' multi-line logging into a single line per request
 email:
 - meyer@paperplanes.de
@@ -78,7 +78,7 @@ files:
 - spec/lograge_logsubscriber_spec.rb
 - spec/lograge_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/mattmatt/lograge
 licenses: []
 post_install_message: 
 rdoc_options: []