Merge pull request #46 from jiayuan929/fix_metric

feat: 支持不采集特定路径的 Metric 指标

Author: jiayuan929

backend/common/middlewares.py

@@ -22,6 +22,7 @@
 
 from django.conf import settings
 from django.utils.deprecation import MiddlewareMixin
+from django_prometheus.middleware import PrometheusAfterMiddleware
 
 from common.log import logger
 from common.utils.xss.escape_function import html_escape, texteditor_escape, url_escape
@@ -140,3 +141,14 @@ def __filter_path_list(self):
         }
         use_texteditor_paths = {}
         return (use_url_paths, use_texteditor_paths)
+
+
+class PrometheusAfterWithExclusionMiddleware(PrometheusAfterMiddleware, MiddlewareMixin):
+    """自定义指标中间件，排除特定路径的指标统计"""
+
+    def process_response(self, request, response):
+        """处理响应时跳过指定路径"""
+        # 排除 /console/ping/ 和 /console/healthz/ 路径的 Metric 指标统计
+        if request.path in ['/console/ping/', '/console/healthz/']:
+            return response
+        return super().process_response(request, response)

backend/conf/default.py

@@ -127,7 +127,8 @@ def minimum_database_version(self):
     "bk_i18n.middlewares.LanguageMiddleware",
     "bk_i18n.middlewares.TimezoneMiddleware",
     "common.middlewares.CheckXssMiddleware",
-    "django_prometheus.middleware.PrometheusAfterMiddleware",
+    # 继承 django_prometheus.middleware.PrometheusAfterMiddleware 中间件，并添加路径豁免功能
+    "common.middlewares.PrometheusAfterWithExclusionMiddleware",
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
 ]