Merge pull request #209 from vitalyserhienko/feature-custom-namespaces

configurable metric namespace

Author: asherf

django_prometheus/cache/metrics.py

@@ -1,14 +1,28 @@
 from prometheus_client import Counter
 
+from django_prometheus.conf import NAMESPACE
+
 django_cache_get_total = Counter(
-    "django_cache_get_total", "Total get requests on cache", ["backend"]
+    "django_cache_get_total",
+    "Total get requests on cache",
+    ["backend"],
+    namespace=NAMESPACE,
 )
 django_cache_hits_total = Counter(
-    "django_cache_get_hits_total", "Total hits on cache", ["backend"]
+    "django_cache_get_hits_total",
+    "Total hits on cache",
+    ["backend"],
+    namespace=NAMESPACE,
 )
 django_cache_misses_total = Counter(
-    "django_cache_get_misses_total", "Total misses on cache", ["backend"]
+    "django_cache_get_misses_total",
+    "Total misses on cache",
+    ["backend"],
+    namespace=NAMESPACE,
 )
 django_cache_get_fail_total = Counter(
-    "django_cache_get_fail_total", "Total get request failures by cache", ["backend"]
+    "django_cache_get_fail_total",
+    "Total get request failures by cache",
+    ["backend"],
+    namespace=NAMESPACE,
 )

django_prometheus/conf/__init__.py

@@ -0,0 +1,6 @@
+from django.conf import settings
+
+NAMESPACE = ""
+
+if settings.configured:
+    NAMESPACE = getattr(settings, "PROMETHEUS_METRIC_NAMESPACE", NAMESPACE)

django_prometheus/db/metrics.py

@@ -1,15 +1,19 @@
 from prometheus_client import Counter
 
+from django_prometheus.conf import NAMESPACE
+
 connections_total = Counter(
     "django_db_new_connections_total",
     "Counter of created connections by database and by vendor.",
     ["alias", "vendor"],
+    namespace=NAMESPACE,
 )
 
 connection_errors_total = Counter(
     "django_db_new_connection_errors_total",
     "Counter of connection failures by database and by vendor.",
     ["alias", "vendor"],
+    namespace=NAMESPACE,
 )
 
 execute_total = Counter(
@@ -19,18 +23,21 @@
         " bulk executions."
     ),
     ["alias", "vendor"],
+    namespace=NAMESPACE,
 )
 
 
 execute_many_total = Counter(
     "django_db_execute_many_total",
     ("Counter of executed statements in bulk operations by database and" " by vendor."),
     ["alias", "vendor"],
+    namespace=NAMESPACE,
 )
 
 
 errors_total = Counter(
     "django_db_errors_total",
     ("Counter of execution errors by database, vendor and exception type."),
     ["alias", "vendor", "type"],
+    namespace=NAMESPACE,
 )

django_prometheus/middleware.py

@@ -2,6 +2,7 @@
 
 from django.conf import settings
 from django.utils.deprecation import MiddlewareMixin
+from django_prometheus.conf import NAMESPACE
 from django_prometheus.utils import PowersOf, Time, TimeSince
 
 DEFAULT_LATENCY_BUCKETS = (
@@ -47,11 +48,13 @@ def register(self):
             Counter,
             "django_http_requests_before_middlewares_total",
             "Total count of requests before middlewares run.",
+            namespace=NAMESPACE,
         )
         self.responses_total = self.register_metric(
             Counter,
             "django_http_responses_before_middlewares_total",
             "Total count of responses before middlewares run.",
+            namespace=NAMESPACE,
         )
         self.requests_latency_before = self.register_metric(
             Histogram,
@@ -60,6 +63,7 @@ def register(self):
                 "Histogram of requests processing time (including middleware "
                 "processing time)."
             ),
+            namespace=NAMESPACE,
         )
         self.requests_unknown_latency_before = self.register_metric(
             Counter,
@@ -68,6 +72,7 @@ def register(self):
                 "Count of requests for which the latency was unknown (when computing "
                 "django_http_requests_latency_including_middlewares_seconds)."
             ),
