➕ [#538] Add django-silk for performance profiling

Author: stevenbal

requirements/dev.in

@@ -8,6 +8,8 @@ bump-my-version
 # Debug tooling
 django-debug-toolbar
 django-extensions
+django-silk
+whitenoise
 
 # Documentation
 sphinx

requirements/dev.txt

@@ -42,6 +42,8 @@ attrs==20.3.0
     #   -r requirements/ci.txt
     #   glom
     #   jsonschema
+autopep8==2.3.2
+    # via django-silk
 babel==2.16.0
     # via
     #   -c requirements/ci.txt
@@ -206,6 +208,7 @@ django==4.2.19
     #   django-sendfile2
     #   django-sessionprofile
     #   django-setup-configuration
+    #   django-silk
     #   django-simple-certmanager
     #   django-solo
     #   django-two-factor-auth
@@ -326,6 +329,8 @@ django-setup-configuration==0.7.1
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   open-api-framework
+django-silk==5.3.2
+    # via -r requirements/dev.in
 django-simple-certmanager==1.4.1
     # via
     #   -c requirements/ci.txt
@@ -448,6 +453,8 @@ glom==23.5.0
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   mozilla-django-oidc-db
+gprof2dot==2024.6.6
+    # via django-silk
 h11==0.14.0
     # via httpcore
 httpcore==1.0.7
@@ -637,6 +644,7 @@ pycodestyle==2.12.1
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
+    #   autopep8
     #   flake8
 pycparser==2.20
     # via
@@ -881,6 +889,7 @@ sqlparse==0.5.0
     #   -r requirements/ci.txt
     #   django
     #   django-debug-toolbar
+    #   django-silk
 tblib==1.7.0
     # via
     #   -c requirements/ci.txt
@@ -975,6 +984,8 @@ webtest==2.0.35
     #   django-webtest
 wheel==0.42.0
     # via pip-tools
+whitenoise==6.9.0
+    # via -r requirements/dev.in
 wrapt==1.14.1
     # via
     #   -c requirements/ci.txt

src/objects/conf/dev.py

@@ -102,6 +102,15 @@
     r"django\.db\.models\.fields",
 )
 
+#
+# DJANGO-SILK
+#
+if config("PROFILE", default=False, add_to_docs=False):
+    INSTALLED_APPS += ["silk"]
+    MIDDLEWARE = ["silk.middleware.SilkyMiddleware"] + MIDDLEWARE
+    security_index = MIDDLEWARE.index("django.middleware.security.SecurityMiddleware")
+    MIDDLEWARE.insert(security_index + 1, "whitenoise.middleware.WhiteNoiseMiddleware")
+
 if "test" in sys.argv:
     NOTIFICATIONS_DISABLED = True
 

src/objects/urls.py

@@ -79,3 +79,7 @@
     urlpatterns = [
         path("__debug__/", include(debug_toolbar.urls)),
     ] + urlpatterns
+
+
+if apps.is_installed("silk"):
+    urlpatterns += [path(r"silk/", include("silk.urls", namespace="silk"))]