Class: ActionController::LogSubscriber

Inherits:
ActiveSupport::LogSubscriber show all
Defined in:
actionpack/lib/action_controller/log_subscriber.rb

Constant Summary collapse

INTERNAL_PARAMS = 
%w(controller action format _method only_path)

Constants inherited from ActiveSupport::LogSubscriber

ActiveSupport::LogSubscriber::BLACK, ActiveSupport::LogSubscriber::BLUE, ActiveSupport::LogSubscriber::BOLD, ActiveSupport::LogSubscriber::CLEAR, ActiveSupport::LogSubscriber::CYAN, ActiveSupport::LogSubscriber::GREEN, ActiveSupport::LogSubscriber::MAGENTA, ActiveSupport::LogSubscriber::RED, ActiveSupport::LogSubscriber::WHITE, ActiveSupport::LogSubscriber::YELLOW

Instance Attribute Summary

Attributes inherited from ActiveSupport::Subscriber

#patterns

Instance Method Summary collapse

Methods inherited from ActiveSupport::LogSubscriber

#finish, flush_all!, log_subscribers, #start

Methods inherited from ActiveSupport::Subscriber

attach_to, #finish, #initialize, method_added, #start, subscribers

Constructor Details

This class inherits a constructor from ActiveSupport::Subscriber

Instance Method Details

#deep_munge(event) ⇒ Object 



56
57
58
59
60
61
62
63
 
# File 'actionpack/lib/action_controller/log_subscriber.rb', line 56

def deep_munge(event)
  message = "Value for params[:#{event.payload[:keys].join('][:')}] was set "\
            "to nil, because it was one of [], [null] or [null, null, ...]. "\
            "Go to http://guides.rubyonrails.org/security.html#unsafe-query-generation "\
            "for more information."\

  debug(message)
end

#halted_callback(event) ⇒ Object 



35
36
37
 
# File 'actionpack/lib/action_controller/log_subscriber.rb', line 35

def halted_callback(event)
  info("Filter chain halted as #{event.payload[:filter].inspect} rendered or redirected")
end

#logger ⇒ Object 



77
78
79
 
# File 'actionpack/lib/action_controller/log_subscriber.rb', line 77

def logger
  ActionController::Base.logger
end

#process_action(event) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'actionpack/lib/action_controller/log_subscriber.rb', line 18

def process_action(event)
  return unless logger.info?

  payload   = event.payload
  additions = ActionController::Base.log_process_action(payload)

  status = payload[:status]
  if status.nil? && payload[:exception].present?
    exception_class_name = payload[:exception].first
    status = ActionDispatch::ExceptionWrapper.status_code_for_exception(exception_class_name)
  end
  message = "Completed #{status} #{Rack::Utils::HTTP_STATUS_CODES[status]} in #{event.duration.round}ms"
  message << " (#{additions.join(" | ")})" unless additions.blank?

  info(message)
end

#redirect_to(event) ⇒ Object 



43
44
45
 
# File 'actionpack/lib/action_controller/log_subscriber.rb', line 43

def redirect_to(event)
  info("Redirected to #{event.payload[:location]}")
end

#send_data(event) ⇒ Object 



47
48
49
 
# File 'actionpack/lib/action_controller/log_subscriber.rb', line 47

def send_data(event)
  info("Sent data #{event.payload[:filename]} (#{event.duration.round(1)}ms)")
end

#send_file(event) ⇒ Object 



39
40
41
 
# File 'actionpack/lib/action_controller/log_subscriber.rb', line 39

def send_file(event)
  info("Sent file #{event.payload[:path]} (#{event.duration.round(1)}ms)")
end

#start_processing(event) ⇒ Object 



6
7
8
9
10
11
12
13
14
15
16
 
# File 'actionpack/lib/action_controller/log_subscriber.rb', line 6

def start_processing(event)
  return unless logger.info?

  payload = event.payload
  params  = payload[:params].except(*INTERNAL_PARAMS)
  format  = payload[:format]
  format  = format.to_s.upcase if format.is_a?(Symbol)

  info "Processing by #{payload[:controller]}##{payload[:action]} as #{format}"
  info "  Parameters: #{params.inspect}" unless params.empty?
end

#unpermitted_parameters(event) ⇒ Object 



51
52
53
54
 
# File 'actionpack/lib/action_controller/log_subscriber.rb', line 51

def unpermitted_parameters(event)
  unpermitted_keys = event.payload[:keys]
  debug("Unpermitted parameters: #{unpermitted_keys.join(", ")}")
end