Rails 4 silenceable logger

README.md

Rails 4 Silenceable Logger

For when you really, really don't want to log a request.

I'm using this logger to skip logging requests for CarrierWave-uploaded images in development. Loading database dumps from other environments means that the images simply aren't there in development. Rather than deal with an ActiveSupport::RoutingError and a huge 20 line backtrace per missing image, I'm just suppressing all output using this logger and a catchall route that's only active in development.

Usage

Add lib/silenceable_logger.rb to your Rails app, and adapt config/development.rb and config/routes.rb as needed.

application_controller.rb

# app/controllers/application_controller.rb

class ApplicationController < ActionController::Base

  def not_found
    head status: 404
  end

end

development.rb

# config/development.rb

require "silenceable_logger"

Rails.application.configure do |config|

  config.middleware.swap Rails::Rack::Logger, SilenceableLogger,
    config.log_tags, silenced: [%r{^/uploads/}]

end

routes.rb

# config/routes.rb

Rails.application.routes.draw do

  if Rails.env.development?
    # match via: :all will catch any HTTP verb
    match '/uploads/*missing', via: :all, to: 'application#not_found'
  end

end

silenceable_logger.rb

# lib/silenceable_logger.rb

class SilenceableLogger < Rails::Rack::Logger
  def initialize(app, taggers = nil, opts = {})
    @app  = app
    @opts = opts
    @opts[:silenced] ||= []
    super(app, taggers)
  end

  def call(env)
    if env['X-SILENCE-LOGGER'] || @opts[:silenced].any?{ |path| path === env['PATH_INFO'] }
      Rails.logger.silence do
        @app.call(env)
      end
    else
      super(env)
    end
  end
end