Class: Puma::CommonLogger

Inherits:
Object
  • Object
show all
Defined in:
lib/puma/commonlogger.rb

Overview

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

If logger is nil, CommonLogger will fall back rack.errors, which is an instance of Rack::NullLogger.

logger can be any class, including the standard library Logger, and is expected to have either write or << method, which accepts the CommonLogger::FORMAT. According to the SPEC, the error stream must also respond to puts (which takes a single argument that responds to to_s), and flush (which is called without arguments in order to make the error appear for sure)

Constant Summary collapse

FORMAT =

Common Log Format: httpd.apache.org/docs/2.4/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} %

%{%s - %s [%s] "%s %s%s %s" %d %s %0.4f\n}
HIJACK_FORMAT = 
%{%s - %s [%s] "%s %s%s %s" HIJACKED -1 %0.4f\n}
LOG_TIME_FORMAT = 
'%d/%b/%Y:%H:%M:%S %z'
CONTENT_LENGTH = 
'Content-Length'
HTTP_VERSION =

should be lower case from app, Util::HeaderHash allows mixed

Const::HTTP_VERSION
HTTP_X_FORWARDED_FOR = 
Const::HTTP_X_FORWARDED_FOR
PATH_INFO = 
Const::PATH_INFO
QUERY_STRING = 
Const::QUERY_STRING
REMOTE_ADDR = 
Const::REMOTE_ADDR
REMOTE_USER = 
'REMOTE_USER'
REQUEST_METHOD = 
Const::REQUEST_METHOD

Instance Method Summary collapse

Constructor Details

#initialize(app, logger = nil) ⇒ CommonLogger

Returns a new instance of CommonLogger.



40
41
42
43
 
# File 'lib/puma/commonlogger.rb', line 40

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

Instance Method Details

#call(env) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/puma/commonlogger.rb', line 45

def call(env)
  began_at = Time.now
  status, header, body = @app.call(env)
  header = Util::HeaderHash.new(header)

  # If we've been hijacked, then output a special line
  if env['rack.hijack_io']
    log_hijacking(env, 'HIJACK', header, began_at)
  else
    ary = env['rack.after_reply']
    ary << lambda { log(env, status, header, began_at) }
  end

  [status, header, body]
end