Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TOP-2] Add endpoint for health checking #3270

Closed
tuxpiper opened this issue Sep 1, 2018 · 3 comments
Closed

[TOP-2] Add endpoint for health checking #3270

tuxpiper opened this issue Sep 1, 2018 · 3 comments

Comments

@tuxpiper
Copy link
Member

tuxpiper commented Sep 1, 2018

For load balancers to properly operate with the API, it's necessary to have a designated health check endpoint. In its most basic form, this can be a simple route that simply returns "OK" (or { "health": "OK" } if we are so inclined to have JSON everywhere). What matters to the load balancer is the HTTP response status (usually 200 is expected)

The trick in our case is this: the load balancer will not provide any hostname in the HTTP request (remember HTTP version 1.0?). This means that the request will be handled by the default virtual host in nginx , and that the PHP code will not receive any hostname header. This is relevant for our platform cloud hosting, where we always expect to know if the request is coming for deployment1.ushahidi.io or deployment2.ushahidi.io .

The health check route can't depend on any of that.

USH-642

@tuxpiper
Copy link
Member Author

tuxpiper commented Sep 1, 2018

@rowasc this is the health check endpoint issue that I mentioned yesterday.

@rowasc rowasc added Codebase: API Indicates issue work will be in API Devops Theme: SaaS labels Jun 12, 2019
@rowasc
Copy link
Contributor

rowasc commented Jun 25, 2019

was this done? 🤔

@tuxpiper
Copy link
Member Author

@rowasc nope, not that I know of

@rowasc rowasc added this to the Parking Lot milestone Sep 4, 2020
@tuxpiper tuxpiper changed the title Add endpoint for health checking [USH-642] Add endpoint for health checking Jul 27, 2023
@tuxpiper tuxpiper changed the title [USH-642] Add endpoint for health checking [TOP-2] Add endpoint for health checking Jul 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants