Merge pull request #19 from tiwariav/master

Middlewares to show django-silk profiling data for all requests

Author: vtemian

requirements.dev.txt

@@ -1,4 +1,4 @@
-Django==3.2.5
+Django==3.2.6
 attrs==21.2.0
 pluggy==0.13.1
 py==1.10.0
@@ -7,3 +7,5 @@ pytest-cov==2.12.1
 pytest-django==4.4.0
 pytz==2021.1
 six==1.16.0
+# replace with pip when v4.1.1 is available for django-silk on pip
+git+https://github.com/jazzband/django-silk.git#egg=django-silk  # https://github.com/jazzband/django-silk

server_timing/middleware.py

@@ -22,11 +22,15 @@ def add_service(service):
 
 
 class TimedService(object):
-    def __init__(self, name, description=''):
+    def __init__(self, name, description="", duration=None):
         self.name = name
         self.description = description
+        self._duration = duration
         self._start = self._end = None
 
+        if self._duration:
+            add_service(self)
+
     def start(self):
         self._start = time.time()
         add_service(self)
@@ -36,6 +40,8 @@ def end(self):
 
     @property
     def duration(self):
+        if not self._start and self._duration:
+            return self._duration
         return int(((self._end or time.time()) - self._start) * 1000)
 
 

server_timing/silk.py

@@ -0,0 +1,47 @@
+from .middleware import TimedService, timed
+
+class ServerTimingSilkMiddleware:
+    """
+    This middleware will measure the response time for each request,
+    and also the time taken for sql queries, if silk is enabled.
+    """
+    def __init__(self, get_response):
+        self.get_response = get_response
+
+    def _get_query_timing(self, request):
+        try:
+            from silk.collector import DataCollector
+            from silk.profiling.profiler import silk_meta_profiler, silk_profile
+        except ModuleNotFoundError:
+            return
+        if not hasattr(request, 'silk_is_intercepted'):
+            return
+        with silk_meta_profiler():
+            collector = DataCollector()
+            silk_request = collector.request
+            if silk_request:
+                TimedService(
+                    name="sql",
+                    description="DB Queries",
+                    duration=sum([s.time_taken for s in silk_request.queries.all()]),
+                )
+
+    def __call__(self, request):
+        with timed("request-response", "Request Response"):
+            response = self.get_response(request)
+        self._get_query_timing(request)
+        return response
+
+
+class ServerTimingSilkViewOnlyMiddleware:
+    """
+    This middleware would be put as the last middleware, to measure the
+    response time of only the underlying view.
+    """
+    def __init__(self, get_response):
+        self.get_response = get_response
+
+    def __call__(self, request):
+        with timed("request-view", "Request View"):
+            response = self.get_response(request)
+        return response