Rename to healthz, make response JSON

Author: jprenken

test/integration/wfe_test.go

@@ -53,15 +53,15 @@ func TestWFEHTTPMetrics(t *testing.T) {
 	resp.Body.Close()
 }
 
-// TestWFEHealth checks to make sure that the /health endpoint returns 200 OK,
+// TestWFEHealthz checks to make sure that the /health endpoint returns 200 OK,
 // retrying in case overrides take a moment to load.
-func TestWFEHealth(t *testing.T) {
+func TestWFEHealthz(t *testing.T) {
 	retries := 0
 	var status int
 	for retries < 5 {
 		time.Sleep(core.RetryBackoff(retries, time.Millisecond*2, time.Millisecond*50, 2))
-		resp, err := http.Get("http://boulder.service.consul:4001/health")
-		test.AssertNotError(t, err, "GET boulder-wfe2 health")
+		resp, err := http.Get("http://boulder.service.consul:4001/healthz")
+		test.AssertNotError(t, err, "GET boulder-wfe2 healthz")
 		status = resp.StatusCode
 		resp.Body.Close()
 		if status == http.StatusOK {

wfe2/wfe.go

@@ -71,7 +71,7 @@ const (
 	getCertPath     = "/get/cert/"
 	getCertInfoPath = "/get/certinfo/"
 	buildIDPath     = "/build"
-	healthPath      = "/health"
+	healthzPath     = "/healthz"
 )
 
 const (
@@ -426,7 +426,7 @@ func (wfe *WebFrontEndImpl) Handler(stats prometheus.Registerer, oTelHTTPOptions
 	wfe.HandleFunc(m, getCertPath, wfe.Certificate, "GET")
 	wfe.HandleFunc(m, getCertInfoPath, wfe.CertificateInfo, "GET")
 	wfe.HandleFunc(m, buildIDPath, wfe.BuildID, "GET")
-	wfe.HandleFunc(m, healthPath, wfe.HttpHealth, "GET")
+	wfe.HandleFunc(m, healthzPath, wfe.Healthz, "GET")
 
 	// Endpoint for draft-ietf-acme-ari
 	if features.Get().ServeRenewalInfo {
@@ -1803,8 +1803,12 @@ func (wfe *WebFrontEndImpl) BuildID(ctx context.Context, logEvent *web.RequestEv
 	}
 }
 
-// HttpHealth tells the requester whether we're ready to serve requests.
-func (wfe *WebFrontEndImpl) HttpHealth(ctx context.Context, _ *web.RequestEvent, response http.ResponseWriter, _ *http.Request) {
+type WfeHealthzResponse struct {
+	Details string
+}
+
+// Healthz tells the requester whether we're ready to serve requests.
+func (wfe *WebFrontEndImpl) Healthz(ctx context.Context, logEvent *web.RequestEvent, response http.ResponseWriter, request *http.Request) {
 	status := http.StatusOK
 	details := "OK"
 
@@ -1813,9 +1817,13 @@ func (wfe *WebFrontEndImpl) HttpHealth(ctx context.Context, _ *web.RequestEvent,
 		details = "waiting for overrides"
 	}
 
-	response.Header().Set("Content-Type", "text/plain")
-	response.WriteHeader(status)
-	if _, err := fmt.Println(response, details); err != nil {
+	jsonResponse, err := json.Marshal(WfeHealthzResponse{Details: details})
+	if err != nil {
+		wfe.log.Warningf("Could not marshal healthz response: %s", err)
+	}
+
+	err = wfe.writeJsonResponse(response, logEvent, status, jsonResponse)
+	if err != nil {
 		wfe.log.Warningf("Could not write response: %s", err)
 	}
 }

wfe2/wfe_test.go

@@ -1097,7 +1097,7 @@ func TestHTTPMethods(t *testing.T) {
 		},
 		{
 			Name:    "Health path should be GET only",
-			Path:    healthPath,
+			Path:    healthzPath,
 			Allowed: getOnly,
 		},
 		{