Geo Status API: Create a SSoT for Geo Site Health Status

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

• Close this issue

Why are we doing this work

Geo Site's Health Status is a bit misleading as it doesn't do a enough to validate the actual health of a Geo Site. Resulting in situations where the site may say its healthy when it is in fact not.

We do have a rails script gitlab:geo:check that seems to do a better job at communicating the actual health of a site but this is not reflected in the Geo API or UI.

We should create a singular SSoT for validating a Geo Sites health in totality, or at the very least, as close to totality as is reasonable more the majority of configurations.

Proposal

1. Discover if the checks in gitlab:geo:check cover truly the Geo Site's Health
2. Update health_check.rb / perform_checks to encompass the entire health check
3. Organize the data in the API in a fashion that we can properly communicate the status to the UI
   • Differentiate between levels of errors success|warning|failure
   • Provide a short description of the error
   • Provide a link to troubleshooting or support documents when status is warning/failure
4. Consider if we need to create new data keys in our API for backwards compatibility
5. Consider if the work on Configuration Check should be rolled into health check or kept separate #381354

Relevant links

• API: /geo_sites/${siteId}/status
• Frontend work: #564396
• Configuration Check: #381354
• Example of a list view with sorting
• How health check currently works
• health_check.rb / perform_checks

Screenshots

Current API Response

Implementation plan

TBD

This page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc.