Class: ActiveRecord::LogSubscriber

Inherits:
ActiveSupport::LogSubscriber show all
Defined in:
activerecord/lib/active_record/log_subscriber.rb

Constant Summary collapse

IGNORE_PAYLOAD_NAMES =
["SCHEMA", "EXPLAIN"]

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

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ActiveSupport::LogSubscriber

#finish, flush_all!, log_subscribers, #start

Methods inherited from ActiveSupport::Subscriber

attach_to, #finish, method_added, #start, subscribers

Constructor Details

#initializeLogSubscriber

Returns a new instance of LogSubscriber.



18
19
20
21
# File 'activerecord/lib/active_record/log_subscriber.rb', line 18

def initialize
  super
  @odd = false
end

Class Method Details

.reset_runtimeObject



13
14
15
16
# File 'activerecord/lib/active_record/log_subscriber.rb', line 13

def self.reset_runtime
  rt, self.runtime = runtime, 0
  rt
end

.runtimeObject



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

def self.runtime
  ActiveRecord::RuntimeRegistry.sql_runtime ||= 0
end

.runtime=(value) ⇒ Object



5
6
7
# File 'activerecord/lib/active_record/log_subscriber.rb', line 5

def self.runtime=(value)
  ActiveRecord::RuntimeRegistry.sql_runtime = value
end

Instance Method Details

#loggerObject



69
70
71
# File 'activerecord/lib/active_record/log_subscriber.rb', line 69

def logger
  ActiveRecord::Base.logger
end

#odd?Boolean

Returns:

  • (Boolean)


65
66
67
# File 'activerecord/lib/active_record/log_subscriber.rb', line 65

def odd?
  @odd = !@odd
end

#render_bind(column, value) ⇒ Object



23
24
25
26
27
28
29
30
31
32
33
34
35
# File 'activerecord/lib/active_record/log_subscriber.rb', line 23

def render_bind(column, value)
  if column
    if column.binary?
      # This specifically deals with the PG adapter that casts bytea columns into a Hash.
      value = value[:value] if value.is_a?(Hash)
      value = value ? "<#{value.bytesize} bytes of binary data>" : "<NULL binary data>"
    end

    [column.name, value]
  else
    [nil, value]
  end
end

#sql(event) ⇒ Object



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# File 'activerecord/lib/active_record/log_subscriber.rb', line 37

def sql(event)
  self.class.runtime += event.duration
  return unless logger.debug?

  payload = event.payload

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

  name  = "#{payload[:name]} (#{event.duration.round(1)}ms)"
  sql   = payload[:sql]
  binds = nil

  unless (payload[:binds] || []).empty?
    binds = "  " + payload[:binds].map { |col,v|
      render_bind(col, v)
    }.inspect
  end

  if odd?
    name = color(name, CYAN, true)
    sql  = color(sql, nil, true)
  else
    name = color(name, MAGENTA, true)
  end

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