hotfix(healthcheck): properly calculate healthy status (#7746)

coadler · ammario · commit 8e5f1f0c8873 · 2023-06-01T05:14:46.000Z
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/healthcheck/accessurl.go b/coderd/healthcheck/accessurl.go
@@ -11,11 +11,11 @@ import (
 )
 
 type AccessURLReport struct {
-	Healthy         bool
-	Reachable       bool
-	StatusCode      int
-	HealthzResponse string
-	Error           error
+	Healthy         bool   `json:"healthy"`
+	Reachable       bool   `json:"reachable"`
+	StatusCode      int    `json:"status_code"`
+	HealthzResponse string `json:"healthz_response"`
+	Error           error  `json:"error"`
 }
 
 type AccessURLOptions struct {
diff --git a/coderd/healthcheck/healthcheck.go b/coderd/healthcheck/healthcheck.go
@@ -15,7 +15,7 @@ type Report struct {
 	// Time is the time the report was generated at.
 	Time time.Time `json:"time"`
 	// Healthy is true if the report returns no errors.
-	Healthy bool `json:"pass"`
+	Healthy bool `json:"healthy"`
 
 	DERP      DERPReport      `json:"derp"`
 	AccessURL AccessURLReport `json:"access_url"`
@@ -80,6 +80,8 @@ func Run(ctx context.Context, opts *ReportOptions) (*Report, error) {
 
 	wg.Wait()
 	report.Time = time.Now()
-	report.Healthy = report.DERP.Healthy
+	report.Healthy = report.DERP.Healthy &&
+		report.AccessURL.Healthy &&
+		report.Websocket.Healthy
 	return &report, nil
 }
diff --git a/coderd/healthcheck/websocket.go b/coderd/healthcheck/websocket.go
@@ -21,6 +21,7 @@ type WebsocketReportOptions struct {
 }
 
 type WebsocketReport struct {
+	Healthy  bool              `json:"healthy"`
 	Response WebsocketResponse `json:"response"`
 	Error    error             `json:"error"`
 }
@@ -96,6 +97,7 @@ func (r *WebsocketReport) Run(ctx context.Context, opts *WebsocketReportOptions)
 	}
 
 	c.Close(websocket.StatusGoingAway, "goodbye")
+	r.Healthy = true
 }
 
 type WebsocketEchoServer struct {
diff --git a/docs/api/debug.md b/docs/api/debug.md
@@ -42,9 +42,9 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
   "access_url": {
     "error": null,
     "healthy": true,
-    "healthzResponse": "string",
+    "healthz_response": "string",
     "reachable": true,
-    "statusCode": 0
+    "status_code": 0
   },
   "derp": {
     "error": null,
@@ -206,10 +206,11 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
       }
     }
   },
-  "pass": true,
+  "healthy": true,
   "time": "string",
   "websocket": {
     "error": null,
+    "healthy": true,
     "response": {
       "body": "string",
       "code": 0
diff --git a/docs/api/schemas.md b/docs/api/schemas.md
@@ -5867,21 +5867,21 @@ Parameter represents a set value for the scope.
 {
   "error": null,
   "healthy": true,
-  "healthzResponse": "string",
+  "healthz_response": "string",
   "reachable": true,
-  "statusCode": 0
+  "status_code": 0
 }
 ```
 
 ### Properties
 
-| Name              | Type    | Required | Restrictions | Description |
-| ----------------- | ------- | -------- | ------------ | ----------- |
-| `error`           | any     | false    |              |             |
-| `healthy`         | boolean | false    |              |             |
-| `healthzResponse` | string  | false    |              |             |
-| `reachable`       | boolean | false    |              |             |
-| `statusCode`      | integer | false    |              |             |
+| Name               | Type    | Required | Restrictions | Description |
+| ------------------ | ------- | -------- | ------------ | ----------- |
+| `error`            | any     | false    |              |             |
+| `healthy`          | boolean | false    |              |             |
+| `healthz_response` | string  | false    |              |             |
+| `reachable`        | boolean | false    |              |             |
+| `status_code`      | integer | false    |              |             |
 
 ## healthcheck.DERPNodeReport
 
@@ -6212,9 +6212,9 @@ Parameter represents a set value for the scope.
   "access_url": {
     "error": null,
     "healthy": true,
-    "healthzResponse": "string",
+    "healthz_response": "string",
     "reachable": true,
-    "statusCode": 0
+    "status_code": 0
   },
   "derp": {
     "error": null,
@@ -6376,10 +6376,11 @@ Parameter represents a set value for the scope.
       }
     }
   },
-  "pass": true,
+  "healthy": true,
   "time": "string",
   "websocket": {
     "error": null,
+    "healthy": true,
     "response": {
       "body": "string",
       "code": 0
@@ -6394,7 +6395,7 @@ Parameter represents a set value for the scope.
 | ------------ | ---------------------------------------------------------- | -------- | ------------ | ------------------------------------------------ |
 | `access_url` | [healthcheck.AccessURLReport](#healthcheckaccessurlreport) | false    |              |                                                  |
 | `derp`       | [healthcheck.DERPReport](#healthcheckderpreport)           | false    |              |                                                  |
-| `pass`       | boolean                                                    | false    |              | Healthy is true if the report returns no errors. |
+| `healthy`    | boolean                                                    | false    |              | Healthy is true if the report returns no errors. |
 | `time`       | string                                                     | false    |              | Time is the time the report was generated at.    |
 | `websocket`  | [healthcheck.WebsocketReport](#healthcheckwebsocketreport) | false    |              |                                                  |
 
@@ -6403,6 +6404,7 @@ Parameter represents a set value for the scope.
 ```json
 {
   "error": null,
+  "healthy": true,
   "response": {
     "body": "string",
     "code": 0
@@ -6415,6 +6417,7 @@ Parameter represents a set value for the scope.
 | Name       | Type                                                           | Required | Restrictions | Description |
 | ---------- | -------------------------------------------------------------- | -------- | ------------ | ----------- |
 | `error`    | any                                                            | false    |              |             |
+| `healthy`  | boolean                                                        | false    |              |             |
 | `response` | [healthcheck.WebsocketResponse](#healthcheckwebsocketresponse) | false    |              |             |
 
 ## healthcheck.WebsocketResponse

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ type WebsocketReportOptions struct {`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`type WebsocketReport struct {`
	`24`	+ Healthy bool `json:"healthy"`
`24`	`25`	Response WebsocketResponse `json:"response"`
`25`	`26`	Error error `json:"error"`
`26`	`27`	`}`
`@@ -96,6 +97,7 @@ func (r WebsocketReport) Run(ctx context.Context, opts WebsocketReportOptions)`
`96`	`97`	`}`
`97`	`98`
`98`	`99`	`c.Close(websocket.StatusGoingAway, "goodbye")`
	`100`	`+ r.Healthy = true`
`99`	`101`	`}`
`100`	`102`
`101`	`103`	`type WebsocketEchoServer struct {`