Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Page Properties


Status

Status
colourGreen
titleDONE

Stakeholders

Back End Developers, System Operators

Outcome

All back end modules included in 2021 R2 or later must provide a health check endpoint

Created date

  

Owner

Marc Johnson Oleksandr_Dekin (for Spring Way implementation guidance)



Note
titleNOTICE

This decision has been migrated to the Technical Council's Decision Log as part of a consolidation effort.  See:   DR-000007 - Back End Module Health Check Protocol


Context

Need

System operators need to be able to understand if a module instance is healthy enough to be able to participate in the system. FOLIO needs a standard way of allowing operators to determine this.

...

John Malconian has proposed that instead of the "health" endpoint, two endpoints: for readiness and liveness check. See the proposal here:

Jira Legacy
serverSystem JiraJIRA
serverId01505d01-b853-3c2e-90f1-ee9b165564fc
keyOKAPI-904
. The proposal has been implemented in Okapi but has not seen much uptake.

...

The response may include a body of any form

...

Rationale

This topic was discussed at the /wiki/spaces/TLG/pages/754372.

...

Related JIRAs

  • Jira Legacy
    serverSystem JiraJIRA
    columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId01505d01-b853-3c2e-90f1-ee9b165564fc
    keyMSEARCH-65