123456789_123456789_123456789_123456789_123456789_

Class: Rails::Rack::Logger

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
Instance Chain:
Inherits: ActiveSupport::LogSubscriber
Defined in: railties/lib/rails/rack/logger.rb

Overview

Sets log tags, logs the request, calls the app, and flushes the logs.

Log tags (taggers) can be an ::Array containing: methods that the request object responds to, objects that respond to to_s or Proc objects that accept an instance of the request object.

Constant Summary

::ActiveSupport::LogSubscriber - Inherited

BLACK, BLUE, CYAN, GREEN, LEVEL_CHECKS, MAGENTA, MODES, RED, WHITE, YELLOW

Class Attribute Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

::ActiveSupport::LogSubscriber - Inherited

#call, #logger, #publish_event, #silenced?,
#color

Set color by using a symbol or one of the defined constants.

#log_exception, #mode_from

::ActiveSupport::Subscriber - Inherited

Constructor Details

.new(app, taggers = nil) ⇒ Logger

[ GitHub ]

  
# File 'railties/lib/rails/rack/logger.rb', line 15

def initialize(app, taggers = nil)
  @app          = app
  @taggers      = taggers || []
end

Instance Method Details

#call(env)

[ GitHub ]

  
# File 'railties/lib/rails/rack/logger.rb', line 20

def call(env)
  request = ActionDispatch::Request.new(env)

  env["rails.rack_logger_tag_count"] = if logger.respond_to?(:push_tags)
    logger.push_tags(*compute_tags(request)).size
  else
    0
  end

  call_app(request, env)
end

#call_app(request, env) (private)

[ GitHub ]

  
# File 'railties/lib/rails/rack/logger.rb', line 33

def call_app(request, env) # :doc:
  logger_tag_pop_count = env["rails.rack_logger_tag_count"]

  instrumenter = ActiveSupport::Notifications.instrumenter
  handle = instrumenter.build_handle("request.action_dispatch", { request: request })
  handle.start

  logger.info { started_request_message(request) }
  status, headers, body = response = @app.call(env)
  body = ::Rack::BodyProxy.new(body) { finish_request_instrumentation(handle, logger_tag_pop_count) }

  if response.frozen?
    [status, headers, body]
  else
    response[2] = body
    response
  end
rescue Exception
  finish_request_instrumentation(handle, logger_tag_pop_count)
  raise
end

#compute_tags(request) (private)

[ GitHub ]

  
# File 'railties/lib/rails/rack/logger.rb', line 64

def compute_tags(request) # :doc:
  @taggers.collect do |tag|
    case tag
    when Proc
      tag.call(request)
    when Symbol
      request.send(tag)
    else
      tag
    end
  end
end

#finish_request_instrumentation(handle, logger_tag_pop_count) (private)

[ GitHub ]

  
# File 'railties/lib/rails/rack/logger.rb', line 81

def finish_request_instrumentation(handle, logger_tag_pop_count)
  handle.finish
  logger.pop_tags(logger_tag_pop_count) if logger.respond_to?(:pop_tags) && logger_tag_pop_count > 0
  ActiveSupport::LogSubscriber.flush_all!
end

#logger (private)

[ GitHub ]

  
# File 'railties/lib/rails/rack/logger.rb', line 77

def logger
  Rails.logger
end

#started_request_message(request) (private)

Started GET “/session/new” for 127.0.0.1 at 2012-09-26 14:51:42 -0700

[ GitHub ]

  
# File 'railties/lib/rails/rack/logger.rb', line 56

def started_request_message(request) # :doc:
  sprintf('Started %s "%s" for %s at %s',
    request.raw_request_method,
    request.filtered_path,
    request.remote_ip,
    Time.now)
end