feat: TCP health check integration + ECS health checks on staging #5377

khvn26 · 2025-04-23T20:10:42Z

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

This picks the flagsmith healthcheck command implemented in Flagsmith/flagsmith-common#60 and adds it to ECS task definitions on staging. This is required for service discovery (and metric collection) to work.

How did you test this code?

Tasks now show up as healthy in ECS console:

vercel · 2025-04-23T20:10:46Z

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	Apr 25, 2025 3:44pm
flagsmith-frontend-preview	⬜️ Ignored (Inspect)	Visit Preview	Apr 25, 2025 3:44pm
flagsmith-frontend-staging	⬜️ Ignored (Inspect)	Visit Preview	Apr 25, 2025 3:44pm

github-actions · 2025-04-23T20:11:09Z

Docker builds report

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

github-actions · 2025-04-23T20:12:55Z

Uffizzi Preview deployment-63070 was deleted.

codecov · 2025-04-23T20:22:36Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.61%. Comparing base (8dc92c3) to head (97351c9).
Report is 8 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5377   +/-   ##
=======================================
  Coverage   97.61%   97.61%           
=======================================
  Files        1237     1237           
  Lines       42975    42975           
=======================================
  Hits        41952    41952           
  Misses       1023     1023

☔ 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.

gagantrivedi · 2025-04-24T05:28:22Z

api/scripts/healthcheck.py

-        logger.error(f"Health check failed with status {status_code}")
-
-    sys.exit(0 if 200 >= status_code < 300 else 1)
+    args = parser.parse_args()


Are these TCP health checks only used for service discovery, and only in SaaS environments?

So far, yes — but we'll use them in Helm as well, see https://github.com/Flagsmith/self-hosted/blob/d1d19e77b5f22313024d49faa6e02728652fb721/flagsmith-values.yaml#L15-L22 and https://flagsmith.slack.com/archives/C07G7UAKPNH/p1745340333442389

Re https://flagsmith.slack.com/archives/C07G7UAKPNH/p1745340333442389

Does AWS alb support exec health checks? Think it only supports http?

The health checks added here are for Cloud Map only, and are expected to be run by ECS, which does not support HTTP.

infrastructure/aws/staging/ecs-task-definition-task-processor.json

rolodato · 2025-04-24T13:34:14Z

infrastructure/aws/staging/ecs-task-definition-web.json

