diff options
Diffstat (limited to 'debug_toolbar/panels/cache.py')
| -rw-r--r-- | debug_toolbar/panels/cache.py | 210 |
1 files changed, 141 insertions, 69 deletions
diff --git a/debug_toolbar/panels/cache.py b/debug_toolbar/panels/cache.py index 1be6400..585521c 100644 --- a/debug_toolbar/panels/cache.py +++ b/debug_toolbar/panels/cache.py @@ -1,110 +1,125 @@ -import time import inspect import sys +import time +from django.conf import settings from django.core import cache +from django.core.cache import get_cache as base_get_cache from django.core.cache.backends.base import BaseCache +from django.dispatch import Signal +from django.template import Node +from django.utils.datastructures import SortedDict from django.utils.translation import ugettext_lazy as _, ungettext + from debug_toolbar.panels import DebugPanel +from debug_toolbar.utils import (tidy_stacktrace, render_stacktrace, + get_template_info, get_stack) + + +cache_called = Signal(providing_args=["time_taken", "name", "return_value", "args", "kwargs", "trace"]) + + +def send_signal(method): + def wrapped(self, *args, **kwargs): + t = time.time() + value = method(self, *args, **kwargs) + t = time.time() - t + + enable_stacktraces = getattr(settings, + 'DEBUG_TOOLBAR_CONFIG', {}).get('ENABLE_STACKTRACES', True) + if enable_stacktraces: + stacktrace = tidy_stacktrace(reversed(get_stack())) + else: + stacktrace = [] + + template_info = None + cur_frame = sys._getframe().f_back + try: + while cur_frame is not None: + if cur_frame.f_code.co_name == 'render': + node = cur_frame.f_locals['self'] + if isinstance(node, Node): + template_info = get_template_info(node.source) + break + cur_frame = cur_frame.f_back + except: + pass + del cur_frame + cache_called.send(sender=self.__class__, time_taken=t, + name=method.__name__, return_value=value, + args=args, kwargs=kwargs, trace=stacktrace, + template_info=template_info, backend=self.cache) + return value + return wrapped class CacheStatTracker(BaseCache): """A small class used to track cache calls.""" def __init__(self, cache): self.cache = cache - self.reset() - - def reset(self): - self.calls = [] - self.hits = 0 - self.misses = 0 - self.sets = 0 - self.gets = 0 - self.get_manys = 0 - self.deletes = 0 - self.total_time = 0 def _get_func_info(self): frame = sys._getframe(3) info = inspect.getframeinfo(frame) return (info[0], info[1], info[2], info[3]) - def get(self, *args, **kwargs): - t = time.time() - value = self.cache.get(*args, **kwargs) - this_time = time.time() - t - self.total_time += this_time * 1000 - if value is None: - self.misses += 1 - else: - self.hits += 1 - self.gets += 1 - self.calls.append((this_time, 'get', args, kwargs, self._get_func_info())) - return value - - def set(self, *args, **kwargs): - t = time.time() - self.cache.set(*args, **kwargs) - this_time = time.time() - t - self.total_time += this_time * 1000 - self.sets += 1 - self.calls.append((this_time, 'set', args, kwargs, self._get_func_info())) - - def delete(self, *args, **kwargs): - t = time.time() - self.cache.delete(*args, **kwargs) - this_time = time.time() - t - self.total_time += this_time * 1000 - self.deletes += 1 - self.calls.append((this_time, 'delete', args, kwargs, self._get_func_info())) - - def get_many(self, *args, **kwargs): - t = time.time() - results = self.cache.get_many(*args, **kwargs) - this_time = time.time() - t - self.total_time += this_time * 1000 - self.get_manys += 1 - for key, value in results.iteritems(): - if value is None: - self.misses += 1 - else: - self.hits += 1 - self.calls.append((this_time, 'get_many', args, kwargs, self._get_func_info())) - return results + def __contains__(self, key): + return self.cache.__contains__(key) def make_key(self, *args, **kwargs): return self.cache.make_key(*args, **kwargs) + def validate_key(self, *args, **kwargs): + self.cache.validate_key(*args, **kwargs) + + def clear(self): + return self.cache.clear() + + @send_signal def add(self, *args, **kwargs): return self.cache.add(*args, **kwargs) + @send_signal + def get(self, *args, **kwargs): + return self.cache.get(*args, **kwargs) + + @send_signal + def set(self, *args, **kwargs): + return self.cache.set(*args, **kwargs) + + @send_signal + def delete(self, *args, **kwargs): + return self.cache.delete(*args, **kwargs) + + @send_signal def has_key(self, *args, **kwargs): return self.cache.has_key(*args, **kwargs) + @send_signal def incr(self, *args, **kwargs): return self.cache.incr(*args, **kwargs) + @send_signal def decr(self, *args, **kwargs): return self.cache.decr(*args, **kwargs) - def __contains__(self, key): - return self.cache.__contains__(key) + @send_signal + def get_many(self, *args, **kwargs): + return self.cache.get_many(*args, **kwargs) + @send_signal def set_many(self, *args, **kwargs): self.cache.set_many(*args, **kwargs) + @send_signal def delete_many(self, *args, **kwargs): self.cache.delete_many(*args, **kwargs) - def clear(self): - self.cache.clear() - - def validate_key(self, *args, **kwargs): - self.cache.validate_key(*args, **kwargs) - + @send_signal def incr_version(self, *args, **kwargs): return self.cache.incr_version(*args, **kwargs) + @send_signal def decr_version(self, *args, **kwargs): return self.cache.decr_version(*args, **kwargs) @@ -119,29 +134,86 @@ class CacheDebugPanel(DebugPanel): def __init__(self, *args, **kwargs): super(CacheDebugPanel, self).__init__(*args, **kwargs) - cache.cache.reset() + self.total_time = 0 + self.hits = 0 + self.misses = 0 + self.calls = [] + self.counts = SortedDict(( + ('add', 0), + ('get', 0), + ('set', 0), + ('delete', 0), + ('get_many', 0), + ('set_many', 0), + ('delete_many', 0), + ('has_key', 0), + ('incr', 0), + ('decr', 0), + ('incr_version', 0), + ('decr_version', 0), + )) + cache_called.connect(self._store_call_info) + + def _store_call_info(self, sender, name=None, time_taken=0, + return_value=None, args=None, kwargs=None, trace=None, + template_info=None, backend=None, **kw): + if name == 'get': + if return_value is None: + self.misses += 1 + else: + self.hits += 1 + elif name == 'get_many': + for key, value in return_value.iteritems(): + if value is None: + self.misses += 1 + else: + self.hits += 1 + self.total_time += time_taken * 1000 + self.counts[name] += 1 + self.calls.append({ + 'time': time_taken, + 'name': name, + 'args': args, + 'kwargs': kwargs, + 'trace': render_stacktrace(trace), + 'template_info': template_info, + 'backend': backend + }) def nav_title(self): return _('Cache') def nav_subtitle(self): - cache_calls = len(cache.cache.calls) + cache_calls = len(self.calls) return ungettext('%(cache_calls)d call in %(time).2fms', '%(cache_calls)d calls in %(time).2fms', cache_calls) % {'cache_calls': cache_calls, - 'time': cache.cache.total_time} + 'time': self.total_time} def title(self): - return _('Cache Usage') + count = len(getattr(settings, 'CACHES', ['default'])) + return ungettext('Cache calls from %(count)d backend', + 'Cache calls from %(count)d backends', + count) % dict(count=count) def url(self): return '' def process_response(self, request, response): self.record_stats({ - 'cache_calls': len(cache.cache.calls), - 'cache_time': cache.cache.total_time, - 'cache': cache.cache, + 'total_calls': len(self.calls), + 'calls': self.calls, + 'total_time': self.total_time, + 'hits': self.hits, + 'misses': self.misses, + 'counts': self.counts, }) + +def get_cache_debug(*args, **kwargs): + base_cache = base_get_cache(*args, **kwargs) + return CacheStatTracker(base_cache) + + cache.cache = CacheStatTracker(cache.cache) +cache.get_cache = get_cache_debug |