Skip to content

hotfix(healthcheck): properly calculate healthy status #7746

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 31, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
fixup! hotfix(healthcheck): properly calculate healthy status
  • Loading branch information
coadler committed May 31, 2023
commit 1200cb36adc0d49be59670eac1b89a45e083fd59
9 changes: 6 additions & 3 deletions coderd/apidoc/docs.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 6 additions & 3 deletions coderd/apidoc/swagger.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 4 additions & 3 deletions docs/api/debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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
Expand Down
29 changes: 16 additions & 13 deletions docs/api/schemas.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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
Expand All @@ -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 | | |

Expand All @@ -6403,6 +6404,7 @@ Parameter represents a set value for the scope.
```json
{
"error": null,
"healthy": true,
"response": {
"body": "string",
"code": 0
Expand All @@ -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
Expand Down