🧪 scaffold experiment detector

Author: leeandher

src/sentry/issues/grouptype.py

@@ -339,6 +339,16 @@ class PerformanceNPlusOneAPICallsGroupType(GroupType):
     released = True
 
 
+@dataclass(frozen=True)
+class PerformanceNPlusOneAPICallsExperimentalGroupType(GroupType):
+    type_id = 1910
+    slug = "performance_n_plus_one_api_calls_experimental"
+    description = "N+1 API Call (Experimental)"
+    category = GroupCategory.PERFORMANCE.value
+    default_priority = PriorityLevel.LOW
+    released = False
+
+
 @dataclass(frozen=True)
 class PerformanceMNPlusOneDBQueriesGroupType(PerformanceGroupTypeDefaults, GroupType):
     type_id = 1011

src/sentry/notifications/utils/__init__.py

@@ -21,6 +21,7 @@
 from sentry.integrations.services.integration import integration_service
 from sentry.issues.grouptype import (
     PerformanceConsecutiveDBQueriesGroupType,
+    PerformanceNPlusOneAPICallsExperimentalGroupType,
     PerformanceNPlusOneAPICallsGroupType,
     PerformanceRenderBlockingAssetSpanGroupType,
 )
@@ -336,7 +337,7 @@ def occurrence_perf_to_email_html(context: Any) -> str:
 
 
 def get_spans(
-    entries: list[dict[str, list[dict[str, str | float]] | str]]
+    entries: list[dict[str, list[dict[str, str | float]] | str]],
 ) -> list[dict[str, str | float]] | None:
     """Get the given event's spans"""
     if not len(entries):
@@ -496,7 +497,10 @@ def from_problem_and_spans(
         spans: list[dict[str, str | float]] | None,
         event: Event | None = None,
     ) -> PerformanceProblemContext:
-        if problem.type == PerformanceNPlusOneAPICallsGroupType:
+        if problem.type in (
+            PerformanceNPlusOneAPICallsGroupType,
+            PerformanceNPlusOneAPICallsExperimentalGroupType,
+        ):
             return NPlusOneAPICallProblemContext(problem, spans, event)
         if problem.type == PerformanceConsecutiveDBQueriesGroupType:
             return ConsecutiveDBQueriesProblemContext(problem, spans, event)

src/sentry/utils/performance_issues/detectors/experiments/__init__.py

@@ -8,14 +8,11 @@
 from typing import Any
 from urllib.parse import urlparse
 
-from sentry.issues.grouptype import PerformanceNPlusOneAPICallsGroupType
+from sentry.issues.grouptype import PerformanceNPlusOneAPICallsExperimentalGroupType
 from sentry.issues.issue_occurrence import IssueEvidence
 from sentry.models.organization import Organization
 from sentry.models.project import Project
-from sentry.utils.performance_issues.detectors.utils import get_total_span_duration
-from sentry.utils.performance_issues.performance_problem import PerformanceProblem
-
-from ..base import (
+from sentry.utils.performance_issues.base import (
     DetectorType,
     PerformanceDetector,
     fingerprint_http_spans,
@@ -25,12 +22,14 @@
     parameterize_url,
     parameterize_url_with_result,
 )
-from ..types import PerformanceProblemsMap, Span
+from sentry.utils.performance_issues.detectors.utils import get_total_span_duration
+from sentry.utils.performance_issues.performance_problem import PerformanceProblem
+from sentry.utils.performance_issues.types import PerformanceProblemsMap, Span
 
 logger = logging.getLogger(__name__)
 
 
-class DummyNPlusOneAPICallsDetector(PerformanceDetector):
+class NPlusOneAPICallsExperimentalDetector(PerformanceDetector):
     """
     Detect parallel network calls to the same endpoint.
 
@@ -54,7 +53,7 @@ def __init__(self, settings: dict[DetectorType, Any], event: dict[str, Any]) ->
         self.spans: list[Span] = []
 
     def visit_span(self, span: Span) -> None:
-        if not DummyNPlusOneAPICallsDetector.is_span_eligible(span):
+        if not NPlusOneAPICallsExperimentalDetector.is_span_eligible(span):
             return
 
         op = span.get("op", None)
@@ -171,7 +170,7 @@ def _maybe_store_problem(self) -> None:
             fingerprint=fingerprint,
             op=last_span["op"],
             desc=problem_description,
-            type=PerformanceNPlusOneAPICallsGroupType,
+            type=PerformanceNPlusOneAPICallsExperimentalGroupType,
             cause_span_ids=[],
             parent_span_ids=[last_span.get("parent_span_id", None)],
             offender_span_ids=offender_span_ids,
@@ -243,7 +242,7 @@ def _fingerprint(self) -> str | None:
 
         fingerprint = fingerprint_http_spans([self.spans[0]])
 
-        return f"1-{PerformanceNPlusOneAPICallsGroupType.type_id}-{fingerprint}"
+        return f"1-{PerformanceNPlusOneAPICallsExperimentalGroupType.type_id}-{fingerprint}"
 
     def _spans_are_concurrent(self, span_a: Span, span_b: Span) -> bool:
         span_a_start: int = span_a.get("start_timestamp", 0) or 0

src/sentry/utils/performance_issues/detectors/dummy_n_plus_one_api_calls_detector.py renamed to src/sentry/utils/performance_issues/detectors/experiments/n_plus_one_api_calls_detector.py

@@ -14,9 +14,7 @@
 from sentry.issues.issue_occurrence import IssueEvidence
 from sentry.models.organization import Organization
 from sentry.models.project import Project
-from sentry.utils.performance_issues.detectors.utils import get_total_span_duration
-
-from ..base import (
+from sentry.utils.performance_issues.base import (
     DetectorType,
     PerformanceDetector,
     fingerprint_http_spans,
@@ -25,8 +23,9 @@
     get_url_from_span,
     parameterize_url,
 )
-from ..performance_problem import PerformanceProblem
-from ..types import PerformanceProblemsMap, Span
+from sentry.utils.performance_issues.detectors.utils import get_total_span_duration
+from sentry.utils.performance_issues.performance_problem import PerformanceProblem
+from sentry.utils.performance_issues.types import PerformanceProblemsMap, Span
 
 
 class NPlusOneAPICallsDetector(PerformanceDetector):

src/sentry/utils/performance_issues/detectors/n_plus_one_api_calls_detector.py

@@ -22,7 +22,9 @@
 from .base import DetectorType, PerformanceDetector
 from .detectors.consecutive_db_detector import ConsecutiveDBSpanDetector
 from .detectors.consecutive_http_detector import ConsecutiveHTTPSpanDetector
-from .detectors.dummy_n_plus_one_api_calls_detector import DummyNPlusOneAPICallsDetector
+from .detectors.experiments.n_plus_one_api_calls_detector import (
+    NPlusOneAPICallsExperimentalDetector,
+)
 from .detectors.http_overhead_detector import HTTPOverheadDetector
 from .detectors.io_main_thread_detector import DBMainThreadDetector, FileIOMainThreadDetector
 from .detectors.large_payload_detector import LargeHTTPPayloadDetector
@@ -323,7 +325,7 @@ def get_detection_settings(project_id: int | None = None) -> dict[DetectorType,
     NPlusOneDBSpanDetectorExtended,
     FileIOMainThreadDetector,
     NPlusOneAPICallsDetector,
-    DummyNPlusOneAPICallsDetector,
+    NPlusOneAPICallsExperimentalDetector,
     MNPlusOneDBSpanDetector,
     UncompressedAssetSpanDetector,
     LargeHTTPPayloadDetector,