lib/query_reviewer/views/_profile.rhtml @@ -3,22 +3,43 @@ QueryReviewer QueryReviewer is an advanced SQL query analyzer. It accomplishes the following goals: - * View all EXPLAIN output for all SELECT queries to generate a page + * View all EXPLAIN output for all SELECT queries to generate a page (and optionally SHOW PROFILE ALL) * Rate a page's SQL usage into one of three categories: OK, WARNING, CRITICAL - * Attach meaningful warnings to individual queries + * Attach meaningful warnings to individual queries, and collections of queries * Display interactive summary on page All you have to do is install it. You can optionally run: rake query_reviewer:setup -Which will create config/query_reviewer.yml. This file provides a few useful settings: - * enabled: whether any output or query analysis is performed. Set this FALSE in production! +Which will create config/query_reviewer.yml, see below for what these options mean. If you don't have a config file, +the plugin will use the default in vendor/plugins/query_reviewer. + + +Configuration +============= + +The configuration file allows you to set configuration parameters shared across all rails environment, as well as +overriding those shared parameteres with environment-specific parameters (such as disabling analysis on production!) + + * enabled: whether any output or query analysis is performed. Set this false in production! * inject_view: controls whether the output automatically is injected before the </body> in HTML output. + * profiling: when enabled, runs the MySQL SET PROFILING=1 for queries longer than the warn_duration_threshold / 2.0 + * production_data: whether the duration of a query should be taken into account (if you don't have real data, don't let query duration effect you!) + + * stack_trace_lines: number of lines of call stack to include in the "short" version of the stack trace + * trace_includes_vendor: whether the "short" verison of the stack trace should include files in /vendor + * trace_includes_lib: whether the "short" verison of the stack trace should include files in /lib + * warn_severity: the severity of problem that merits "WARNING" status * critical_severity: the severity of problem that merits "CRITICAL" status + * warn_query_count: the number of queries in a single request that merits "WARNING" status * critical_query_count: the number of queries in a single request that merits "CRITICAL" status - + + * warn_duration_threshold: how long a query must take in seconds (float) before it's considered "WARNING" + * critical_duration_threshold: how long a query must take in seconds (float) before it's considered "CRITICIAL" + + Example ======= @@ -27,4 +48,4 @@ If you disable the inject_view option, you'll need to manually put the analyzer' <%= query_review_output %> -Copyright (c) 2007 Kongregate, released under the MIT license +Copyright (c) 2007-2008 Kongregate & David Stevenson, released under the MIT license README @@ -5,13 +5,29 @@ module QueryReviewer end def select_with_review(sql, name = nil) + @logger.silence { execute("SET PROFILING=1") } if QueryReviewer::CONFIGURATION["profiling"] + t1 = Time.now query_results = select_without_review(sql, name) + t2 = Time.now if @logger and sql =~ /^select/i + use_profiling = QueryReviewer::CONFIGURATION["profiling"] + use_profiling &&= (t2 - t1) >= QueryReviewer::CONFIGURATION["warn_duration_threshold"].to_f / 2.0 if QueryReviewer::CONFIGURATION["production_data"] + + if use_profiling + @logger.silence { execute("SET PROFILING=1") } + select_without_review(sql, name) + profile = @logger.silence { select_without_review("SHOW PROFILE ALL", name) } + @logger.silence { execute("SET PROFILING=0") } + else + profile = nil + end + cols = @logger.silence do select_without_review("explain #{sql}", name) end - query = SqlQuery.new(sql, cols) + + query = SqlQuery.new(sql, cols, t2 - t1, profile) Thread.current["queries"] << query if Thread.current["queries"] && Thread.current["queries"].respond_to?(:<<) @logger.debug(format_log_entry("Analyzing #{name}\n", query.to_table)) if @logger.level <= Logger::INFO end lib/query_reviewer/mysql_adapter_extensions.rb @@ -33,7 +33,7 @@ module QueryReviewer def analyze_key! if self.key == "const" praise "Way to go!" - elsif self.key.blank? && !self.extra.include?("select tables optimized away") + elsif self.key.blank? && !self.rows.blank? warn :severity => 6, :field => "key", :desc => "No index was used here. In this case, that meant scanning #{self.rows} rows." end end lib/query_reviewer/mysql_analyzer.rb @@ -1,16 +1,21 @@ +require "ostruct" + module QueryReviewer # a single SQL SELECT query class SqlQuery - attr_reader :sql, :rows, :subqueries, :trace, :id + attr_reader :sql, :rows, :subqueries, :trace, :id, :profile, :duration cattr_accessor :next_id self.next_id = 1 - def initialize(sql, rows) + def initialize(sql, rows, duration = 0.0, profile = nil) @rows = rows @sql = sql @subqueries = rows.collect{|row| SqlSubQuery.new(self, row)} @id = (self.class.next_id += 1) + @profile = profile.collect { |p| OpenStruct.new(p) } if profile + @duration = duration.to_f + @warnings = [] get_trace end @@ -19,7 +24,7 @@ module QueryReviewer end def warnings - self.subqueries.collect(&:warnings).flatten + self.subqueries.collect(&:warnings).flatten + @warnings end def has_warnings? @@ -30,8 +35,19 @@ module QueryReviewer self.warnings.empty? ? 0 : self.warnings.collect(&:severity).max end + def table + @subqueries.first.table + end + def analyze! self.subqueries.collect(&:analyze!) + if duration + if duration >= QueryReviewer::CONFIGURATION["critical_duration_threshold"] + warn(:problem => "Query took #{duration} seconds", :severity => 9) + elsif duration >= QueryReviewer::CONFIGURATION["warn_duration_threshold"] + warn(:problem => "Query took #{duration} seconds", :severity => QueryReviewer::CONFIGURATION["critical_severity"]) + end + end end def to_hash @@ -52,5 +68,11 @@ module QueryReviewer def get_trace @trace = Kernel.caller end + + def warn(options) + options[:query] = self + options[:table] ||= self.table + @warnings << QueryWarning.new(options) + end end end \ No newline at end of file lib/query_reviewer/sql_query.rb @@ -20,6 +20,10 @@ module QueryReviewer self.send(method_name.to_sym) end + def table + @table[:table] + end + private def warn(options) @@ -29,7 +33,7 @@ module QueryReviewer options[:problem] = ("#{field.to_s.titleize}: #{val.blank? ? "(blank)" : val}") end options[:query] = self - options[:table] = @table[:table] + options[:table] = self.table @warnings << QueryWarning.new(options) end lib/query_reviewer/sql_sub_query.rb @@ -24,14 +24,25 @@ No queries to display. <% else %> <ul class="small"> - <% @queries.queries.reject{|q| q.has_warnings?}.each do |query| %> + <% @queries.queries.reject{|q| q.has_warnings?}.sort{|a,b| b.duration <=> a.duration}.each do |query| %> <li> - <%= render :partial => "/query_sql", :object => query %> + <% if QueryReviewer::CONFIGURATION["production_data"] %> + <%= duration_with_color(query.duration.to_f) %>s + <% end %> + <%= render :partial => "/query_sql", :object => query %> <a href="javascript: query_review_toggle('warning_<%= query.id %>_explain')" title="show/hide sql">EXPLN</a> + <% if QueryReviewer::CONFIGURATION["profiling"] && query.profile %> + <a href="javascript: query_review_toggle('warning_<%= query.id %>_profile')" title="show/hide profile">PROF</a> + <% end %> <a href="javascript: query_review_toggle('warning_<%= query.id %>_trace')" title="show/hide stack trace">TRACE</a> <div style="display: none" id="warning_<%= query.id %>_explain" class="indent small tbpadded"> <%= render :partial => "/explain", :locals => {:query => query} %> </div> + <% if QueryReviewer::CONFIGURATION["profiling"] && query.profile %> + <div style="display: none" id="warning_<%= query.id %>_profile" class="indent small"> + <%= render :partial => "/profile", :locals => {:query => query} %> + </div> + <% end %> <div style="display: none" id="warning_<%= query.id %>_trace" class="indent small"> <%= render :partial => "/trace", :object => query.relevant_trace, :locals => {:query_id => query.id, :full_trace => query.full_trace} %> </div> lib/query_reviewer/views/_box_body.rhtml @@ -1,15 +1,23 @@ <li id="query_<%= query_with_warning.id %>"> <div> <%= render :partial => "/spectrum", :locals => {:severity => query_with_warning.max_severity} %> - <p> + <% if QueryReviewer::CONFIGURATION["production_data"] %> + <div style="float: left; padding-right: 5px;"> + <%= duration_with_color(query_with_warning.duration.to_f) %>s + </div> + <% end %> + <p> <i>Table <%= (query_with_warning.warnings.detect {|w| !w.table.blank? } || query_with_warning.warnings.last).table %>:</i> <% query_with_warning.warnings.sort{|a,b| a.severity <=> b.severity}.reverse.each_with_index do |warn, index| %> - <span style="color: <%= severity_color warn.severity%>" title="<%= warn.desc%>"><%= warn.problem %></span><%= ", " if index < query_with_warning.warnings.length - 1 %> + <span style="color: <%= severity_color warn.severity%>;" title="<%= warn.desc%>"><%= warn.problem %></span><%= ", " if index < query_with_warning.warnings.length - 1 %> <% end %> <a href="javascript: query_review_toggle('warning_<%= query_with_warning.id %>_desc')" title="show/hide warning message">MSG</a> <a href="javascript: query_review_toggle('warning_<%= query_with_warning.id %>_sql')" title="show/hide sql">SQL</a> - <a href="javascript: query_review_toggle('warning_<%= query_with_warning.id %>_explain')" title="show/hide sql">EXPLN</a> - <a href="javascript: query_review_toggle('warning_<%= query_with_warning.id %>_trace')" title="show/hide stack trace">TRACE</a> + <a href="javascript: query_review_toggle('warning_<%= query_with_warning.id %>_explain')" title="show/hide explain output">EXPLN</a> + <% if QueryReviewer::CONFIGURATION["profiling"] && query_with_warning.profile %> + <a href="javascript: query_review_toggle('warning_<%= query_with_warning.id %>_profile')" title="show/hide profile output">PROF</a> + <% end %> + <a href="javascript: query_review_toggle('warning_<%= query_with_warning.id %>_trace')" title="show/hide stack trace">TRACE</a> <% if ignore_hash?(query_with_warning.to_hash) %> <a href="javascript: remove_ignore_hash('<%= query_with_warning.to_hash %>'); query_review_hide('query_<%= query_with_warning.id %>')" title="stop ignore this query from now on">UNIGNR</a> <% else %> @@ -28,7 +36,12 @@ <div style="display: none" id="warning_<%= query_with_warning.id %>_explain" class="indent small tbpadded"> <%= render :partial => "/explain", :locals => {:query => query_with_warning} %> </div> - <div style="display: none" id="warning_<%= query_with_warning.id %>_trace" class="indent small"> + <% if QueryReviewer::CONFIGURATION["profiling"] && query_with_warning.profile %> + <div style="display: none" id="warning_<%= query_with_warning.id %>_profile" class="indent small tbpadded"> + <%= render :partial => "/profile", :locals => {:query => query_with_warning} %> + </div> + <% end %> + <div style="display: none" id="warning_<%= query_with_warning.id %>_trace" class="indent small"> <%= render :partial => "/trace", :object => query_with_warning.relevant_trace, :locals => {:query_id => query_with_warning.id, :full_trace => query_with_warning.full_trace} %> </div> </li> \ No newline at end of file lib/query_reviewer/views/_query_with_warning.rhtml @@ -80,6 +80,16 @@ module QueryReviewer def enabled_by_cookie @controller.send(:cookies)["query_review_enabled"] end + + def duration_with_color(duration) + if duration > QueryReviewer::CONFIGURATION["critical_duration_threshold"] + "<span style=\"color: #{severity_color(9)}\" title=\"#{duration}\">#{"%.3f" % duration}</span>" + elsif duration > QueryReviewer::CONFIGURATION["warn_duration_threshold"] + "<span style=\"color: #{severity_color(QueryReviewer::CONFIGURATION["critical_severity"])}\" title=\"#{duration}\">#{"%.3f" % duration}</span>" + else + "<span title=\"#{duration}\">#{"%.3f" % duration}</span>" + end + end end end end lib/query_reviewer/views/query_review_box_helper.rb @@ -7,10 +7,18 @@ all: trace_includes_vendor: false trace_includes_lib: true critical_query_count: 50 + profiling: enabled + production_data: true + warn_duration_threshold: 0.2 + critical_duration_threshold: 1.0 +# these values override the 'all' values when using that environment development: enabled: true +staging: + enabled: true + production: enabled: false query_reviewer_defaults.yml bb89ad4fc57dab85281b1dda2518fdb298bd125d David Stevenson david@flouri.sh http://github.com/dsboulder/query_reviewer/commit/4de4ab74eaca847c59f2cde83cc6d36137e0c6b7 4de4ab74eaca847c59f2cde83cc6d36137e0c6b7 2008-04-07T14:46:42-07:00 2008-04-07T14:46:42-07:00 ds: added mysql query profiling and all related features, also added duration features b6596cbc3aebc8463e02942d400fde014d179391 David Stevenson david@flouri.sh