Server Healthcheck Endpoint

[edalex-ian]

Is your feature request related to a problem? Please describe.

With the New UI enabled, our Hosting Team has highlighted that their old health check for the server no longer works. This is mainly due to the dynamic loading of pages via React.

But in some ways, that highlighted a missing feature.

Describe the solution you'd like

AS A system administrator I WANT a URL which allows me to programmatically check the status of the server and its institutions SO THAT I can integrate with health monitoring tools.

The URL would consist probably of the server admin URL and then a path like /health or /status. It could return a JSON payload including some key stats like:

• List of nodes and uptime (ensuring to identify which is the node responding - in case behind a load balancer)
• List of institutions and their DB status ('healthy' or otherwise)
• Could be nice to also include some system metrics - but unfortunately that'd only be for the current node - such as memory usage, CPU usage - unless we expand what is passed around zookeeper etc. But typically this would be captured by other monitoring software (such as Prometheus etc.)

Additional context

This is now a somewhat common paradigm in distributed and micro-service architectures. And there are some more full fledged framework examples with things like Spring Boot Actuator.

The above though is just the minimum that we need to fill this gap.

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.