Class: SqlLogging::Statistics

Inherits:
Object
  • Object
show all
Defined in:
lib/sql-logging/statistics.rb

Constant Summary collapse

@@show_sql_backtrace = 
true
@@show_top_sql_queries = 
:total_time
@@top_sql_queries = 
10
@@backtrace_cleaner = 
nil
@@queries = 
@@bytes = @@rows = 0
@@top_queries = 
{}

Class Method Summary collapse

Class Method Details

.backtrace_cleaner ⇒ Object 



39
40
41
42
43
44
45
 
# File 'lib/sql-logging/statistics.rb', line 39

def self.backtrace_cleaner
  unless @@backtrace_cleaner
    @@backtrace_cleaner = Rails.backtrace_cleaner.dup
    @@backtrace_cleaner.add_silencer { |line| line =~ %r{sql-logging/lib} }
  end
  @@backtrace_cleaner
end

.log_report ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/sql-logging/statistics.rb', line 90

def self.log_report
  Rails.logger.debug "SQL Logging: #{@@queries} statements executed, returning #{@@bytes} bytes"

  unless @@show_top_sql_queries == false || @@top_queries.empty?
    Rails.logger.debug "Top #{@@top_sql_queries} SQL executions:"
    sorted_keys = @@top_queries.keys.sort_by { |k| @@top_queries[k][@@show_top_sql_queries] }.reverse
    sorted_keys.slice(0..@@top_sql_queries).each do |key|
      query = @@top_queries[key]
      Rails.logger.debug "  Executed #{query.queries} times in #{'%.1f' % query.total_time}ms " +
        "(#{'%.1f' % query.min_time}/#{'%.1f' % query.median_time}/#{'%.1f' % query.max_time}ms min/median/max), " +
        "returning #{query.rows} rows" +
        "(#{query.bytes} bytes):\n" +
        "    #{query.name}\n" +
        "    First exec was: #{query.sql}\n" +
        "    #{query.backtrace}"
    end
  end
end

.record_query(sql, name, msec, result) ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/sql-logging/statistics.rb', line 47

def self.record_query(sql, name, msec, result)
  unless name.blank? || name =~ / Columns$/ || name == :skip_logging
    bytes = 0
    if result.nil?
      ntuples = 0
    else
      result.each do |row|
        row.each do |key, value|
          bytes += key.size if key && key.respond_to?(:size)
          bytes += value.size if value && value.respond_to?(:size)
        end
      end if result.respond_to?(:each)
      ntuples = 0
      if result.respond_to?(:length)
        ntuples = result.length
      elsif result.respond_to?(:count)
        ntuples = result.count
      elsif result.respond_to?(:num_rows)
        ntuples = result.num_rows
      elsif result.respond_to?(:ntuples)
        ntuples = result.ntuples
      end
    end
  
    @@queries += 1
    @@rows += ntuples
    @@bytes += bytes

    backtrace = backtrace_cleaner.clean(caller).join("\n    ")
    unless @@show_top_sql_queries == false
      key = "#{name}:#{backtrace}"
      unless query = @@top_queries[key]
        query = LoggedQuery.new(sql, name, backtrace)
        @@top_queries[key] = query
      end
      query.log_query(ntuples || 0, bytes || 0, msec)
    end

    Rails.logger.debug "    #{ntuples} rows, #{bytes} bytes"
    Rails.logger.debug "    #{backtrace}" if @@show_sql_backtrace
  end
end

.reset_statistics! ⇒ Object 



34
35
36
37
 
# File 'lib/sql-logging/statistics.rb', line 34

def self.reset_statistics!
  @@queries = @@bytes = @@rows = 0
  @@top_queries = {}
end

.show_top_sql_queries ⇒ Object 



19
20
21
 
# File 'lib/sql-logging/statistics.rb', line 19

def self.show_top_sql_queries
  @@show_top_sql_queries
end

.show_top_sql_queries=(value) ⇒ Object 



23
24
25
26
27
28
29
 
# File 'lib/sql-logging/statistics.rb', line 23

def self.show_top_sql_queries=(value)
  unless [ false, :rows, :queries, :bytes, :total_time, :median_time ].include?(value)
    raise ArgumentError, "show_top_sql_queries must be one of false, :rows, :queries, :bytes, :total_time or :median_time"
  end

  @@show_top_sql_queries = value
end