lograge 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in lograge.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/README.md

@@ -0,0 +1,112 @@
+Lograge - Taming Rails' Default Request Logging
+=======
+
+Lograge is an attempt to bring sanity to Rails' noisy and unusable, unparsable
+and, in the context of running multiple processes and servers, unreadable
+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.
+
+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
+output per request to a single line with all the important information, removing
+all that clutter Rails likes to include and that gets mingled up so nicely when
+multiple processes dump their output into a single file.
+
+Instead of having an unparsable amount of logging output like this:
+
+```
+Started GET "/" for 127.0.0.1 at 2012-03-10 14:28:14 +0100
+Processing by HomeController#index as HTML
+  Rendered text template within layouts/application (0.0ms)
+  Rendered layouts/_assets.html.erb (2.0ms)
+  Rendered layouts/_top.html.erb (2.6ms)
+  Rendered layouts/_about.html.erb (0.3ms)
+  Rendered layouts/_google_analytics.html.erb (0.4ms)
+Completed 200 OK in 79ms (Views: 78.8ms | ActiveRecord: 0.0ms)
+```
+
+you get a single line with all the important information, like this:
+
+```
+GET /jobs/833552.json format=json action=jobs#show status=200 duration=58.33 view=40.43 db=15.26
+```
+
+The second line is easy to grasp with a single glance and still includes all the
+relevant information as simple key-value pairs. The syntax is heavily inspired
+by the log output of the Heroku router. It doesn't include any timestamp by
+default, instead it assumes you use a proper log formatter instead.
+
+**Installation**
+
+In your Gemfile
+
+```ruby
+gem "lograge"
+```
+
+Enable it for the relevant environments, e.g. production:
+
+```
+# config/environments/production.rb
+MyApp::Application.configure do
+  config.lograge.enabled = true 
+end
+```
+
+Done.
+
+**Internals**
+
+Thanks to the notification system that was introduced in Rails 3, replacing the
+logging is easy. Lograge unhooks all subscriptions from
+`ActionController::LogSubscriber` and `ActionView::LogSubscriber`, and hooks in
+its own log subscription, but only listening for two events: `process_action`
+and `redirect_to`. It makes sure that only subscriptions from those two classes
+are removed. If you happened to hook in your own, they'll be safe.
+
+Unfortunately, when a redirect is triggered by your application's code,
+ActionController fires two events. One for the redirect itself, and another one
+when the request is finished. Unfortunately the final event doesn't include the
+redirect, so Lograge stores the redirect URL as a thread-local attribute and
+refers to it in `process_action`.
+
+The event itself contains most of the relevant information to build up the log
+line, including view processing and database access times.
+
+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:
+
+And the verbose output coming from rack-cache:
+
+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.
+
+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
+enabled by default.
+
+There, a single line per request. Beautiful.
+
+**What it doesn't do**
+
+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
+collected in a system like New Relic, Librato Metrics or some other metrics
+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.
+
+**License**
+
+MIT. Code extracted from [Travis CI](http://travis-ci.org).
+(c) 2012 Mathias Meyer

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/lograge.rb

@@ -0,0 +1,37 @@
+require 'lograge/version'
+require 'lograge/log_subscriber'
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/ordered_options'
+
+module Lograge
+  mattr_accessor :logger  
+
+  def self.remove_existing_log_subscriptions
+    %w(redirect_to process_action start_processing send_data write_fragment exist_fragment? send_file).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) 
+    end
+  end
+
+  def self.unsubscribe_from_event(component, event)
+    delegate_type = component.to_s.classify
+    ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{component}").each do |listener|
+      if listener.inspect =~ /delegate[^a-z]+#{delegate_type}/
+        ActiveSupport::Notifications.unsubscribe listener
+      end
+    end
+  end
+
+  def self.setup(app)
+    app.config.action_dispatch.rack_cache[:verbose] = false
+    require 'lograge/rails_ext/rack/logger'
+    Lograge.remove_existing_log_subscriptions
+    Lograge::RequestLogSubscriber.attach_to :action_controller
+  end
+end
+
+require 'lograge/railtie' if defined?(Rails)

data/lib/lograge/log_subscriber.rb

@@ -0,0 +1,35 @@
+require 'active_support/core_ext/class/attribute'
+require 'active_support/log_subscriber'
+
+module Lograge
+  class RequestLogSubscriber < ActiveSupport::LogSubscriber
+    def process_action(event)
+      payload = event.payload
+      message = "#{payload[:method]} #{payload[:path]} format=#{payload[:format]} action=#{payload[:params]['controller']}##{payload[:params]['action']}"
+      message << extract_status(payload)
+      message << runtimes(event)
+      logger.info(message)
+    end
+
+    private
+
+    def extract_status(payload)
+      if payload[:status]
+        " status=#{payload[:status]}"
+      elsif payload[:exception]
+        exception, message = payload[:exception]
+        " status=500 error='#{exception}:#{message}'"
+      end
+    end
+
+    def runtimes(event)
+      message = ""
+      {:duration => event.duration,
+       :view => event.payload[:view_runtime],
+       :db => event.payload[:db_runtime]}.each do |name, runtime|
+        message << " #{name}=%.2f" % runtime if runtime
+      end
+      message
+    end
+  end
+end

data/lib/lograge/rails_ext/rack/logger.rb

@@ -0,0 +1,23 @@
+require 'rails/rack/logger'
+
+module Rails
+  module Rack
+    # Overwrites defaults of Rails::Rack::Logger that cause
+    # unnecessary logging.
+    # This effectively removes the log lines from the log
+    # that say:
+    # Started GET / for 192.168.2.1...
+    class Logger
+      # Overwrites Rails 3.2 code that logs new requests
+      def call_app(env)
+        @app.call(env)
+      ensure
+        ActiveSupport::LogSubscriber.flush_all!
+      end
+
+      # Overwrites Rails 3.0/3.1 code that logs new requests
+      def before_dispatch(env)
+      end
+    end
+  end
+end

