123456789_123456789_123456789_123456789_123456789_

Class: Puma::CommonLogger

Relationships & Source Files
Inherits: Object
Defined in: lib/puma/commonlogger.rb

Overview

Rack::CommonLogger} forwards every request to the given app, and logs a line in the 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 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

Class Method Summary

Instance Method Summary

Constructor Details

.new(app, logger = nil) ⇒ CommonLogger

[ GitHub ]

  
# File 'lib/puma/commonlogger.rb', line 33

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

Instance Method Details

#call(env)

[ GitHub ]

  
# File 'lib/puma/commonlogger.rb', line 38

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

#extract_content_length(headers) (private)

[ GitHub ]

  
# File 'lib/puma/commonlogger.rb', line 103

def extract_content_length(headers)
  value = headers[CONTENT_LENGTH] or return '-'
  value.to_s == '0' ? '-' : value
end

#log(env, status, header, began_at) (private)

[ GitHub ]

  
# File 'lib/puma/commonlogger.rb', line 72

def log(env, status, header, began_at)
  now = Time.now
  length = extract_content_length(header)

  msg = FORMAT % [
    env['HTTP_X_FORWARDED_FOR'] || env["REMOTE_ADDR"] || "-",
    env["REMOTE_USER"] || "-",
    now.strftime("%d/%b/%Y:%H:%M:%S %z"),
    env[REQUEST_METHOD],
    env[PATH_INFO],
    env[QUERY_STRING].empty? ? "" : "?#{env[QUERY_STRING]}",
    env["HTTP_VERSION"],
    status.to_s[0..3],
    length,
    now - began_at ]

  write(msg)
end

#log_hijacking(env, status, header, began_at) (private)

[ GitHub ]

  
# File 'lib/puma/commonlogger.rb', line 56

def log_hijacking(env, status, header, began_at)
  now = Time.now

  msg = HIJACK_FORMAT % [
    env['HTTP_X_FORWARDED_FOR'] || env["REMOTE_ADDR"] || "-",
    env["REMOTE_USER"] || "-",
    now.strftime("%d/%b/%Y %H:%M:%S"),
    env[REQUEST_METHOD],
    env[PATH_INFO],
    env[QUERY_STRING].empty? ? "" : "?#{env[QUERY_STRING]}",
    env["HTTP_VERSION"],
    now - began_at ]

  write(msg)
end

#write(msg) (private)

[ GitHub ]

  
# File 'lib/puma/commonlogger.rb', line 91

def write(msg)
  logger = @logger || env['rack.errors']

  # Standard library logger doesn't support write but it supports << which actually
  # calls to write on the log device without formatting
  if logger.respond_to?(:write)
    logger.write(msg)
  else
    logger << msg
  end
end