Merge pull request #9 from crane-cloud/fx-prome-filters

Add prometheus filter validator

Author: khalifan-kfan

app/controllers/app.py

@@ -5,7 +5,7 @@
 from app.helpers.authenticate import (
     jwt_required
 )
-from app.helpers.utils import get_app_data
+from app.helpers.utils import get_app_data, is_valid_prometheus_query
 
 
 class AppUsageView(Resource):
@@ -26,6 +26,11 @@ def post(self, resource):
         namespace = app.namespace
         prometheus = Prometheus()
 
+        if step:
+            is_valid, message = is_valid_prometheus_query(step, start, end)
+            if not is_valid:
+                return dict(status='fail', message=message), 400
+
         try:
             if resource == 'cpu':
                 prom_data = prometheus.query_rang(

app/controllers/project.py

@@ -1,7 +1,7 @@
 import json
 from prometheus_http_client import Prometheus
 from flask_restful import Resource, request
-from app.helpers.utils import get_project_data
+from app.helpers.utils import get_project_data,is_valid_prometheus_query
 
 from app.helpers.authenticate import (
     jwt_required
@@ -25,6 +25,11 @@ def post(self, resource):
         namespace = project.namespace
         prometheus = Prometheus()
 
+        if step:
+            is_valid, message = is_valid_prometheus_query(step, start, end)
+            if not is_valid:
+                return dict(status='fail', message=message), 400
+
         try:
             if resource == 'cpu':
                 prom_data = prometheus.query_rang(

app/helpers/utils.py

@@ -3,6 +3,7 @@
 import datetime
 from app.schemas import MetricsSchema
 from types import SimpleNamespace
+import re
 
 PRODUCT_BASE_URL = os.getenv('PRODUCT_BASE_URL')
 PROJECT_ENDPOINT = f"{PRODUCT_BASE_URL}/projects"
@@ -106,3 +107,46 @@ def get_app_data(request):
         namespace=project_data.namespace,
         status_code=200
     )
+
+
+
+# default mx data points for prometheus
+MAX_DATA_POINTS = 11000
+STEP_UNITS_IN_SECONDS = {
+    "s": 1,
+    "m": 60,
+    "h": 3600,
+    "d": 86400,
+    "w": 604800,
+}
+
+def parse_step_to_seconds(step: str) -> int:
+    """
+    Parses a Prometheus step string like '1m', '2h', '4d' into seconds.
+    """
+    match = re.match(r"^(\d+)([smhdw])$", step)
+    if not match:
+        raise ValueError("Invalid step format. Use formats like 30s, 5m, 2h, 1d.")
+    value, unit = match.groups()
+    return int(value) * STEP_UNITS_IN_SECONDS[unit]
+
+def is_valid_prometheus_query(step: str, start_ts: int, end_ts: int) -> (bool, str):
+    """
+    Validates if the number of points in a Prometheus query is within the allowed range.
+    """
+    try:
+        step_seconds = parse_step_to_seconds(step)
+    except ValueError as e:
+        return False, str(e)
+    
+    if start_ts >= end_ts:
+        return False, "Start timestamp must be less than end timestamp."
+    
+    total_duration = end_ts - start_ts
+    num_points = total_duration // step_seconds
+
+    if num_points > MAX_DATA_POINTS:
+        return False, f"Query returns {num_points} points, which exceeds the limit of {MAX_DATA_POINTS}. Increase the step or reduce the time range."
+    
+    return True, f"Query valid: {num_points} data points."
+