+            namespace=NAMESPACE,
         )
         self.requests_latency_by_view_method = self.register_metric(
             Histogram,
@@ -77,90 +82,107 @@ def register(self):
             buckets=getattr(
                 settings, "PROMETHEUS_LATENCY_BUCKETS", DEFAULT_LATENCY_BUCKETS
             ),
+            namespace=NAMESPACE,
         )
         self.requests_unknown_latency = self.register_metric(
             Counter,
             "django_http_requests_unknown_latency_total",
             "Count of requests for which the latency was unknown.",
+            namespace=NAMESPACE,
         )
         # Set in process_request
         self.requests_ajax = self.register_metric(
-            Counter, "django_http_ajax_requests_total", "Count of AJAX requests."
+            Counter,
+            "django_http_ajax_requests_total",
+            "Count of AJAX requests.",
+            namespace=NAMESPACE,
         )
         self.requests_by_method = self.register_metric(
             Counter,
             "django_http_requests_total_by_method",
             "Count of requests by method.",
             ["method"],
+            namespace=NAMESPACE,
         )
         self.requests_by_transport = self.register_metric(
             Counter,
             "django_http_requests_total_by_transport",
             "Count of requests by transport.",
             ["transport"],
+            namespace=NAMESPACE,
         )
         # Set in process_view
         self.requests_by_view_transport_method = self.register_metric(
             Counter,
             "django_http_requests_total_by_view_transport_method",
             "Count of requests by view, transport, method.",
             ["view", "transport", "method"],
+            namespace=NAMESPACE,
         )
         self.requests_body_bytes = self.register_metric(
             Histogram,
             "django_http_requests_body_total_bytes",
             "Histogram of requests by body size.",
             buckets=PowersOf(2, 30),
+            namespace=NAMESPACE,
         )
         # Set in process_template_response
         self.responses_by_templatename = self.register_metric(
             Counter,
             "django_http_responses_total_by_templatename",
             "Count of responses by template name.",
             ["templatename"],
+            namespace=NAMESPACE,
         )
         # Set in process_response
         self.responses_by_status = self.register_metric(
             Counter,
             "django_http_responses_total_by_status",
             "Count of responses by status.",
             ["status"],
+            namespace=NAMESPACE,
         )
         self.responses_by_status_view_method = self.register_metric(
             Counter,
             "django_http_responses_total_by_status_view_method",
             "Count of responses by status, view, method.",
             ["status", "view", "method"],
+            namespace=NAMESPACE,
         )
         self.responses_body_bytes = self.register_metric(
             Histogram,
             "django_http_responses_body_total_bytes",
             "Histogram of responses by body size.",
             buckets=PowersOf(2, 30),
+            namespace=NAMESPACE,
         )
         self.responses_by_charset = self.register_metric(
             Counter,
             "django_http_responses_total_by_charset",
             "Count of responses by charset.",
             ["charset"],
+            namespace=NAMESPACE,
         )
         self.responses_streaming = self.register_metric(
             Counter,
             "django_http_responses_streaming_total",
             "Count of streaming responses.",
+            namespace=NAMESPACE,
         )
         # Set in process_exception
         self.exceptions_by_type = self.register_metric(
             Counter,
             "django_http_exceptions_total_by_type",
             "Count of exceptions by object type.",
             ["type"],
+            namespace=NAMESPACE,
         )
         self.exceptions_by_view = self.register_metric(
             Counter,
             "django_http_exceptions_total_by_view",
             "Count of exceptions by view.",
             ["view"],
+            namespace=NAMESPACE,
         )
 
 

django_prometheus/migrations.py

@@ -2,17 +2,20 @@
 
 from django.db import connections
 from django.db.backends.dummy.base import DatabaseWrapper
+from django_prometheus.conf import NAMESPACE
 
 unapplied_migrations = Gauge(
     "django_migrations_unapplied_total",
     "Count of unapplied migrations by database connection",
     ["connection"],
+    namespace=NAMESPACE,
 )
 
 applied_migrations = Gauge(
     "django_migrations_applied_total",
     "Count of applied migrations by database connection",
     ["connection"],
+    namespace=NAMESPACE,
 )
 
 

django_prometheus/models.py

@@ -1,15 +1,26 @@
 from prometheus_client import Counter
 
+from django_prometheus.conf import NAMESPACE
+
 model_inserts = Counter(
-    "django_model_inserts_total", "Number of insert operations by model.", ["model"]
+    "django_model_inserts_total",
+    "Number of insert operations by model.",
+    ["model"],
+    namespace=NAMESPACE,
 )
 
 model_updates = Counter(
-    "django_model_updates_total", "Number of update operations by model.", ["model"]
+    "django_model_updates_total",
+    "Number of update operations by model.",
+    ["model"],
+    namespace=NAMESPACE,
 )
 
 model_deletes = Counter(
-    "django_model_deletes_total", "Number of delete operations by model.", ["model"]
+    "django_model_deletes_total",
+    "Number of delete operations by model.",
+    ["model"],
+    namespace=NAMESPACE,
 )