fix(detector): change dump data structure

Author: Kl0ven

commitlint.config.js

@@ -8,7 +8,8 @@ const scope = [
   "metrics",
   "panic",
   "sentry-api",
-  "graph"
+  "graph",
+  "detector"
 ];
 
 module.exports = {

controller/sentry/admin.py

@@ -83,37 +83,34 @@ def get_chart_data(self, sentry_id):
         threshold = project.detection_param["threshold"]
 
         options = settings.DEFAULT_GRAPH_OPTION
+        labels, series, signal, avg_filter, std_filter = list(zip(*project.detection_result))
         data = {
             "datasets": [
                 {
                     "label": "Series",
                     "backgroundColor": "#36a2eb",
                     "borderColor": "#36a2eb",
-                    "data": project.detection_result["series"],
+                    "data": series,
                     "yAxisID": "series",
                 },
                 {
                     "label": "Signal",
                     "backgroundColor": "#ff6384",
                     "borderColor": "#ff6384",
-                    "data": project.detection_result["signal"],
+                    "data": signal,
                     "yAxisID": "signal",
                 },
                 {
                     "label": "Threshold",
                     "backgroundColor": "#9966ff",
                     "borderColor": "#9966ff",
                     "data": [
-                        avg_filter + threshold * std_filter
-                        for avg_filter, std_filter in zip(
-                            project.detection_result["avg_filter"],
-                            project.detection_result["std_filter"],
-                        )
+                        avg_filter + threshold * std_filter for avg_filter, std_filter in zip(avg_filter, std_filter)
                     ],
                     "yAxisID": "series",
                 },
             ],
-            "labels": project.detection_result["intervals"],
+            "labels": labels,
         }
         return data, options
 

controller/sentry/detector.py

@@ -71,15 +71,15 @@ def from_project(cls, project: Project) -> "SpikesDetector":
         """
         return cls(**project.detection_param)
 
-    def compute_sentry(self, stats: dict) -> tuple[OrderedDict, dict[str, list]]:
+    def compute_sentry(self, stats: dict) -> tuple[OrderedDict, list[tuple[str, int, int, float, float]]]:
         """Method to compute from a sentry stats dict.
 
         Args:
             stats (dict): The Sentry Stats
 
         Returns:
             OrderedDict: Annotated signal
-            dict[str, list]: Full algorithm results
+            list[tuple[str, int, int, float, float]]: Full algorithm results
 
         Raises:
             SentryNoOutcomeException: When there is no series with accepted outcome
@@ -93,14 +93,11 @@ def compute_sentry(self, stats: dict) -> tuple[OrderedDict, dict[str, list]]:
 
         signal, avg_filter, std_filter = self.compute(series)
 
-        annotated_result = OrderedDict((date, signal) for date, signal in zip(stats["intervals"], signal))
-        dump = {
-            "signal": signal,
-            "avg_filter": avg_filter,
-            "std_filter": std_filter,
-            "series": series,
-            "intervals": stats["intervals"],
-        }
+        annotated_result = OrderedDict((date, sig) for date, sig in zip(stats["intervals"], signal))
+        dump = []
+        for data in zip(stats["intervals"], series, signal, avg_filter, std_filter):
+            dump.append(data)
+
         return annotated_result, dump
 
     def compute(self, data) -> tuple[list[int], list[float], list[float]]:

controller/sentry/tests/data/example-1/expected.json

@@ -120,7 +120,7 @@
   "2023-02-06T15:00:00Z": 1,
   "2023-02-06T16:00:00Z": 1,
   "2023-02-06T17:00:00Z": 0,
-  "2023-02-06T18:00:00Z": 1,
+  "2023-02-06T18:00:00Z": 0,
   "2023-02-06T19:00:00Z": 0,
   "2023-02-06T20:00:00Z": 0,
   "2023-02-06T21:00:00Z": 0,
@@ -136,7 +136,7 @@
   "2023-02-07T07:00:00Z": 0,
   "2023-02-07T08:00:00Z": 0,
   "2023-02-07T09:00:00Z": 0,
-  "2023-02-07T10:00:00Z": 1,
+  "2023-02-07T10:00:00Z": 0,
   "2023-02-07T11:00:00Z": 0,
   "2023-02-07T12:00:00Z": 0,
   "2023-02-07T13:00:00Z": 0,

controller/sentry/tests/test_admin.py

@@ -400,13 +400,10 @@ def test_project_chart_no_context(super_call: Mock, admin_with_user):
 def test_project_chart(super_call: Mock, admin_with_user):
     site, request = admin_with_user
     project = Project(sentry_id="123")
-    project.detection_result = {
-        "signal": [0, 1],
-        "avg_filter": [0, 1],
-        "std_filter": [0, 2],
-        "series": [0, 5],
-        "intervals": ["a", "b"],
-    }
+    project.detection_result = [
+        ("a", 0, 0, 0, 0),
+        ("b", 5, 1, 1, 2),
+    ]
     project.save()
     super_call.return_value = MockResponse(context_data=True)
     response = site.change_view(request, project.sentry_id)
@@ -420,14 +417,14 @@ def test_project_chart(super_call: Mock, admin_with_user):
                         "label": "Series",
                         "backgroundColor": "#36a2eb",
                         "borderColor": "#36a2eb",
-                        "data": [0, 5],
+                        "data": (0, 5),
                         "yAxisID": "series",
                     },
                     {
                         "label": "Signal",
                         "backgroundColor": "#ff6384",
                         "borderColor": "#ff6384",
-                        "data": [0, 1],
+                        "data": (0, 1),
                         "yAxisID": "signal",
                     },
                     {
@@ -438,7 +435,7 @@ def test_project_chart(super_call: Mock, admin_with_user):
                         "yAxisID": "series",
                     },
                 ],
-                "labels": ["a", "b"],
+                "labels": ("a", "b"),
             },
             "options": settings.DEFAULT_GRAPH_OPTION,
         }

controller/settings.py

@@ -329,7 +329,7 @@
 DEFAULT_SPIKE_DETECTION_PARAM = {
     "lag": int(os.getenv("SPIKE_DETECTION_LAG", "48")),
     "threshold": int(os.getenv("SPIKE_DETECTION_THRESHOLD", "5")),
-    "influence": float(os.getenv("SPIKE_DETECTION_INFLUENCE", "0")),
+    "influence": float(os.getenv("SPIKE_DETECTION_INFLUENCE", "0.01")),
 }