add a default health check endpoint at /healthz
#4291
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
creates a health check endpoint at
/healthz
if the application hasthe
okcomputer
gem installed. this gets us:we choose
OkComputer
for the framework for this endpoint due to the ease ofextension, and due to an existing install base in parts of the community. we
should be able to source a reasonable set of default health checks from existing
code with relatively minor effort.
we'll want to extend this to check Fedora and Solr connections, and maybe
certain
valkyrie
features. for now, we just check theActiveRecord
DB andthe configured rails cache. if
MEMCACHED_HOST
is set, we check that; otherwisewe just use the
OkComputer
default cache check. some applications may need todo special configuration to make sure the cache check is functioning properly.
introducing this now as an incomplete service, and with an extra step required
to turn on will give us a chance to iron out details and avoid stepping on the
toes of any applications with their own
healthz
endpoints.the check can be installed during app generation by passing
false
to theskip-health-check
option.@samvera/hyrax-code-reviewers