123456789_123456789_123456789_123456789_123456789_

Class: ActionController::LogSubscriber

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::ActiveSupport::LogSubscriber, ::ActiveSupport::Subscriber
Instance Chain:
self, ::ActiveSupport::LogSubscriber, ::ActiveSupport::Subscriber
Inherits: ActiveSupport::LogSubscriber
Defined in: actionpack/lib/action_controller/log_subscriber.rb

Constant Summary

::ActiveSupport::LogSubscriber - Inherited

BLACK, BLUE, CYAN, GREEN, LEVEL_CHECKS, MAGENTA, MODES, RED, WHITE, YELLOW

Class Attribute Summary

::ActiveSupport::LogSubscriber - Inherited

.colorize_logging, .log_levels, .log_levels?, .logger, .logger=

::ActiveSupport::Subscriber - Inherited

.namespace, .notifier, .subscriber

Class Method Summary

::ActiveSupport::LogSubscriber - Inherited

.attach_to,
.flush_all!

Flush all log_subscribers’ logger.
.log_subscribers, .new, .fetch_public_methods, .set_event_levels, .subscribe_log_level

::ActiveSupport::Subscriber - Inherited

.attach_to

Attach the subscriber to a namespace.
.detach_from

Detach the subscriber from a namespace.
.method_added

Adds event subscribers for all new methods added to the class.
.new, .subscribers, .add_event_subscriber, .fetch_public_methods, .find_attached_subscriber, .invalid_event?, .pattern_subscribed?, .prepare_pattern, .remove_event_subscriber

Instance Attribute Summary

::ActiveSupport::LogSubscriber - Inherited

#colorize_logging, #event_levels=

::ActiveSupport::Subscriber - Inherited

#patterns

Instance Method Summary

::ActiveSupport::LogSubscriber - Inherited

#call, #logger, #publish_event, #silenced?,
#color

Set color by using a symbol or one of the defined constants.
#log_exception, #mode_from

::ActiveSupport::Subscriber - Inherited

#call, #publish_event

Constructor Details

This class inherits a constructor from ActiveSupport::LogSubscriber

Instance Method Details

#halted_callback(event)

[ GitHub ] 

  


# 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  
  

  [ GitHub ]


  

  


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



def logger
  ActionController::Base.logger
end


  








  

    #process_action(event)  
  

  [ GitHub ]


  

  


# 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)  
  

  [ GitHub ]


  

  


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



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


  








  

    #send_data(event)  
  

  [ GitHub ]


  

  


# 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)  
  

  [ GitHub ]


  

  


# 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)  
  

  [ GitHub ]


  

  


# 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)  
  

  [ GitHub ]


  

  


# 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