Design API Health Check Endpoints

[jack-h-wang]

User Story

As an RS engineer, I want to be able to surface version and other health information so that it is available to aid in issue diagnoses.

Description/Use Case

We need a mechanism to determine the version information for the function app and microservices. We should design an endpoint from which the app can report its own version to the requester.

Risks/Impacts/Considerations

Dev Notes

• The approach taken should be unified between the function app and microservices.
• Consider the type of information that should be returned by the endpoint. The Version object currently only contains the Git commit hash but more information could be included (e.g. build date, system uptime, memory use).
• We should expect to retire the version.json file currently being generated during the build in favor of this solution. Make certain there is a method to view version information for deployment verification. (Consider working with frontend?)

Acceptance Criteria

• [ ] A design and implementation for a Health check endpoint is created
  • [ ] Include security considerations in the design doc
• [ ] Update deployment doc to reflect new process for version checking

[arnejduranovic]

Hey team! Please add your planning poker estimate with Zenhub @adegolier @david-navapbc @jack-h-wang @jalbinson @JFisk42 @mkalish

[thetaurean]

Hey team! Please add your planning poker estimate with Zenhub @adegolier @arnejduranovic @jack-h-wang @jalbinson @JFisk42 @david-navapbc