feat: report environment metrics api #5430

Zaimwa9 · 2025-05-07T15:27:53Z

Thanks for submitting a PR! Please check the boxes below:

I have added information to docs/ if required so people know about the feature!
I have filled in the "Changes" section below?
I have filled in the "How did you test this code" section below?
I have used a Conventional Commit title for this Pull Request

Changes

⚠️ Branch with front/back: feat/report-environment-metrics-frontend

Dark mode with workflows

Light mode without workflows

Aim of this PR is to provide an endpoint returning a set of environment-level metrics:

Total features
Features enabled
Segment override
Open change requests
Scheduled change to come
Created a base metric view nested within environment view
Added specific query-sets for each metrics
New metric service

/api/v1/environments/<environment_api_key>/metrics/	
environments.views.EnvironmentMetricsViewSet	
api-v1:environments:environment-metrics-list

Added environment model methods to aggregate the metrics
Added serializers and service methods

Payload example:

{
    "metrics": [
        {
            "value": 3,
            "description": "Total features",
            "name": "total_features",
            "disabled": false,
            "entity": "features",
            "rank": 1
        },
        {
            "value": 2,
            "description": "Features enabled",
            "name": "enabled_features",
            "disabled": false,
            "entity": "features",
            "rank": 2
        },
        {
            "value": 0,
            "description": "Segment Overrides",
            "name": "segment_overrides",
            "disabled": false,
            "entity": "segments",
            "rank": 3
        },
        {
            "value": 1,
            "description": "Open change requests",
            "name": "open_change_requests",
            "disabled": false,
            "entity": "change_requests",
            "rank": 4
        },
        {
            "value": 1,
            "description": "Total scheduled changes",
            "name": "total_scheduled_changes",
            "disabled": false,
            "entity": "scheduled_changes",
            "rank": 5
        }
    ]
}

How did you test this code?

New tests
Via requests

http://localhost:8000/api/v1/environments/<EnvID>/metrics/

How to

Create segments, add segments to features
Enable / Disable Features
Add identity overrides to features
Create change requests (activating 4 eyes)
Schedule some changes via change requests

Make sure that the displayed metrics reflects reality state

vercel · 2025-05-07T15:27:59Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Skipped Deployments

Name	Status	Preview	Updated (UTC)
docs	⬜️ Ignored (Inspect)	Visit Preview	Jun 6, 2025 9:00am
flagsmith-frontend-preview	⬜️ Ignored (Inspect)	Visit Preview	Jun 6, 2025 9:00am
flagsmith-frontend-staging	⬜️ Ignored (Inspect)	Visit Preview	Jun 6, 2025 9:00am

for more information, see https://pre-commit.ci

github-actions · 2025-05-07T15:28:45Z

Docker builds report

Image	Build Status	Security report
`ghcr.io/flagsmith/flagsmith-e2e:pr-5430`	Finished ✅	Skipped
`ghcr.io/flagsmith/flagsmith-api-test:pr-5430`	Finished ✅	Skipped
`ghcr.io/flagsmith/flagsmith-frontend:pr-5430`	Finished ✅	Results ✅
`ghcr.io/flagsmith/flagsmith-api:pr-5430`	Finished ✅	Results ✅
`ghcr.io/flagsmith/flagsmith:pr-5430`	Finished ✅	Results ✅
`ghcr.io/flagsmith/flagsmith-private-cloud:pr-5430`	Finished ✅	Results ✅

github-actions · 2025-05-07T15:30:51Z

Uffizzi Ephemeral Environment Deploying

☁️ https://app.uffizzi.com/github.com/Flagsmith/flagsmith/pull/5430

⚙️ Updating now by workflow run 14887281399.

What is Uffizzi? Learn more!

github-actions · 2025-05-07T15:30:53Z

Uffizzi Ephemeral Environment Deploying

☁️ https://app.uffizzi.com/github.com/Flagsmith/flagsmith/pull/5430

⚙️ Updating now by workflow run 15320227152.

What is Uffizzi? Learn more!

…h/flagsmith into feat/report-environment-metrics

codecov · 2025-05-07T15:35:56Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.69%. Comparing base (62c6ef5) to head (24fdc04).
Report is 30 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5430      +/-   ##
==========================================
+ Coverage   97.65%   97.69%   +0.04%     
==========================================
  Files        1237     1247      +10     
  Lines       43580    44250     +670     
==========================================
+ Hits        42558    43231     +673     
+ Misses       1022     1019       -3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

api/environments/views.py

api/environments/models.py

api/environments/dynamodb/wrappers/identity_wrapper.py

gagantrivedi · 2025-05-29T09:56:50Z

api/environments/models.py