data/lib/lograge/railtie.rb

@@ -0,0 +1,12 @@
+require 'rails/railtie'
+
+module Lograge
+  class Railtie < Rails::Railtie
+    config.lograge = ActiveSupport::OrderedOptions.new
+    config.lograge.enabled = false
+
+    initializer :lograge do |app|
+      Lograge.setup(app) if app.config.lograge.enabled
+    end
+  end
+end

data/lib/lograge/version.rb

@@ -0,0 +1,3 @@
+module Lograge
+  VERSION = "0.0.1"
+end

data/lograge.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "lograge/version"
+
+Gem::Specification.new do |s|
+  s.name        = "lograge"
+  s.version     = Lograge::VERSION
+  s.authors     = ["Mathias Meyer"]
+  s.email       = ["meyer@paperplanes.de"]
+  s.homepage    = ""
+  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}
+
+  s.rubyforge_project = "lograge"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "guard-rspec"
+  s.add_runtime_dependency "activesupport"
+  s.add_runtime_dependency "actionpack"
+end

data/spec/lograge_logsubscriber_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+require 'lograge/log_subscriber'
+require 'active_support/notifications'
+require 'active_support/core_ext/string'
+require 'logger'
+
+describe Lograge::RequestLogSubscriber do
+  let(:log_output) {StringIO.new}
+  let(:logger) {
+    logger = Logger.new(log_output)
+    logger.formatter = ->(_, _, _, msg) {
+      msg
+    }
+    logger
+  }
+  before do
+    Lograge::RequestLogSubscriber.logger = logger    
+  end
+
+  let(:subscriber) {Lograge::RequestLogSubscriber.new}
+  let(:event) {
+    ActiveSupport::Notifications::Event.new(
+      'process_action.action_controller', Time.now, Time.now, 2, {
+        status: 200, format: 'application/json', method: 'GET', path: '/home', params: {
+          'controller' => 'home', 'action' => 'index'
+        }, db_runtime: 0.02, view_runtime: 0.01
+      }
+    )
+  }
+
+  let(:redirect) {
+    ActiveSupport::Notifications::Event.new(
+      'redirect_to.action_controller', Time.now, Time.now, 1, location: 'http://example.com', status: 302
+    )
+  }
+
+  describe "when processing an action" do
+    it "should include the URL in the log output" do
+      subscriber.process_action(event)
+      log_output.string.should include('/home')
+    end
+
+    it "should start the log line with the HTTP method" 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')
+    end
+
+    it "should include the controller and action" do
+      subscriber.process_action(event)
+      log_output.string.should include('action=home#index')
+    end
+
+    it "should include the duration" do
+      subscriber.process_action(event)
+      log_output.string.should =~ /duration=[\.0-9]{4,4}/
+    end
+
+    it "should include the view rendering time" do
+      subscriber.process_action(event)
+      log_output.string.should =~ /view=0.01/
+    end
+
+    it "should include the database rendering time" do
+      subscriber.process_action(event)
+      log_output.string.should =~ /db=0.02/
+    end
+
+    it "should add a 500 status when an exception occurred" do
+      event.payload[:status] = nil
+      event.payload[:exception] = ['AbstractController::ActionNotFound', 'Route not found']
+      subscriber.process_action(event)
+      log_output.string.should =~ /status=500/
+      log_output.string.should =~ /error='AbstractController::ActionNotFound:Route not found'/
+    end
+  end
+end

data/spec/lograge_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'lograge'
+require 'active_support/notifications'
+require 'active_support/core_ext/string'
+require 'active_support/log_subscriber'
+require 'action_controller/log_subscriber'
+require 'action_view/log_subscriber'
+
+describe Lograge do
+  describe "when removing Rails' log subscribers" do
+    after do
+      ActionController::LogSubscriber.attach_to :action_controller
+      ActionView::LogSubscriber.attach_to :action_view
+    end
+
+    it "should remove subscribers for controller events" do
+      expect {
+        Lograge.remove_existing_log_subscriptions
+      }.to change {
+        ActiveSupport::Notifications.notifier.listeners_for('process_action.action_controller')
+      }
+    end
+
+    it "should remove subscribers for all events" do
+      expect {
+        Lograge.remove_existing_log_subscriptions
+      }.to change {
+        ActiveSupport::Notifications.notifier.listeners_for('render_template.action_view')
+      }
+    end
+
+    it "shouldn't remove subscribers that aren't from Rails" do
+      blk = -> {}
+      ActiveSupport::Notifications.subscribe("process_action.action_controller", &blk)
+      Lograge.remove_existing_log_subscriptions
+      listeners = ActiveSupport::Notifications.notifier.listeners_for('process_action.action_controller')
+      listeners.size.should > 0
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: lograge
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mathias Meyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70337094742500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70337094742500
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70337094741880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70337094741880
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70337094740860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70337094740860
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &70337094739040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70337094739040
+description: Tame Rails' multi-line logging into a single line per request
+email:
+- meyer@paperplanes.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- lib/lograge.rb
+- lib/lograge/log_subscriber.rb
+- lib/lograge/rails_ext/rack/logger.rb
+- lib/lograge/railtie.rb
+- lib/lograge/version.rb
+- lograge.gemspec
+- spec/lograge_logsubscriber_spec.rb
+- spec/lograge_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+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: lograge
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Tame Rails' multi-line logging into a single line per request
+test_files:
+- spec/lograge_logsubscriber_spec.rb
+- spec/lograge_spec.rb
+- spec/spec_helper.rb
+has_rdoc: