Class: Rack::CommonLogger

Inherits:
Object
  • Object
show all
Defined in:
lib/rack/common_logger.rb

Overview

Rack::CommonLogger forwards every request to the given app, and logs a line in the Apache common log format to the configured logger.

Constant Summary collapse

FORMAT =

Common Log Format: httpd.apache.org/docs/1.3/logs.html#common

lilith.local - - [07/Aug/2006 23:58:02 -0400] "GET / HTTP/1.1" 500 -

%{%s - %s [%s] "%s %s%s %s" %d %s\n} %

The actual format is slightly different than the above due to the separation of SCRIPT_NAME and PATH_INFO, and because the elapsed time in seconds is included at the end.

%{%s - %s [%s] "%s %s%s%s %s" %d %s %0.4f\n}

Instance Method Summary collapse

Constructor Details

#initialize(app, logger = nil) ⇒ CommonLogger

logger can be any object that supports the write or << methods, which includes the standard library Logger. These methods are called with a single string argument, the log message. If logger is nil, CommonLogger will fall back env['rack.errors'].


24
25
26
27
# File 'lib/rack/common_logger.rb', line 24

def initialize(app, logger = nil)
  @app = app
  @logger = logger
end

Instance Method Details

#call(env) ⇒ Object

Log all requests in common_log format after a response has been returned. Note that if the app raises an exception, the request will not be logged, so if exception handling middleware are used, they should be loaded after this middleware. Additionally, because the logging happens after the request body has been fully sent, any exceptions raised during the sending of the response body will cause the request not to be logged.


36
37
38
39
40
41
42
# File 'lib/rack/common_logger.rb', line 36

def call(env)
  began_at = Utils.clock_time
  status, headers, body = @app.call(env)
  headers = Utils::HeaderHash[headers]
  body = BodyProxy.new(body) { log(env, status, headers, began_at) }
  [status, headers, body]
end