Skip to content
This repository has been archived by the owner on Dec 22, 2023. It is now read-only.

Add status check / health check endpoint #264

Closed
cheungpat opened this issue Jan 17, 2017 · 0 comments
Closed

Add status check / health check endpoint #264

cheungpat opened this issue Jan 17, 2017 · 0 comments
Assignees

Comments

@cheungpat
Copy link
Contributor

cheungpat commented Jan 17, 2017

For cloud deployment and self-hosted installation, a status check / health check endpoint will allow the infrastructure to check the server status for readiness and/or to kill if it becomes unavailable.

I am going to propose that we add such endpoint at /_status/healthz that returns HTTP response with a status code that correspond to the status of the server:

  • when starting up: return 503
  • when plugin is ready/when there is no plugin: return 200

For older version of skygear-server, he URL will be served by HomeHandler and will always return 200 when requested.

The handler should work with GET request, the respond body is undefined.

@cheungpat cheungpat self-assigned this Jan 17, 2017
cheungpat added a commit to cheungpat/skygear-server that referenced this issue Jan 17, 2017
The healthz endpoint checks if the server is ready to serve request.
This endpoint can be used by cloud deployment or self-hosted
installations to check the status of the server.

refs SkygearIO#264
rickmak pushed a commit that referenced this issue Jan 17, 2017
The healthz endpoint checks if the server is ready to serve request.
This endpoint can be used by cloud deployment or self-hosted
installations to check the status of the server.

refs #264
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant