[FOLIO-2550] Consider requiring modules to have a GET /admin/health endpoint Created: 01/Apr/20 Updated: 03/Dec/22 Resolved: 26/Oct/21 |
|
| Status: | Closed |
| Project: | FOLIO |
| Components: | None |
| Affects versions: | None |
| Fix versions: | None |
| Type: | Task | Priority: | P3 |
| Reporter: | Craig McNally | Assignee: | Unassigned |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original estimate: | Not Specified | ||
| Issue links: |
|
||||||||||||||||||||||||
| Sprint: | |||||||||||||||||||||||||
| Description |
OverviewAll modules that are built on RMB get a health check endpoint for free: GET /admin/health. This helps with hosting as it's a convenient way to determine basic container health (is the container up and accessible via HTTP?) However, modules that aren't developed using RMB sometimes provide non-standard health check endpoints, or don't provide one at all. Should we consider making it a requirement that all modules implement a standard GET /admin/health endpoint that returns "OK"? DecisionThe health check endpoint must be provided at the path /admin/health The endpoint must respond with a status code 200 The response may include a body of any form See https://folio-org.atlassian.net/wiki/display/DD/Back+End+Module+Health+Check+Protocol |
| Comments |
| Comment by Julian Ladisch [ 26/Oct/21 ] |
|
Craig McNally Does returning "OK" means that the reply has a 200 (=OK) HTTP status code and the body is ignored, or that the body consists of the two characters OK and the HTTP status code is ignored, or that the body consists of the four characters "OK" and the HTTP status code is ignored? |
| Comment by Craig McNally [ 26/Oct/21 ] |
|
Julian Ladisch I think this is out of date. See: https://folio-org.atlassian.net/wiki/display/DD/Back+End+Module+Health+Check+Protocol |
| Comment by Julian Ladisch [ 26/Oct/21 ] |
|
Thanks, I've updated the description with the decision and close this Jira. |