Merge pull request #543 from wolfe/group-sql

Color-code SQL query "Timeline" stripes according to stacktrace

Author: aaugustin

debug_toolbar/panels/sql/panel.py

@@ -2,6 +2,7 @@
 
 import uuid
 from copy import copy
+from collections import defaultdict
 
 from django.conf.urls import patterns, url
 from django.db import connections
@@ -10,7 +11,7 @@
 from debug_toolbar.panels import Panel
 from debug_toolbar.panels.sql.forms import SQLSelectForm
 from debug_toolbar.utils import render_stacktrace
-from debug_toolbar.panels.sql.utils import reformat_sql
+from debug_toolbar.panels.sql.utils import reformat_sql, contrasting_color_generator
 from debug_toolbar.panels.sql.tracking import wrap_cursor, unwrap_cursor
 
 
@@ -136,6 +137,8 @@ def disable_instrumentation(self):
             unwrap_cursor(connection)
 
     def process_response(self, request, response):
+        colors = contrasting_color_generator()
+        trace_colors = defaultdict(lambda: next(colors))
         if self._queries:
             width_ratio_tally = 0
             factor = int(256.0 / (len(self._databases) * 2.5))
@@ -196,6 +199,8 @@ def process_response(self, request, response):
                 query['stacktrace'] = render_stacktrace(query['stacktrace'])
                 i += 1
 
+                query['trace_color'] = trace_colors[query['stacktrace']]
+
             if trans_id:
                 self._queries[(i - 1)][1]['ends_trans'] = True
 

debug_toolbar/panels/sql/utils.py

@@ -35,3 +35,27 @@ def swap_fields(sql):
             r'<a class="djDebugCollapsed djDebugToggle" href="#">\1</a> '
             r'<strong>FROM')
     return re.sub(expr, subs, sql)
+
+
+def contrasting_color_generator():
+    """
+    Generate constrasting colors by varying most significant bit of RGB first,
+    and then vary subsequent bits systematically.
+    """
+    def rgb_to_hex(rgb):
+        return '#%02x%02x%02x' % tuple(rgb)
+
+    triples = [(1, 0, 0), (0, 1, 0), (0, 0, 1),
+               (1, 1, 0), (0, 1, 1), (1, 0, 1), (1, 1, 1)]
+    n = 1 << 7
+    so_far = [[0, 0, 0]]
+    while True:
+        if n == 0:  # This happens after 2**24 colours; presumably, never
+            yield "#000000"  # black
+        copy_so_far = list(so_far)
+        for triple in triples:
+            for previous in copy_so_far:
+                rgb = [n * triple[i] + previous[i] for i in range(3)]
+                so_far.append(rgb)
+                yield rgb_to_hex(rgb)
+        n >>= 1

debug_toolbar/templates/debug_toolbar/panels/sql.html

@@ -34,7 +34,7 @@
 						</div>
 					</td>
 					<td class="timeline">
-						<div class="djDebugTimeline"><div class="djDebugLineChart{% if query.is_slow %} djDebugLineChartWarning{% endif %}" style="left:{{ query.start_offset|unlocalize }}%;"><strong style="width:{{ query.width_ratio_relative|unlocalize }}%;">{{ query.width_ratio }}%</strong></div></div>
+						<div class="djDebugTimeline"><div class="djDebugLineChart{% if query.is_slow %} djDebugLineChartWarning{% endif %}" style="left:{{ query.start_offset|unlocalize }}%;"><strong style="width:{{ query.width_ratio_relative|unlocalize }}%; background-color:{{ query.trace_color }};">{{ query.width_ratio }}%</strong></div></div>
 					</td>
 					<td class="time">
 						{{ query.duration|floatformat:"2" }}