123456789_123456789_123456789_123456789_123456789_

Class: ActiveRecord::LogSubscriber

Do not use. This class is for internal use only.
Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::ActiveSupport::EventReporter::LogSubscriber
Instance Chain:
self, ::ActiveSupport::EventReporter::LogSubscriber, ::ActiveSupport::ColorizeLogging
Inherits: ActiveSupport::EventReporter::LogSubscriber
Defined in: activerecord/lib/active_record/log_subscriber.rb

Constant Summary

::ActiveSupport::ColorizeLogging - Included

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

::ActiveSupport::EventReporter::LogSubscriber - Inherited

LEVEL_CHECKS

Class Attribute Summary

::ActiveSupport::EventReporter::LogSubscriber - Inherited

.logger, .logger=, .namespace, .log_levels, .log_levels?

Class Method Summary

::ActiveSupport::EventReporter::LogSubscriber - Inherited

.default_logger, .event_log_level, .subscription_filter

Instance Attribute Summary

::ActiveSupport::EventReporter::LogSubscriber - Inherited

#log_levels, #log_levels?

Instance Method Summary

::ActiveSupport::EventReporter::LogSubscriber - Inherited

#emit, #logger, #namespace

::ActiveSupport::ColorizeLogging - Included

#color

Set color by using a symbol or one of the defined constants.
#colorize_logging, #debug, #error, #fatal, #info, #mode_from, #unknown, #warn

Class Attribute Details

.backtrace_cleaner (rw)

[ GitHub ] 

  


# File 'activerecord/lib/active_record/log_subscriber.rb', line 9



class_attribute :backtrace_cleaner, default: ActiveSupport::BacktraceCleaner.new


  








  

    .backtrace_cleaner?  ⇒ Boolean  (rw)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/log_subscriber.rb', line 9



class_attribute :backtrace_cleaner, default: ActiveSupport::BacktraceCleaner.new


  







Class Method Details



  

    .default_logger  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/log_subscriber.rb', line 51



def self.default_logger
  ActiveRecord::Base.logger
end


  







Instance Attribute Details



  

    #backtrace_cleaner   (rw)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/log_subscriber.rb', line 9



class_attribute :backtrace_cleaner, default: ActiveSupport::BacktraceCleaner.new


  








  

    #backtrace_cleaner?  ⇒ Boolean  (rw)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/log_subscriber.rb', line 9



class_attribute :backtrace_cleaner, default: ActiveSupport::BacktraceCleaner.new


  







Instance Method Details



  

    #colorize_payload_name(name, payload_name)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/log_subscriber.rb', line 75



def colorize_payload_name(name, payload_name)
  if payload_name.blank? || payload_name == "SQL" # SQL vs Model Load/Exists
    color(name, MAGENTA, bold: true)
  else
    color(name, CYAN, bold: true)
  end
end


  








  

    #debug(progname = nil, &block)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/log_subscriber.rb', line 104



def debug(progname = nil, &block)
  return unless super

  if ActiveRecord.verbose_query_logs
    log_query_source
  end
end


  








  

    #filter(name, value)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/log_subscriber.rb', line 124



def filter(name, value)
  ActiveRecord::Base.inspection_filter.filter_param(name, value)
end


  








  

    #log_query_source   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/log_subscriber.rb', line 112



def log_query_source
  source = query_source_location

  if source
    logger.debug("  ↳ #{source}")
  end
end


  








  

    #query_source_location   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/log_subscriber.rb', line 120



def query_source_location
  backtrace_cleaner.first_clean_frame
end


  








  

    #render_bind(attr, value)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/log_subscriber.rb', line 60



def render_bind(attr, value)
  case attr
  when ActiveModel::Attribute
    if attr.type.binary? && attr.value
      value = "<#{attr.value_for_database.to_s.bytesize} bytes of binary data>"
    end
  when Array
    attr = attr.first
  else
    attr = nil
  end

  [attr&.name, value]
end


  








  

    #sql(event)  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/log_subscriber.rb', line 25



def sql(event)
  payload = event[:payload]

  return if IGNORE_PAYLOAD_NAMES.include?(payload[:name])

  name = if payload[:async]
    "ASYNC #{payload[:name]} (#{payload[:lock_wait].round(1)}ms) (db time #{payload[:duration_ms].round(1)}ms)"
  else
    "#{payload[:name]} (#{payload[:duration_ms].round(1)}ms)"
  end
  name  = "CACHE #{name}" if payload[:cached]
  sql   = payload[:sql]
  binds = payload[:binds]

  if payload[:binds]&.any?
    binds = binds.inspect
    binds.prepend("  ")
  end

  name = colorize_payload_name(name, payload[:name])
  sql  = color(sql, sql_color(sql), bold: true) if colorize_logging

  debug "  #{name}  #{sql}#{binds}"
end


  








  

    #sql_color(sql)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/log_subscriber.rb', line 83



def sql_color(sql)
  case sql
  when /\A\s*rollback/mi
    RED
  when /select .*for update/mi, /\A\s*lock/mi
    WHITE
  when /\A\s*select/i
    BLUE
  when /\A\s*insert/i
    GREEN
  when /\A\s*update/i
    YELLOW
  when /\A\s*delete/i
    RED
  when /transaction\s*\Z/i
    CYAN
  else
    MAGENTA
  end
end


  








  

    #strict_loading_violation(event)  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/log_subscriber.rb', line 11



def strict_loading_violation(event)
  debug do
    owner = event[:payload][:owner]
    klass = event[:payload][:class]
    name = event[:payload][:name]
    message = +"`#{owner}` is marked for strict_loading."
    message << " The #{klass ? "#{klass} association" : "polymorphic association"}"
    message << " named `:#{name}` cannot be lazily loaded."

    color(message, RED)
  end
end


  








  

    #type_casted_binds(casted_binds)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/log_subscriber.rb', line 56



def type_casted_binds(casted_binds)
  casted_binds.respond_to?(:call) ? casted_binds.call : casted_binds
end