feat: Switch existing task processor health checks to new liveness probe #5161

khvn26 · 2025-02-25T12:53:27Z

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 accommodates for changes introduced in Flagsmith/flagsmith-task-processor#25 by intercepting python manage.py checktaskprocessorthreadhealth command and redirecting it to new liveness probe introduced in #5151.

How did you test this code?

Ran python manage.py checktaskprocessorthreadhealth and made sure the correct HTTP call is made.

vercel · 2025-02-25T12:53:35Z

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	Mar 4, 2025 7:33pm
flagsmith-frontend-preview	⬜️ Ignored (Inspect)	Visit Preview	Mar 4, 2025 7:33pm
flagsmith-frontend-staging	⬜️ Ignored (Inspect)	Visit Preview	Mar 4, 2025 7:33pm

github-actions · 2025-02-25T12:53:59Z

Docker builds report

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

github-actions · 2025-02-25T12:55:49Z

Uffizzi Preview deployment-61312 was deleted.

codecov · 2025-02-25T13:05:26Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.49%. Comparing base (edbd3fa) to head (e9e5a41).
Report is 3 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5161      +/-   ##
==========================================
+ Coverage   97.47%   97.49%   +0.02%     
==========================================
  Files        1224     1223       -1     
  Lines       42590    42581       -9     
==========================================
+ Hits        41515    41516       +1     
+ Misses       1075     1065      -10

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

rolodato · 2025-02-25T14:48:12Z

api/scripts/healthcheck.py


-sys.exit(0 if 200 >= status < 300 else 1)
+def main() -> None:


Can we add a deprecation warning when this is being used? In case we need to troubleshoot other customer deployments that have similar issues, this could tell us immediately if they are using the old style healthchecks or not.

I understand this code is only ever called by Docker Compose healthchecks, which should be removed.

Otherwise LGTM 👍

I am slightly concerned with the deprecation warning that's been added here since, if I understand correctly, anyone invoking python manage.py checktaskprocessorthreadhealth will also see this confusing deprecation warning.

I think that could be anyone who explicitly uses the management command, but more likely anyone that updates the flagsmith version without updating their chart version?

Valid point. I've reworked the warning to be more descriptive.

rolodato · 2025-02-25T16:27:10Z

@khvn26 Added 236df86 to remove healthchecks from Docker Compose, and bake them directly into the Dockerfile. I understand this should only be used automatically by Compose, and not ECS, Kubernetes or other orchestrators.

matthewelwell · 2025-03-03T17:23:51Z

api/scripts/healthcheck.py


-sys.exit(0 if 200 >= status < 300 else 1)
+def main() -> None:


I am slightly concerned with the deprecation warning that's been added here since, if I understand correctly, anyone invoking python manage.py checktaskprocessorthreadhealth will also see this confusing deprecation warning.

I think that could be anyone who explicitly uses the management command, but more likely anyone that updates the flagsmith version without updating their chart version?

khvn26 requested a review from a team as a code owner February 25, 2025 12:53

khvn26 requested review from gagantrivedi and removed request for a team February 25, 2025 12:53

github-actions bot added the api Issue related to the REST API label Feb 25, 2025

khvn26 requested a review from rolodato February 25, 2025 12:53

github-actions bot added the feature New feature or request label Feb 25, 2025

khvn26 mentioned this pull request Feb 25, 2025

Expose readiness/liveness probes Flagsmith/flagsmith-task-processor#24

Open

rolodato reviewed Feb 25, 2025

View reviewed changes

khvn26 requested a review from rolodato February 25, 2025 15:54

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

rolodato approved these changes Feb 25, 2025

View reviewed changes

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

khvn26 requested a review from a team as a code owner February 26, 2025 21:19

khvn26 requested review from kyle-ssg and removed request for a team February 26, 2025 21:19

github-actions bot added front-end Issue related to the React Front End Dashboard feature New feature or request and removed feature New feature or request labels Feb 26, 2025

github-actions bot added docs Documentation updates feature New feature or request and removed feature New feature or request docs Documentation updates labels Feb 28, 2025

matthewelwell approved these changes Mar 3, 2025

View reviewed changes

github-actions bot added docs Documentation updates feature New feature or request and removed feature New feature or request docs Documentation updates labels Mar 4, 2025

khvn26 and others added 12 commits March 4, 2025 19:30

feat: Switch existing task processor health checks to new liveness probe

bf0ad04

improve coverage, add deprecation warning

701ba0d

Remove legacy healthcheck from Compose, use new check in Dockerfile

4897c55

Add curl to API runtime Docker image

6177b09

use task processor with server

dfeb86e

huh?

f8b99c4

fix entrypoint

438a0a7

fix coverage

a72b7e1

update docs

afb3ba5

switch to released task-processor

ef84c90

bump task-processor to 1.3.1

149033a

improve deprecated health check warning

ac086b4

khvn26 force-pushed the feat/adapt-removed-task-processor-health-cmd branch from a7cf5ed to ac086b4 Compare March 4, 2025 19:30

github-actions bot added the docs Documentation updates label Mar 4, 2025

Merge branch 'main' into feat/adapt-removed-task-processor-health-cmd

e9e5a41

github-actions bot added feature New feature or request and removed feature New feature or request docs Documentation updates labels Mar 4, 2025

khvn26 merged commit 647712c into main Mar 5, 2025
38 checks passed

khvn26 deleted the feat/adapt-removed-task-processor-health-cmd branch March 5, 2025 10:14

flagsmithdev mentioned this pull request Mar 5, 2025

chore(main): release 2.167.0 #5186

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Switch existing task processor health checks to new liveness probe #5161

feat: Switch existing task processor health checks to new liveness probe #5161

khvn26 commented Feb 25, 2025 •

edited

Loading

vercel bot commented Feb 25, 2025 •

edited

Loading

github-actions bot commented Feb 25, 2025 •

edited

Loading

github-actions bot commented Feb 25, 2025 •

edited

Loading

codecov bot commented Feb 25, 2025 •

edited

Loading

rolodato Feb 25, 2025

khvn26 Feb 25, 2025

matthewelwell Mar 3, 2025

khvn26 Mar 4, 2025

rolodato commented Feb 25, 2025

matthewelwell Mar 3, 2025


		sys.exit(0 if 200 >= status < 300 else 1)
		def main() -> None:

feat: Switch existing task processor health checks to new liveness probe #5161

feat: Switch existing task processor health checks to new liveness probe #5161

Conversation

khvn26 commented Feb 25, 2025 • edited Loading

Changes

How did you test this code?

vercel bot commented Feb 25, 2025 • edited Loading

github-actions bot commented Feb 25, 2025 • edited Loading

Docker builds report

github-actions bot commented Feb 25, 2025 • edited Loading

codecov bot commented Feb 25, 2025 • edited Loading

Codecov Report

rolodato Feb 25, 2025

Choose a reason for hiding this comment

khvn26 Feb 25, 2025

Choose a reason for hiding this comment

matthewelwell Mar 3, 2025

Choose a reason for hiding this comment

khvn26 Mar 4, 2025

Choose a reason for hiding this comment

rolodato commented Feb 25, 2025

matthewelwell Mar 3, 2025

Choose a reason for hiding this comment

khvn26 commented Feb 25, 2025 •

edited

Loading

vercel bot commented Feb 25, 2025 •

edited

Loading

github-actions bot commented Feb 25, 2025 •

edited

Loading

github-actions bot commented Feb 25, 2025 •

edited

Loading

codecov bot commented Feb 25, 2025 •

edited

Loading