[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:
Relates
relates to SIP2-134 Add /admin/health to edge-sip2 Closed
relates to FOLIO-1880 Standardise Health Check Interface Closed
relates to OKAPI-672 Finish /_/proxy/health Closed
relates to FOLIO-1881 Provide module instance health inform... Draft
relates to OKAPI-995 Okapi should query /admin/health for ... Blocked
Sprint:

 Description   

Overview

All 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"?

Decision

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

Generated at Thu Feb 08 23:21:28 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.