coder · kylecarbs · Jun 21, 2024 · May 31, 2024
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/healthcheck.go b/coderd/healthcheck/healthcheck.go
@@ -156,27 +156,27 @@ func Run(ctx context.Context, opts *ReportOptions) *healthsdk.HealthcheckReport
 	wg.Wait()
 
 	report.Time = time.Now()
-	report.FailingSections = []healthsdk.HealthSection{}
+	failingSections := []healthsdk.HealthSection{}
 	if report.DERP.Severity.Value() > health.SeverityWarning.Value() {
-		report.FailingSections = append(report.FailingSections, healthsdk.HealthSectionDERP)
+		failingSections = append(failingSections, healthsdk.HealthSectionDERP)
 	}
 	if report.AccessURL.Severity.Value() > health.SeverityOK.Value() {
-		report.FailingSections = append(report.FailingSections, healthsdk.HealthSectionAccessURL)
+		failingSections = append(failingSections, healthsdk.HealthSectionAccessURL)
 	}
 	if report.Websocket.Severity.Value() > health.SeverityWarning.Value() {
-		report.FailingSections = append(report.FailingSections, healthsdk.HealthSectionWebsocket)
+		failingSections = append(failingSections, healthsdk.HealthSectionWebsocket)
 	}
 	if report.Database.Severity.Value() > health.SeverityWarning.Value() {
-		report.FailingSections = append(report.FailingSections, healthsdk.HealthSectionDatabase)
+		failingSections = append(failingSections, healthsdk.HealthSectionDatabase)
 	}
 	if report.WorkspaceProxy.Severity.Value() > health.SeverityWarning.Value() {
-		report.FailingSections = append(report.FailingSections, healthsdk.HealthSectionWorkspaceProxy)
+		failingSections = append(failingSections, healthsdk.HealthSectionWorkspaceProxy)
 	}
 	if report.ProvisionerDaemons.Severity.Value() > health.SeverityWarning.Value() {
-		report.FailingSections = append(report.FailingSections, healthsdk.HealthSectionProvisionerDaemons)
+		failingSections = append(failingSections, healthsdk.HealthSectionProvisionerDaemons)
 	}
 
-	report.Healthy = len(report.FailingSections) == 0
+	report.Healthy = len(failingSections) == 0
 
 	// Review healthcheck sub-reports.
 	report.Severity = health.SeverityOK

diff --git a/coderd/healthcheck/healthcheck_test.go b/coderd/healthcheck/healthcheck_test.go
@@ -49,11 +49,10 @@ func TestHealthcheck(t *testing.T) {
 	t.Parallel()
 
 	for _, c := range []struct {
-		name            string
-		checker         *testChecker
-		healthy         bool
-		severity        health.Severity
-		failingSections []healthsdk.HealthSection
+		name     string
+		checker  *testChecker
+		healthy  bool
+		severity health.Severity
 	}{{
 		name: "OK",
 		checker: &testChecker{
@@ -93,9 +92,8 @@ func TestHealthcheck(t *testing.T) {
 				},
 			},
 		},
-		healthy:         true,
-		severity:        health.SeverityOK,
-		failingSections: []healthsdk.HealthSection{},
+		healthy:  true,
+		severity: health.SeverityOK,
 	}, {
 		name: "DERPFail",
 		checker: &testChecker{
@@ -135,9 +133,8 @@ func TestHealthcheck(t *testing.T) {
 				},
 			},
 		},
-		healthy:         false,
-		severity:        health.SeverityError,
-		failingSections: []healthsdk.HealthSection{healthsdk.HealthSectionDERP},
+		healthy:  false,
+		severity: health.SeverityError,
 	}, {
 		name: "DERPWarning",
 		checker: &testChecker{
@@ -178,9 +175,8 @@ func TestHealthcheck(t *testing.T) {
 				},
 			},
 		},
-		healthy:         true,
-		severity:        health.SeverityWarning,
-		failingSections: []healthsdk.HealthSection{},
+		healthy:  true,
+		severity: health.SeverityWarning,
 	}, {
 		name: "AccessURLFail",
 		checker: &testChecker{
@@ -220,9 +216,8 @@ func TestHealthcheck(t *testing.T) {
 				},
 			},
 		},
-		healthy:         false,
-		severity:        health.SeverityWarning,
-		failingSections: []healthsdk.HealthSection{healthsdk.HealthSectionAccessURL},
+		healthy:  false,
+		severity: health.SeverityWarning,
 	}, {
 		name: "WebsocketFail",
 		checker: &testChecker{
@@ -262,9 +257,8 @@ func TestHealthcheck(t *testing.T) {
 				},
 			},
 		},
-		healthy:         false,
-		severity:        health.SeverityError,
-		failingSections: []healthsdk.HealthSection{healthsdk.HealthSectionWebsocket},
+		healthy:  false,
+		severity: health.SeverityError,
 	}, {
 		name: "DatabaseFail",
 		checker: &testChecker{
@@ -304,9 +298,8 @@ func TestHealthcheck(t *testing.T) {
 				},
 			},
 		},