+        Returns total feature count and enabled-by-default feature count
+        scoped to this environment's project.
+        """
+        from edge_api.identities.models import EdgeIdentity


All these local imports suggest this should be moved to the service layer?

api/environments/models.py

gagantrivedi · 2025-06-05T11:49:50Z

api/environments/models.py

+
+        fs_base_query = (
+            feature_states_qs.values("feature_id", "feature_segment_id")
+            .annotate(latest_id=Max("id"))


Why are we doing Max?

My bad, thanks for catching up, it's a (useless) artifact from before using get_live_feature_states

for more information, see https://pre-commit.ci

Zaimwa9 · 2025-06-06T07:54:02Z

api/tests/unit/environments/test_unit_environments_models.py

+        )
+        version += 1
+
+    for i in range(segment_overrides_count):


Add versions to segments to check version selection

Zaimwa9 added 7 commits May 6, 2025 09:33

feat: implementing-environment-metrics-endpoint

4957701

feat: gathering-segments-and-features-metrics-from-subqueries

0d765d2

feat: implemented-queries-to-fetch-env-metrics

8e66263

feat: handled-change-requests-conditionally

50c54f8

feat: implemented-types-and-tests-on-per-entity-object-model

9cded03

feat: redesigned-payload-as-flat-list-of-metrics

f4e865d

feat: improved-typing

afbd158

Zaimwa9 requested a review from a team as a code owner May 7, 2025 15:27

Zaimwa9 requested review from khvn26 and removed request for a team May 7, 2025 15:27

Zaimwa9 marked this pull request as draft May 7, 2025 15:28

[pre-commit.ci] auto fixes from pre-commit.com hooks

7c6627a

for more information, see https://pre-commit.ci

github-actions bot added the api Issue related to the REST API label May 7, 2025

github-actions bot added the feature New feature or request label May 7, 2025

feat: removed-unused-env-metrics-entities

7830c40

Merge branch 'feat/report-environment-metrics' of github.com:Flagsmit…

7955347

…h/flagsmith into feat/report-environment-metrics

github-actions bot added feature New feature or request and removed feature New feature or request labels May 7, 2025

feat: added-edge-identity-overrides-metric

74ce33a

github-actions bot added feature New feature or request and removed feature New feature or request labels May 8, 2025

feat: updated-metrics-tests

f219849

github-actions bot added feature New feature or request and removed feature New feature or request labels May 8, 2025

feat: added-dynamodb-wrapper-test

559cee7

vercel bot deployed to Preview – docs May 29, 2025 08:56 View deployment

github-actions bot added feature New feature or request and removed feature New feature or request labels May 29, 2025

vercel bot deployed to Preview – flagsmith-frontend-staging May 29, 2025 08:58 View deployment

vercel bot deployed to Preview – flagsmith-frontend-preview May 29, 2025 08:58 View deployment

gagantrivedi requested changes May 29, 2025

View reviewed changes

Zaimwa9 added 2 commits May 30, 2025 15:22

feat: moved-logic-to-metrics-service

dfdd06d

feat: reworked-models-functions-using-get-live-features

50287e1

github-actions bot added feature New feature or request and removed feature New feature or request labels May 30, 2025

Zaimwa9 requested a review from gagantrivedi June 2, 2025 14:37

feat: added-documentation-and-removed-dead-code-path

79346f8

github-actions bot added feature New feature or request and removed feature New feature or request labels Jun 2, 2025

matthewelwell linked an issue Jun 3, 2025 that may be closed by this pull request

Add Reporting on overall Feature Management Program #3827

Closed

Zaimwa9 assigned gagantrivedi Jun 4, 2025

gagantrivedi requested changes Jun 5, 2025

View reviewed changes

Zaimwa9 and others added 2 commits June 6, 2025 09:28

feat: removed-redundant-code

852ca8f

[pre-commit.ci] auto fixes from pre-commit.com hooks

367eafa

for more information, see https://pre-commit.ci

github-actions bot added feature New feature or request and removed feature New feature or request labels Jun 6, 2025

Zaimwa9 commented Jun 6, 2025

View reviewed changes

feat: added-extra-fake-versions-of-feature-states-in-test

24fdc04

github-actions bot removed the feature New feature or request label Jun 6, 2025

Zaimwa9 requested a review from gagantrivedi June 6, 2025 09:01

github-actions bot added the feature New feature or request label Jun 6, 2025

gagantrivedi approved these changes Jun 6, 2025

View reviewed changes

Zaimwa9 merged commit ad1f3c1 into main Jun 6, 2025
30 checks passed

Zaimwa9 deleted the feat/report-environment-metrics branch June 6, 2025 10:59

flagsmithdev mentioned this pull request Jun 5, 2025

chore(main): release 2.183.0 #5539

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: report environment metrics api #5430

feat: report environment metrics api #5430

Uh oh!

Zaimwa9 commented May 7, 2025 •

edited

Loading

Uh oh!

vercel bot commented May 7, 2025 •

edited

Loading

Uh oh!

github-actions bot commented May 7, 2025 •

edited

Loading

Uh oh!

github-actions bot commented May 7, 2025

Uh oh!

github-actions bot commented May 7, 2025 •

edited

Loading

Uh oh!

codecov bot commented May 7, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gagantrivedi May 29, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gagantrivedi Jun 5, 2025

Uh oh!

Zaimwa9 Jun 6, 2025

Uh oh!

Zaimwa9 Jun 6, 2025

Uh oh!

Uh oh!

Uh oh!

feat: report environment metrics api #5430

feat: report environment metrics api #5430

Uh oh!

Conversation

Zaimwa9 commented May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

How did you test this code?

How to

Uh oh!

vercel bot commented May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Docker builds report

Uh oh!

github-actions bot commented May 7, 2025

Uffizzi Ephemeral Environment Deploying

Uh oh!

github-actions bot commented May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uffizzi Ephemeral Environment Deploying

Uh oh!

codecov bot commented May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gagantrivedi May 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gagantrivedi Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

Zaimwa9 Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

Zaimwa9 Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Zaimwa9 commented May 7, 2025 •

edited

Loading

vercel bot commented May 7, 2025 •

edited

Loading

github-actions bot commented May 7, 2025 •

edited

Loading

github-actions bot commented May 7, 2025 •

edited

Loading

codecov bot commented May 7, 2025 •

edited

Loading