fix: properly expose errors in health checker

healthx/doc.go

@@ -21,6 +21,8 @@
 // Package healthx providers helpers for returning health status information via HTTP.
 package healthx
 
+import "strings"
+
 // swagger:model healthStatus
 type swaggerHealthStatus struct {
 	// Status always contains "ok".
@@ -33,6 +35,14 @@ type swaggerNotReadyStatus struct {
 	Errors map[string]string `json:"errors"`
 }
 
+func (s swaggerNotReadyStatus) Error() string {
+	var errs []string
+	for _, err := range s.Errors {
+		errs = append(errs, err)
+	}
+	return strings.Join(errs, "; ")
+}
+
 // swagger:model version
 type swaggerVersion struct {
 	// Version is the service's version.

healthx/handler.go

@@ -187,7 +187,7 @@ func (h *Handler) Ready(shareErrors bool) http.Handler {
 		}
 
 		if len(notReady.Errors) > 0 {
-			h.H.WriteCode(rw, r, http.StatusServiceUnavailable, notReady)
+			h.H.WriteErrorCode(rw, r, http.StatusServiceUnavailable, &notReady)
 			return
 		}
 

healthx/handler_test.go

@@ -86,7 +86,7 @@ func TestHealth(t *testing.T) {
 		require.EqualValues(t, http.StatusServiceUnavailable, response.StatusCode)
 		out, err := ioutil.ReadAll(response.Body)
 		require.NoError(t, err)
-		assert.Equal(t, `{"errors":{"test":"not alive"}}`, strings.TrimSpace(string(out)))
+		assert.Equal(t, "{\"error\":{\"code\":500,\"status\":\"Internal Server Error\",\"message\":\"not alive\"}}", strings.TrimSpace(string(out)))
 		return response
 	}