-		healthy:         false,
-		severity:        health.SeverityError,
-		failingSections: []healthsdk.HealthSection{healthsdk.HealthSectionDatabase},
+		healthy:  false,
+		severity: health.SeverityError,
 	}, {
 		name: "ProxyFail",
 		checker: &testChecker{
@@ -346,9 +339,8 @@ func TestHealthcheck(t *testing.T) {
 				},
 			},
 		},
-		severity:        health.SeverityError,
-		healthy:         false,
-		failingSections: []healthsdk.HealthSection{healthsdk.HealthSectionWorkspaceProxy},
+		severity: health.SeverityError,
+		healthy:  false,
 	}, {
 		name: "ProxyWarn",
 		checker: &testChecker{
@@ -389,9 +381,8 @@ func TestHealthcheck(t *testing.T) {
 				},
 			},
 		},
-		severity:        health.SeverityWarning,
-		healthy:         true,
-		failingSections: []healthsdk.HealthSection{},
+		severity: health.SeverityWarning,
+		healthy:  true,
 	}, {
 		name: "ProvisionerDaemonsFail",
 		checker: &testChecker{
@@ -431,9 +422,8 @@ func TestHealthcheck(t *testing.T) {
 				},
 			},
 		},
-		severity:        health.SeverityError,
-		healthy:         false,
-		failingSections: []healthsdk.HealthSection{healthsdk.HealthSectionProvisionerDaemons},
+		severity: health.SeverityError,
+		healthy:  false,
 	}, {
 		name: "ProvisionerDaemonsWarn",
 		checker: &testChecker{
@@ -474,9 +464,8 @@ func TestHealthcheck(t *testing.T) {
 				},
 			},
 		},
-		severity:        health.SeverityWarning,
-		healthy:         true,
-		failingSections: []healthsdk.HealthSection{},
+		severity: health.SeverityWarning,
+		healthy:  true,
 	}, {
 		name:    "AllFail",
 		healthy: false,
@@ -518,14 +507,6 @@ func TestHealthcheck(t *testing.T) {
 			},
 		},
 		severity: health.SeverityError,
-		failingSections: []healthsdk.HealthSection{
-			healthsdk.HealthSectionDERP,
-			healthsdk.HealthSectionAccessURL,
-			healthsdk.HealthSectionWebsocket,
-			healthsdk.HealthSectionDatabase,
-			healthsdk.HealthSectionWorkspaceProxy,
-			healthsdk.HealthSectionProvisionerDaemons,
-		},
 	}} {
 		c := c
 		t.Run(c.name, func(t *testing.T) {
@@ -537,7 +518,6 @@ func TestHealthcheck(t *testing.T) {
 
 			assert.Equal(t, c.healthy, report.Healthy)
 			assert.Equal(t, c.severity, report.Severity)
-			assert.Equal(t, c.failingSections, report.FailingSections)
 			assert.Equal(t, c.checker.DERPReport.Healthy, report.DERP.Healthy)
 			assert.Equal(t, c.checker.DERPReport.Severity, report.DERP.Severity)
 			assert.Equal(t, c.checker.DERPReport.Warnings, report.DERP.Warnings)

diff --git a/codersdk/healthsdk/healthsdk.go b/codersdk/healthsdk/healthsdk.go
@@ -105,8 +105,6 @@ type HealthcheckReport struct {
 	Healthy bool `json:"healthy"`
 	// Severity indicates the status of Coder health.
 	Severity health.Severity `json:"severity" enums:"ok,warning,error"`
-	// FailingSections is a list of sections that have failed their healthcheck.
-	FailingSections []HealthSection `json:"failing_sections"`
 
 	DERP               DERPHealthReport         `json:"derp"`
 	AccessURL          AccessURLReport          `json:"access_url"`

diff --git a/docs/api/debug.md b/docs/api/debug.md
diff --git a/docs/api/schemas.md b/docs/api/schemas.md
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
diff --git a/site/src/testHelpers/entities.ts b/site/src/testHelpers/entities.ts
@@ -2528,7 +2528,6 @@ export const MockHealth: TypesGen.HealthcheckReport = {
   time: "2023-08-01T16:51:03.29792825Z",
   healthy: true,
   severity: "ok",
-  failing_sections: [],
   derp: {
     healthy: true,
     severity: "ok",
@@ -3322,7 +3321,6 @@ export const MockSharedPortsResponse: TypesGen.WorkspaceAgentPortShares = {
 export const DeploymentHealthUnhealthy: TypesGen.HealthcheckReport = {
   healthy: false,
   severity: "ok",
-  failing_sections: [], // apparently this property is not used at all?
   time: "2023-10-12T23:15:00.000000000Z",
   coder_version: "v2.3.0-devel+8cca4915a",
   access_url: {