log_subscriber.rb 2.6 KB
Newer Older
1 2
# frozen_string_literal: true

3 4 5 6 7
module ActionController
  class LogSubscriber < ActiveSupport::LogSubscriber
    INTERNAL_PARAMS = %w(controller action format _method only_path)

    def start_processing(event)
8 9
      return unless logger.info?

10 11
      payload = event.payload
      params  = payload[:params].except(*INTERNAL_PARAMS)
J
José Valim 已提交
12 13
      format  = payload[:format]
      format  = format.to_s.upcase if format.is_a?(Symbol)
14

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

    def process_action(event)
20 21 22 23 24 25 26 27 28
      info do
        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
29
        message = +"Completed #{status} #{Rack::Utils::HTTP_STATUS_CODES[status]} in #{event.duration.round}ms"
30
        message << " (#{additions.join(" | ")})" unless additions.empty?
31
        message << "\n\n" if defined?(Rails.env) && Rails.env.development?
32

33
        message
34
      end
35 36
    end

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

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

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

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

53
    def unpermitted_parameters(event)
54 55
      debug do
        unpermitted_keys = event.payload[:keys]
56
        "Unpermitted parameter#{'s' if unpermitted_keys.size > 1}: #{unpermitted_keys.map { |e| ":#{e}" }.join(", ")}"
57
      end
58 59
    end

60 61 62 63
    %w(write_fragment read_fragment exist_fragment?
       expire_fragment expire_page write_page).each do |method|
      class_eval <<-METHOD, __FILE__, __LINE__ + 1
        def #{method}(event)
64
          return unless logger.info? && ActionController::Base.enable_fragment_cache_logging
65
          key         = ActiveSupport::Cache.expand_cache_key(event.payload[:key] || event.payload[:path])
66
          human_name  = #{method.to_s.humanize.inspect}
67
          info("\#{human_name} \#{key} (\#{event.duration.round(1)}ms)")
68 69 70
        end
      METHOD
    end
71

72 73 74 75 76 77
    def logger
      ActionController::Base.logger
    end
  end
end

78
ActionController::LogSubscriber.attach_to :action_controller