class Grape::Middleware::Logger
Constants
- BACKSLASH
Attributes
condensed[RW]
filter[RW]
headers[RW]
logger[RW]
logger[R]
Public Class Methods
default_logger()
click to toggle source
# File lib/grape/middleware/logger.rb, line 12 def default_logger default = Logger.new(STDOUT) default.formatter = ->(*args) { args.last.to_s << "\n".freeze } default end
new(_, options = {})
click to toggle source
Calls superclass method
# File lib/grape/middleware/logger.rb, line 19 def initialize(_, options = {}) super @options[:filter] ||= self.class.filter @options[:headers] ||= self.class.headers @options[:condensed] ||= false @logger = options[:logger] || self.class.logger || self.class.default_logger end
Public Instance Methods
after(status)
click to toggle source
# File lib/grape/middleware/logger.rb, line 71 def after(status) log_info( [ "Completed #{status} in #{((Time.now - start_time) * 1000).round(2)}ms", '' ] ) end
after_exception(e)
click to toggle source
Helpers
# File lib/grape/middleware/logger.rb, line 84 def after_exception(e) logger.info %Q( #{e.class.name}: #{e.message}) after(500) end
after_failure(error)
click to toggle source
# File lib/grape/middleware/logger.rb, line 89 def after_failure(error) logger.info %Q( Error: #{error[:message]}) if error[:message] after(error[:status]) end
before()
click to toggle source
Calls superclass method
# File lib/grape/middleware/logger.rb, line 27 def before start_time # sets env['grape.*'] super log_statements = [ '', %Q(Started %s "%s" at %s) % [ env[Grape::Env::GRAPE_REQUEST].request_method, env[Grape::Env::GRAPE_REQUEST].path, start_time.to_s ], %Q(Processing by #{processed_by}), %Q( Parameters: #{parameters})] log_statements.append(%Q( Headers: #{headers})) if @options[:headers] log_info(log_statements) end
call!(env)
click to toggle source
@note Error and exception handling are required for the after
hooks
Exceptions are logged as a 500 status and re-raised Other "errors" are caught, logged and re-thrown
# File lib/grape/middleware/logger.rb, line 49 def call!(env) @env = env before error = catch(:error) do begin @app_response = @app.call(@env) rescue => e after_exception(e) raise e end nil end if error after_failure(error) throw(:error, error) else status, _, _ = *@app_response after(status) end @app_response end
headers()
click to toggle source
# File lib/grape/middleware/logger.rb, line 105 def headers request_headers = env[Grape::Env::GRAPE_REQUEST_HEADERS].to_hash return Hash[request_headers.sort] if @options[:headers] == :all headers_needed = Array(@options[:headers]) result = {} headers_needed.each do |need| result.merge!(request_headers.select { |key, value| need.to_s.casecmp(key).zero? }) end Hash[result.sort] end
log_info(log_statements=[])
click to toggle source
# File lib/grape/middleware/logger.rb, line 133 def log_info(log_statements=[]) if @options[:condensed] logger.info log_statements.compact.delete_if(&:empty?).each(&:strip!).join(" - ") else log_statements.each { |log_statement| logger.info log_statement } end end
parameters()
click to toggle source
# File lib/grape/middleware/logger.rb, line 94 def parameters request_params = env[Grape::Env::GRAPE_REQUEST_PARAMS].to_hash request_params.merge! env[Grape::Env::RACK_REQUEST_FORM_HASH] if env[Grape::Env::RACK_REQUEST_FORM_HASH] request_params.merge! env['action_dispatch.request.request_parameters'] if env['action_dispatch.request.request_parameters'] if @options[:filter] @options[:filter].filter(request_params) else request_params end end
processed_by()
click to toggle source
# File lib/grape/middleware/logger.rb, line 121 def processed_by endpoint = env[Grape::Env::API_ENDPOINT] result = [] if endpoint.namespace == BACKSLASH result << '' else result << endpoint.namespace end result.concat endpoint.options[:path].map { |path| path.to_s.sub(BACKSLASH, '') } endpoint.options[:for].to_s << result.join(BACKSLASH) end
start_time()
click to toggle source
# File lib/grape/middleware/logger.rb, line 117 def start_time @start_time ||= Time.now end