feat: report environment metrics api

api/app/settings/common.py

@@ -123,6 +123,7 @@
     "projects.tags",
     "api_keys",
     "webhooks",
+    "metrics",
     "onboarding",
     # 2FA
     "custom_auth.mfa.trench",

api/environments/dynamodb/wrappers/identity_wrapper.py

@@ -193,3 +193,12 @@ def get_segment_ids(
             return [segment.id for segment in segments]
 
         return []
+
+    def get_identity_overrides_count(self, environment_api_key: str) -> int:
+        return sum(
+            len(identity["identity_features"])
+            for identity in self.iter_all_items_paginated(
+                environment_api_key=environment_api_key,
+                overrides_only=True,
+            )
+        )

api/environments/models.py

@@ -2,12 +2,13 @@
 import typing
 import uuid
 from copy import deepcopy
+from typing import TYPE_CHECKING, Literal
 
 from django.conf import settings
 from django.contrib.contenttypes.fields import GenericRelation
 from django.core.cache import caches
 from django.db import models
-from django.db.models import Prefetch, Q
+from django.db.models import Max, Prefetch, Q, QuerySet
 from django.utils import timezone
 from django_lifecycle import (  # type: ignore[import-untyped]
     AFTER_CREATE,
@@ -57,6 +58,10 @@
 )
 from webhooks.models import AbstractBaseExportableWebhookModel
 
+if TYPE_CHECKING:
+    from features.workflows.core.models import ChangeRequest
+
+
 logger = logging.getLogger(__name__)
 
 environment_cache = caches[settings.ENVIRONMENT_CACHE_NAME]
@@ -196,6 +201,10 @@ def __str__(self):  # type: ignore[no-untyped-def]
     def natural_key(self):  # type: ignore[no-untyped-def]
         return (self.api_key,)
 
+    @property
+    def is_workflow_enabled(self) -> bool:
+        return self.minimum_change_request_approvals is not None
+
     def clone(
         self,
         name: str,
@@ -358,6 +367,77 @@ def get_feature_state(
             )
         )
 
+    def get_identity_overrides_queryset(self) -> QuerySet[FeatureState]:
+        ids = self._get_active_feature_states_ids(
+            "identity_id",
+            {"identity__isnull": False, "feature_segment__isnull": True},
+        )
+        result: QuerySet[FeatureState] = FeatureState.objects.filter(id__in=ids)
+        return result
+
+    def _get_active_feature_states_ids(
+        self,
+        extra_group_by_fields: Literal["identity_id"] | None = None,
+        filter_kwargs: dict[str, typing.Any] | None = None,
+    ) -> list[int]:
+        base_qs = FeatureState.objects.get_live_feature_states(
+            environment=self,
+            **(filter_kwargs or {}),
+        )
+
+        group_fields = ["feature_id"]
+        if extra_group_by_fields is not None:
+            group_fields.append(extra_group_by_fields)
+
+        return list(
+            base_qs.values(*group_fields)
+            .annotate(id=Max("id"))
+            .values_list("id", flat=True)
+        )
+
+    def get_features_metrics_queryset(self) -> QuerySet[FeatureState]:
+        ids = self._get_active_feature_states_ids(
+            None,
+            {"identity__isnull": True, "feature_segment__isnull": True},
+        )
+        result: QuerySet[FeatureState] = FeatureState.objects.filter(id__in=ids)
+        return result
+
+    def _get_latest_segment_state_ids_subquery(self) -> list[int]:
+        feature_states_qs = FeatureState.objects.get_live_feature_states(
+            environment=self,
+            additional_filters=Q(
+                identity_id__isnull=True,
+                feature_segment_id__isnull=False,
+            ),
+        ).values_list("id", flat=True)
+
+        return list(feature_states_qs)
+
+    def get_segment_metrics_queryset(self) -> QuerySet[FeatureState]:
+        ids = self._get_latest_segment_state_ids_subquery()
+        result: QuerySet[FeatureState] = FeatureState.objects.filter(id__in=ids)
+        return result
+
+    def get_change_requests_metrics_queryset(self) -> QuerySet["ChangeRequest"]:
+        from features.workflows.core.models import ChangeRequest
+
+        result: QuerySet["ChangeRequest"] = ChangeRequest.objects.filter(
+            environment=self,
+            committed_at__isnull=True,
+            deleted_at__isnull=True,
+        )
+        return result
+
+    def get_scheduled_metrics_queryset(self) -> QuerySet[FeatureState]:
+        result: QuerySet[FeatureState] = FeatureState.objects.filter(
+            environment=self,
+            identity_id__isnull=True,
+            feature_segment__isnull=True,
+            live_from__gt=timezone.now(),
+        )
+        return result
+
     @staticmethod
     def is_bad_key(environment_key: str) -> bool:
         return (

api/environments/permissions/views.py

@@ -52,7 +52,7 @@ def perform_update(self, serializer):  # type: ignore[no-untyped-def]
 
 class UserPermissionGroupEnvironmentPermissionsViewSet(viewsets.ModelViewSet):  # type: ignore[type-arg]
     pagination_class = None
-    permission_classes = [IsAuthenticated, NestedEnvironmentPermissions]
+    permission_classes = [IsAuthenticated]
 
     def get_queryset(self):  # type: ignore[no-untyped-def]
         if getattr(self, "swagger_fake_view", False):

api/environments/urls.py

@@ -31,7 +31,12 @@
     UserEnvironmentPermissionsViewSet,
     UserPermissionGroupEnvironmentPermissionsViewSet,
 )
-from .views import EnvironmentAPIKeyViewSet, EnvironmentViewSet, WebhookViewSet
+from .views import (
+    EnvironmentAPIKeyViewSet,
+    EnvironmentMetricsViewSet,
+    EnvironmentViewSet,
+    WebhookViewSet,
+)
 
 router = routers.DefaultRouter()
 router.register(r"", EnvironmentViewSet, basename="environment")
@@ -46,6 +51,9 @@
 environments_router.register(
     r"webhooks", WebhookViewSet, basename="environment-webhooks"
 )
+environments_router.register(
+    r"metrics", EnvironmentMetricsViewSet, basename="environment-metrics"
+)
 environments_router.register(
     r"featurestates",
     EnvironmentFeatureStateViewSet,

api/environments/views.py

@@ -1,5 +1,5 @@
 import logging
-from typing import Generic, Type, TypeVar
+from typing import Any, Generic, Type, TypeVar
 
 from common.environments.permissions import (
     TAG_SUPPORTED_PERMISSIONS,
@@ -17,6 +17,7 @@
 from rest_framework.request import Request
 from rest_framework.response import Response
 from rest_framework.serializers import BaseSerializer
+from rest_framework.viewsets import GenericViewSet
 
 from core.models import AbstractBaseExportableModel
 from environments.permissions.permissions import (
@@ -30,6 +31,8 @@
     disable_v2_versioning,
     enable_v2_versioning,
 )
+from metrics.metrics_service import EnvironmentMetricsService
+from metrics.serializers import EnvironmentMetricsSerializer
 from permissions.permissions_calculator import get_environment_permission_data
 from permissions.serializers import (
     PermissionModelSerializer,
@@ -358,3 +361,22 @@ class EnvironmentAPIKeyViewSet(
     pagination_class = None
     permission_classes = [IsAuthenticated, EnvironmentAdminPermission]
     model_class: Type[EnvironmentAPIKey] = EnvironmentAPIKey
+
+
+class EnvironmentMetricsViewSet(GenericViewSet[Environment]):
+    permission_classes = [IsAuthenticated, EnvironmentPermissions]
+    lookup_field = "api_key"
+    lookup_url_kwarg = "environment_api_key"
+    serializer_class: type[BaseSerializer[Any]] = EnvironmentMetricsSerializer
+    queryset = Environment.objects.all()
+
+    @swagger_auto_schema(  # type: ignore[misc]
+        operation_description="Get metrics for this environment.",
+        responses={200: openapi.Response("Metrics", EnvironmentMetricsSerializer)},
+    )
+    def list(self, request: Request, *args: Any, **kwargs: Any) -> Response:
+        environment: Environment = self.get_object()
+        metrics_service = EnvironmentMetricsService(environment)
+        metrics = metrics_service.get_metrics_payload()
+        serializer = self.get_serializer({"metrics": metrics})
+        return Response(serializer.data, status=status.HTTP_200_OK)

api/metrics/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class MetricsAppConfig(AppConfig):
+    name = "metrics"

api/metrics/constants.py

@@ -0,0 +1,56 @@
+from metrics.types import EnvMetricsEntities, EnvMetricsName, MetricDefinition
+
+TOTAL_FEATURES: MetricDefinition = {
+    "name": EnvMetricsName.TOTAL_FEATURES,
+    "description": "Total features",
+    "entity": EnvMetricsEntities.FEATURES,
+    "rank": 1,
+}
+
+ENABLED_FEATURES: MetricDefinition = {
+    "name": EnvMetricsName.ENABLED_FEATURES,
+    "description": "Features enabled",
+    "entity": EnvMetricsEntities.FEATURES,
+    "rank": 2,
+}
+
+SEGMENT_OVERRIDES: MetricDefinition = {
+    "name": EnvMetricsName.SEGMENT_OVERRIDES,
+    "description": "Segment overrides",
+    "entity": EnvMetricsEntities.SEGMENTS,
+    "rank": 3,
+}
+
+IDENTITY_OVERRIDES: MetricDefinition = {
+    "name": EnvMetricsName.IDENTITY_OVERRIDES,
+    "description": "Identity overrides",
+    "entity": EnvMetricsEntities.IDENTITIES,
+    "rank": 4,
+}
+
+OPEN_CHANGE_REQUESTS: MetricDefinition = {
+    "name": EnvMetricsName.OPEN_CHANGE_REQUESTS,
+    "description": "Open change requests",
+    "entity": EnvMetricsEntities.WORKFLOWS,
+    "rank": 5,
+}
+
+TOTAL_SCHEDULED_CHANGES: MetricDefinition = {
+    "name": EnvMetricsName.TOTAL_SCHEDULED_CHANGES,
+    "description": "Scheduled changes",
+    "entity": EnvMetricsEntities.WORKFLOWS,
+    "rank": 6,
+}
+
+
+DEFAULT_METRIC_DEFINITIONS: list[MetricDefinition] = [
+    TOTAL_FEATURES,
+    ENABLED_FEATURES,
+    SEGMENT_OVERRIDES,
+    IDENTITY_OVERRIDES,
+]
+
+WORKFLOW_METRIC_DEFINITIONS: list[MetricDefinition] = [
+    OPEN_CHANGE_REQUESTS,
+    TOTAL_SCHEDULED_CHANGES,
+]