aboutsummaryrefslogtreecommitdiffstats
path: root/debug_toolbar/panels/cache.py
blob: cb608d0a4f456fbaa03543969e309074aa975987 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
import time
import inspect
import sys

from django.core import cache
from django.core.cache.backends.base import BaseCache
from django.utils.translation import ugettext_lazy as _, ungettext
from debug_toolbar.panels import DebugPanel


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 make_key(self, *args, **kwargs):
        return self.cache.make_key(*args, **kwargs)

    def add(self, *args, **kwargs):
        return self.cache.add(*args, **kwargs)

    def has_key(self, *args, **kwargs):
        return self.cache.has_key(*args, **kwargs)

    def incr(self, *args, **kwargs):
        return self.cache.incr(*args, **kwargs)

    def decr(self, *args, **kwargs):
        return self.cache.decr(*args, **kwargs)

    def __contains__(self, key):
        return self.cache.__contains__(key)

    def set_many(self, *args, **kwargs):
        self.cache.set_many(*args, **kwargs)

    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)

    def incr_version(self, *args, **kwargs):
        return self.cache.incr_version(*args, **kwargs)

    def decr_version(self, *args, **kwargs):
        return self.cache.decr_version(*args, **kwargs)


class CacheDebugPanel(DebugPanel):
    """
    Panel that displays the cache statistics.
    """
    name = 'Cache'
    template = 'debug_toolbar/panels/cache.html'
    has_content = True

    def __init__(self, *args, **kwargs):
        super(CacheDebugPanel, self).__init__(*args, **kwargs)
        cache.cache.reset()

    def nav_title(self):
        return _('Cache: %.2fms') % cache.cache.total_time

    def nav_subtitle(self):
        cache_calls = len(cache.cache.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}

    def title(self):
        return _('Cache Usage')

    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,
        })

cache.cache = CacheStatTracker(cache.cache)