Track and display middleware time in the toolbar

debug_toolbar/middleware.py

@@ -5,6 +5,7 @@
 import re
 import socket
 from functools import cache
+from time import perf_counter
 
 from asgiref.sync import iscoroutinefunction, markcoroutinefunction
 from django.conf import settings
@@ -78,6 +79,8 @@ def __init__(self, get_response):
             markcoroutinefunction(self)
 
     def __call__(self, request):
+        # Start tracking middleware execution time
+        toolbar_start_time = perf_counter()
         # Decide whether the toolbar is active for this request.
         if self.async_mode:
             return self.__acall__(request)
@@ -98,10 +101,14 @@ def __call__(self, request):
             # regardless of the response. Keep 'return' clauses below.
             for panel in reversed(toolbar.enabled_panels):
                 panel.disable_instrumentation()
+            toolbar_end_time = perf_counter()
+            toolbar.toolbar_time = (toolbar_end_time - toolbar_start_time) * 1000
 
         return self._postprocess(request, response, toolbar)
 
     async def __acall__(self, request):
+        # Start tracking middleware execution time
+        toolbar_start_time = perf_counter()
         # Decide whether the toolbar is active for this request.
         show_toolbar = get_show_toolbar()
         if not show_toolbar(request) or DebugToolbar.is_toolbar_request(request):
@@ -125,6 +132,8 @@ async def __acall__(self, request):
             # regardless of the response. Keep 'return' clauses below.
             for panel in reversed(toolbar.enabled_panels):
                 panel.disable_instrumentation()
+            toolbar_end_time = perf_counter()
+            toolbar.middleware_time = (toolbar_end_time - toolbar_start_time) * 1000
 
         return self._postprocess(request, response, toolbar)
 

debug_toolbar/panels/timer.py

@@ -45,6 +45,10 @@ def content(self):
             (_("System CPU time"), _("%(stime)0.3f msec") % stats),
             (_("Total CPU time"), _("%(total)0.3f msec") % stats),
             (_("Elapsed time"), _("%(total_time)0.3f msec") % stats),
+            (
+                _("Toolbar time"),
+                _("%(toolbar_time)0.3f msec") % stats,
+            ),
             (
                 _("Context switches"),
                 _("%(vcsw)d voluntary, %(ivcsw)d involuntary") % stats,
@@ -90,6 +94,8 @@ def generate_stats(self, request, response):
             #        stats['urss'] = self._end_rusage.ru_idrss
             #        stats['usrss'] = self._end_rusage.ru_isrss
 
+        # Add toolbar time to stats
+        stats["toolbar_time"] = self.toolbar.toolbar_time
         self.record_stats(stats)
 
     def generate_server_timing(self, request, response):
@@ -101,6 +107,9 @@ def generate_server_timing(self, request, response):
         self.record_server_timing(
             "total_time", "Elapsed time", stats.get("total_time", 0)
         )
+        self.record_server_timing(
+            "toolbar_time", "Toolbar time", stats.get("toolbar_time", 0)
+        )
 
     def _elapsed_ru(self, name):
         return getattr(self._end_rusage, name) - getattr(self._start_rusage, name)

debug_toolbar/toolbar.py

@@ -47,6 +47,7 @@ def __init__(self, request, get_response):
         self.stats = {}
         self.server_timing_stats = {}
         self.store_id = None
+        self.toolbar_time = 0
         self._created.send(request, toolbar=self)
 
     # Manage panels

docs/changes.rst

@@ -9,6 +9,7 @@ Pending
 * Converted to Django Commons PyPI release process.
 * Fixed a crash which occurred when using non-``str`` static file values.
 * Documented experimental async support.
+* Added toolbar time to the timer panel.
 
 5.0.0-alpha (2024-09-01)
 ------------------------

tests/test_integration.py

@@ -605,6 +605,7 @@ def test_server_timing_headers(self):
             r'TimerPanel_stime;dur=(\d)*(\.(\d)*)?;desc="System CPU time", ',
             r'TimerPanel_total;dur=(\d)*(\.(\d)*)?;desc="Total CPU time", ',
             r'TimerPanel_total_time;dur=(\d)*(\.(\d)*)?;desc="Elapsed time", ',
+            r'TimerPanel_toolbar_time;dur=(\d)*(\.(\d)*)?;desc="Toolbar time", ',
             r'SQLPanel_sql_time;dur=(\d)*(\.(\d)*)?;desc="SQL 1 queries", ',
             r'CachePanel_total_time;dur=0;desc="Cache 0 Calls"',
         ]