Uploaded image for project: 'GPII - Global Public Inclusive Infrastructure'
  1. GPII - Global Public Inclusive Infrastructure
  2. GPII-3551

Improvements and bug fix for /ready and /health endpoint

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
      None

      Description

      1. Tyler Roscoe and Joseph Scheuhammer have this same issue with accessing /ready endpoint at Cloud Based Flow Manager and Preference Server with kubernetes clusters and docker containers:

      • Accessing Cloud Based Flow Manager /ready endpoint, such as https://flowmanager.stg.gpii.net/ready, returns the error:
        {
            isError: true,
            message: "Cannot connect to Preferences Server at http://preferences.gpii.svc.cluster.local"
        }
        

      Accessing other endpoints on these servers works well.

      2. At success, /ready and /health endpoints should return JSON payload for an easier understanding of the server states.

      • /ready returns:
        {
            isReady: true
        }
        
      • /health returns
        {
            isHealthy: true
        }
        

      3. At error, /ready and /health endpoints should return 503 (Service Unavailable) http status code rather than 404.

      Reference: Tyler Roscoe found this helpful discussion about what http status code and message should be returned for health check endpoints.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                clown Joseph Scheuhammer
                Reporter:
                cli@ocad.ca Cindy Qi Li
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: