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::CYAN, ActiveSupport::LogSubscriber::GREEN, ActiveSupport::LogSubscriber::LEVEL_CHECKS, ActiveSupport::LogSubscriber::MAGENTA, ActiveSupport::LogSubscriber::MODES, ActiveSupport::LogSubscriber::RED, ActiveSupport::LogSubscriber::WHITE, ActiveSupport::LogSubscriber::YELLOW

Instance Attribute Summary

Attributes inherited from ActiveSupport::LogSubscriber

#event_levels

Attributes inherited from ActiveSupport::Subscriber

#patterns

Instance Method Summary collapse

Methods inherited from ActiveSupport::LogSubscriber

attach_to, #call, flush_all!, #initialize, log_subscribers, #publish_event, #silenced?

Methods inherited from ActiveSupport::Subscriber

attach_to, #call, detach_from, #initialize, method_added, #publish_event, subscribers

Constructor Details

This class inherits a constructor from ActiveSupport::LogSubscriber

Instance Method Details

#halted_callback(event) ⇒ Object 



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

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

#logger ⇒ Object 



90
91
92
 
# File 'actionpack/lib/action_controller/log_subscriber.rb', line 90

def logger
  ActionController::Base.logger
end

#process_action(event) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'actionpack/lib/action_controller/log_subscriber.rb', line 26

def process_action(event)
  info do
    payload = event.payload
    additions = ActionController::Base.log_process_action(payload)
    status = payload[:status]

    if status.nil? && (exception_class_name = payload[:exception]&.first)
      status = ActionDispatch::ExceptionWrapper.status_code_for_exception(exception_class_name)
    end

    additions << "GC: #{event.gc_time.round(1)}ms"

    message = +"Completed #{status} #{Rack::Utils::HTTP_STATUS_CODES[status]} in #{event.duration.round}ms" \
               " (#{additions.join(" | ")})"
    message << "\n\n" if defined?(Rails.env) && Rails.env.development?

    message
  end
end

#redirect_to(event) ⇒ Object 



57
58
59
 
# File 'actionpack/lib/action_controller/log_subscriber.rb', line 57

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

#send_data(event) ⇒ Object 



62
63
64
 
# File 'actionpack/lib/action_controller/log_subscriber.rb', line 62

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

#send_file(event) ⇒ Object 



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

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

#start_processing(event) ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'actionpack/lib/action_controller/log_subscriber.rb', line 9

def start_processing(event)
  return unless logger.info?

  payload = event.payload
  params = {}
  payload[:params].each_pair do |k, v|
    params[k] = v unless INTERNAL_PARAMS.include?(k)
  end
  format  = payload[:format]
  format  = format.to_s.upcase if format.is_a?(Symbol)
  format  = "*/*" if format.nil?

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

#unpermitted_parameters(event) ⇒ Object 



67
68
69
70
71
72
73
74
 
# File 'actionpack/lib/action_controller/log_subscriber.rb', line 67

def unpermitted_parameters(event)
  debug do
    unpermitted_keys = event.payload[:keys]
    display_unpermitted_keys = unpermitted_keys.map { |e| ":#{e}" }.join(", ")
    context = event.payload[:context].map { |k, v| "#{k}: #{v}" }.join(", ")
    color("Unpermitted parameter#{'s' if unpermitted_keys.size > 1}: #{display_unpermitted_keys}. Context: { #{context} }", RED)
  end
end