aboutsummaryrefslogtreecommitdiffstats
path: root/debug_toolbar/panels/timer.py
blob: 7c0febf89ac5065e1b4cad4f9cb62c35e52ef70a (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
try:
    import resource
except ImportError:
    pass # Will fail on Win32 systems
import time
from django.template.loader import render_to_string
from django.utils.translation import ugettext_lazy as _
from debug_toolbar.panels import DebugPanel


class TimerDebugPanel(DebugPanel):
    """
    Panel that displays the time a response took in milliseconds.
    """
    name = 'Timer'
    template = 'debug_toolbar/panels/timer.html'
    try: # if resource module not available, don't show content panel
        resource
    except NameError:
        has_content = False
        has_resource = False
    else:
        has_content = True
        has_resource = True
    
    def process_request(self, request):
        self._start_time = time.time()
        if self.has_resource:
            self._start_rusage = resource.getrusage(resource.RUSAGE_SELF)
    
    def process_response(self, request, response):
        total_time = (time.time() - self._start_time) * 1000
        if self.has_resource:
            self._end_rusage = resource.getrusage(resource.RUSAGE_SELF)
        
        utime = 1000 * self._elapsed_ru('ru_utime')
        stime = 1000 * self._elapsed_ru('ru_stime')
        vcsw = self._elapsed_ru('ru_nvcsw')
        ivcsw = self._elapsed_ru('ru_nivcsw')
        minflt = self._elapsed_ru('ru_minflt')
        majflt = self._elapsed_ru('ru_majflt')
# these are documented as not meaningful under Linux.  If you're running BSD
# feel free to enable them, and add any others that I hadn't gotten to before
# I noticed that I was getting nothing but zeroes and that the docs agreed. :-(
#
#        blkin = self._elapsed_ru('ru_inblock')
#        blkout = self._elapsed_ru('ru_oublock')
#        swap = self._elapsed_ru('ru_nswap')
#        rss = self._end_rusage.ru_maxrss
#        srss = self._end_rusage.ru_ixrss
#        urss = self._end_rusage.ru_idrss
#        usrss = self._end_rusage.ru_isrss
        
        self.record_stats({
            'total_time': total_time,
            'utime': utime,
            'stime': stime,
            'vcsw': vcsw,
            'ivcsw': ivcsw,
            'minflt': minflt,
            'majflt': majflt,
#            'blkin': blkin,
#            'blkout': blkout,
#            'swap': swap,
#            'rss': rss,
#            'urss': urss,
#            'srss': srss,
#            'usrss': usrss,
        })
    
    def nav_title(self):
        return _('Time')
    
    def nav_subtitle(self):
        stats = self.get_stats()
        
        # TODO l10n
        if self.has_resource:
            utime = self._end_rusage.ru_utime - self._start_rusage.ru_utime
            stime = self._end_rusage.ru_stime - self._start_rusage.ru_stime
            return 'CPU: %0.2fms (%0.2fms)' % ((utime + stime) * 1000.0, stats['total_time'])
        else:
            return 'TOTAL: %0.2fms' % (stats['total_time'])
    
    def title(self):
        return _('Resource Usage')
    
    def url(self):
        return ''
    
    def _elapsed_ru(self, name):
        return getattr(self._end_rusage, name) - getattr(self._start_rusage, name)
    
    def content(self):
        stats = self.get_stats()
        
        # TODO l10n on values
        rows = (
            (_('User CPU time'), '%0.3f msec' % stats['utime']),
            (_('System CPU time'), '%0.3f msec' % stats['stime']),
            (_('Total CPU time'), '%0.3f msec' % (stats['utime'] + stats['stime'])),
            (_('Elapsed time'), '%0.3f msec' % stats['total_time']),
            (_('Context switches'), '%d voluntary, %d involuntary' % (stats['vcsw'], stats['ivcsw'])),
#            ('Memory use', '%d max RSS, %d shared, %d unshared' % (stats['rss'], stats.['srss'],
#                                                                   stats['urss'] + stats['usrss'])),
#            ('Page faults', '%d no i/o, %d requiring i/o' % (stats['minflt'], stats['majflt'])),
#            ('Disk operations', '%d in, %d out, %d swapout' % (stats['blkin'], stats['blkout'], stats['swap'])),
        )
        
        context = self.context.copy()
        context.update({'rows': rows,})
        return render_to_string(self.template, context)