feat(generic-metrics): Add generic metrics interface

src/sentry/sentry_metrics/metrics_interface.py

@@ -0,0 +1,61 @@
+from abc import ABC, abstractmethod
+from typing import Mapping, Optional, Sequence, Union
+
+from sentry.sentry_metrics.use_case_id_registry import UseCaseID
+
+
+class GenericMetricsBackend(ABC):
+ @abstractmethod
+ def counter(
+ self,
+ use_case_id: UseCaseID,
+ org_id: int,
+ project_id: int,
+ metric_name: str,
+ value: Union[int, float],
+ unit: Optional[str],
+ tags: Mapping[str, str],
+ ) -> None:
+
+ """
+ Used for emitting a counter metric. Ensure that the use_case_id
+ passed in has been registered in the UseCaseID enum.
+ """
+
+ raise NotImplementedError()
+
+ @abstractmethod
+ def set(
+ self,
+ use_case_id: UseCaseID,
+ org_id: int,
+ project_id: int,
+ metric_name: str,
+ value: Sequence[int],
+ unit: Optional[str],
+ tags: Mapping[str, str],
+ ) -> None:
+
+ """
+ Used for emitting a set metric. Can support a sequence of values.
+ Ensure that the use_case_id passed in has been registered in the UseCaseID enum.
+ """
+ raise NotImplementedError()
+
+ @abstractmethod
+ def distribution(
+ self,
+ use_case_id: UseCaseID,
+ org_id: int,
+ project_id: int,
+ metric_name: str,
+ value: Sequence[Union[int, float]],
+ unit: Optional[str],
+ tags: Mapping[str, str],
+ ) -> None:
+
+ """
+ Used for emitting a distribution metric. Can support a sequence of values.
+ Ensure that the use_case_id passed in has been registered in the UseCaseID enum.
+ """
+ raise NotImplementedError()

src/sentry/sentry_metrics/use_case_id_registry.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+from enum import Enum
+from typing import Mapping
+
+from sentry.sentry_metrics.configuration import UseCaseKey
+
+
+class UseCaseID(Enum):
+ PERFORMANCE = "performance"
+ RELEASE_HEALTH = "release-health"
+
+
+# UseCaseKey will be renamed to MetricPathKey
+METRIC_PATH_MAPPING: Mapping[UseCaseID, UseCaseKey] = {
+ UseCaseID.RELEASE_HEALTH: UseCaseKey.RELEASE_HEALTH,
+ UseCaseID.PERFORMANCE: UseCaseKey.PERFORMANCE,
+}
+
+
+def get_metric_path_from_usecase(use_case: UseCaseID) -> UseCaseKey:
+ return METRIC_PATH_MAPPING[use_case]
+
+
+NAMESPACE_MAPPING: Mapping[UseCaseID, str] = {
+ UseCaseID.RELEASE_HEALTH: "sessions",
+ UseCaseID.PERFORMANCE: "transactions",
+}
+
+
+def get_namespace_from_usecase(use_case: UseCaseID) -> str:
+ if use_case in NAMESPACE_MAPPING:
+ return NAMESPACE_MAPPING[use_case]
+
+ return use_case.value
+
+
+def get_usecase_from_namespace(namespace: str) -> UseCaseID:
+ for use_case in NAMESPACE_MAPPING:
+ if NAMESPACE_MAPPING[use_case] == namespace:
+ return use_case
+
+ return UseCaseID(namespace)