Merge pull request #218 from alisoam/add-db-query-duration

Add db query duration metric

Author: asherf

django_prometheus/db/__init__.py

@@ -6,6 +6,7 @@
     errors_total,
     execute_many_total,
     execute_total,
+    query_duration_seconds,
 )
 
 __all__ = [
@@ -15,4 +16,5 @@
     "errors_total",
     "execute_many_total",
     "execute_total",
+    "query_duration_seconds",
 ]

django_prometheus/db/common.py

@@ -4,6 +4,7 @@
     errors_total,
     execute_many_total,
     execute_total,
+    query_duration_seconds,
 )
 
 
@@ -57,21 +58,23 @@ def ExportingCursorWrapper(cursor_class, alias, vendor):
     vendor name.
     """
 
+    labels = {"alias": alias, "vendor": vendor}
+
     class CursorWrapper(cursor_class):
         """Extends the base CursorWrapper to count events."""
 
         def execute(self, *args, **kwargs):
             execute_total.labels(alias, vendor).inc()
-            with ExceptionCounterByType(
-                errors_total, extra_labels={"alias": alias, "vendor": vendor}
+            with query_duration_seconds.labels(**labels).time(), (
+                ExceptionCounterByType(errors_total, extra_labels=labels)
             ):
                 return super(CursorWrapper, self).execute(*args, **kwargs)
 
         def executemany(self, query, param_list, *args, **kwargs):
             execute_total.labels(alias, vendor).inc(len(param_list))
             execute_many_total.labels(alias, vendor).inc(len(param_list))
-            with ExceptionCounterByType(
-                errors_total, extra_labels={"alias": alias, "vendor": vendor}
+            with query_duration_seconds.labels(**labels).time(), (
+                ExceptionCounterByType(errors_total, extra_labels=labels)
             ):
                 return super(CursorWrapper, self).executemany(
                     query, param_list, *args, **kwargs

django_prometheus/db/metrics.py

@@ -1,4 +1,4 @@
-from prometheus_client import Counter
+from prometheus_client import Counter, Histogram
 
 from django_prometheus.conf import NAMESPACE
 
@@ -41,3 +41,10 @@
     ["alias", "vendor", "type"],
     namespace=NAMESPACE,
 )
+
+query_duration_seconds = Histogram(
+    "django_db_query_duration_seconds",
+    ("Histogram of query duration by database and vendor."),
+    ["alias", "vendor"],
+    namespace=NAMESPACE,
+)

django_prometheus/tests/end2end/testapp/test_db.py

@@ -62,6 +62,29 @@ def testCounters(self):
             >= 200
         )
 
+    def testHistograms(self):
+        cursor_db1 = connections["test_db_1"].cursor()
+        cursor_db2 = connections["test_db_2"].cursor()
+        cursor_db1.execute("SELECT 1")
+        for _ in range(200):
+            cursor_db2.execute("SELECT 2")
+        assert (
+            self.getMetric(
+                "django_db_query_duration_seconds_count",
+                alias="test_db_1",
+                vendor="sqlite",
+            )
+            > 0
+        )
+        assert (
+            self.getMetric(
+                "django_db_query_duration_seconds_count",
+                alias="test_db_2",
+                vendor="sqlite",
+            )
+            >= 200
+        )
+
     def testExecuteMany(self):
         registry = self.saveRegistry()
         cursor_db1 = connections["test_db_1"].cursor()