+            "healthCheck": {
+                "command": [
+                    "CMD-SHELL",
+                    "python scripts/healthcheck.py"


I would suggest adding an entrypoint command to run-docker.sh such as healthcheck, to abstract ECS/k8s/etc away from needing to know about Python or the path to the healthcheck.py file. That way we can change the healthcheck implementation easily without needing to modify how we're calling it.

This is done in 711218a .

As discussed offline, we are now using flagsmith healthcheck commands.

api/scripts/healthcheck.py

Co-authored-by: Rodrigo López Dato <rodrigo.lopezdato@flagsmith.com>

emyller · 2025-04-25T16:51:56Z

infrastructure/aws/staging/ecs-task-definition-task-processor.json

+            "healthCheck": {
+                "command": [
+                    "CMD-SHELL",
+                    "flagsmith healthcheck tcp"
+                ],
+                "interval": 10,
+                "timeout": 2,
+                "retries": 5,
+                "startPeriod": 5
+            },


@khvn26 Were you able to test this health check in ECS before this reaches production? Sorry I'm late to the party.

Yup, see screenshot evidence in the PR description + Grafana dashboard wouldn't work without these health checks.

emyller

LGTM if the ECS health check works.

khvn26 added 2 commits April 23, 2025 21:07

feat: TCP health check script + ECS health checks on staging

db95bfc

test on staging

9aa137f

khvn26 temporarily deployed to staging April 23, 2025 20:10 — with GitHub Actions Inactive

khvn26 requested a review from a team as a code owner April 23, 2025 20:10

khvn26 requested review from gagantrivedi and removed request for a team April 23, 2025 20:10

khvn26 requested a review from rolodato April 23, 2025 20:10

github-actions bot added api Issue related to the REST API infrastructure feature New feature or request and removed infrastructure labels Apr 23, 2025

khvn26 temporarily deployed to staging April 23, 2025 20:11 — with GitHub Actions Inactive

khvn26 temporarily deployed to staging April 23, 2025 20:17 — with GitHub Actions Inactive

gagantrivedi reviewed Apr 24, 2025

View reviewed changes

rolodato reviewed Apr 24, 2025

View reviewed changes

clarify docs

e6c7b7d

Co-authored-by: Rodrigo López Dato <rodrigo.lopezdato@flagsmith.com>

khvn26 temporarily deployed to staging April 24, 2025 13:59 — with GitHub Actions Inactive

github-actions bot added infrastructure feature New feature or request and removed feature New feature or request infrastructure labels Apr 24, 2025

khvn26 temporarily deployed to staging April 24, 2025 14:00 — with GitHub Actions Inactive

khvn26 had a problem deploying to staging April 24, 2025 14:06 — with GitHub Actions Failure

flagsmith healthcheck

711218a

khvn26 temporarily deployed to staging April 24, 2025 17:23 — with GitHub Actions Inactive

github-actions bot added the infrastructure label Apr 24, 2025

khvn26 temporarily deployed to staging April 25, 2025 15:40 — with GitHub Actions Inactive

github-actions bot added infrastructure feature New feature or request and removed feature New feature or request infrastructure labels Apr 25, 2025

khvn26 temporarily deployed to staging April 25, 2025 15:41 — with GitHub Actions Inactive

formatting

76ce6ee

khvn26 temporarily deployed to staging April 25, 2025 15:42 — with GitHub Actions Inactive

github-actions bot added infrastructure feature New feature or request and removed feature New feature or request infrastructure labels Apr 25, 2025

cleanup

a88b904

khvn26 temporarily deployed to staging April 25, 2025 15:42 — with GitHub Actions Inactive

github-actions bot added infrastructure feature New feature or request and removed feature New feature or request infrastructure labels Apr 25, 2025

khvn26 temporarily deployed to staging April 25, 2025 15:43 — with GitHub Actions Inactive

stop testing on staging

97351c9

github-actions bot added infrastructure feature New feature or request and removed feature New feature or request infrastructure labels Apr 25, 2025

khvn26 changed the title ~~feat: TCP health check script + ECS health checks on staging~~ feat: TCP health check integration + ECS health checks on staging Apr 25, 2025

emyller reviewed Apr 25, 2025

View reviewed changes

emyller approved these changes Apr 25, 2025

View reviewed changes

khvn26 merged commit d4b5d6a into main Apr 25, 2025
38 checks passed

khvn26 deleted the feat/ecs-health-checks branch April 25, 2025 18:05

flagsmithdev mentioned this pull request Apr 25, 2025

chore(main): release 2.176.0 #5386

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: TCP health check integration + ECS health checks on staging #5377

feat: TCP health check integration + ECS health checks on staging #5377

khvn26 commented Apr 23, 2025 •

edited

Loading

vercel bot commented Apr 23, 2025 •

edited

Loading

github-actions bot commented Apr 23, 2025 •

edited

Loading

github-actions bot commented Apr 23, 2025 •

edited

Loading

codecov bot commented Apr 23, 2025 •

edited

Loading

gagantrivedi Apr 24, 2025

khvn26 Apr 24, 2025

gagantrivedi Apr 24, 2025

khvn26 Apr 24, 2025

rolodato Apr 24, 2025

khvn26 Apr 24, 2025 •

edited

Loading

emyller Apr 25, 2025

khvn26 Apr 25, 2025

emyller left a comment

feat: TCP health check integration + ECS health checks on staging #5377

feat: TCP health check integration + ECS health checks on staging #5377

Conversation

khvn26 commented Apr 23, 2025 • edited Loading

Changes

How did you test this code?

vercel bot commented Apr 23, 2025 • edited Loading

github-actions bot commented Apr 23, 2025 • edited Loading

Docker builds report

github-actions bot commented Apr 23, 2025 • edited Loading

codecov bot commented Apr 23, 2025 • edited Loading

Codecov Report

gagantrivedi Apr 24, 2025

Choose a reason for hiding this comment

khvn26 Apr 24, 2025

Choose a reason for hiding this comment

gagantrivedi Apr 24, 2025

Choose a reason for hiding this comment

khvn26 Apr 24, 2025

Choose a reason for hiding this comment

rolodato Apr 24, 2025

Choose a reason for hiding this comment

khvn26 Apr 24, 2025 • edited Loading

Choose a reason for hiding this comment

emyller Apr 25, 2025

Choose a reason for hiding this comment

khvn26 Apr 25, 2025

Choose a reason for hiding this comment

emyller left a comment

Choose a reason for hiding this comment

khvn26 commented Apr 23, 2025 •

edited

Loading

vercel bot commented Apr 23, 2025 •

edited

Loading

github-actions bot commented Apr 23, 2025 •

edited

Loading

github-actions bot commented Apr 23, 2025 •

edited

Loading

codecov bot commented Apr 23, 2025 •

edited

Loading

khvn26 Apr 24, 2025 •

edited

Loading