synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-09 11:45:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(healthcheck): add websocket report (#7689)

Browse Source
This commit is contained in:
Colin Adler
2023-05-30 14:22:32 -05:00
committed by GitHub
parent 77b0ca0b53
commit 022372dd73
11 changed files with 468 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/api/debug.md
View File

@ -207,7 +207,14 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
}
},
"pass": true,
"time": "string"
"time": "string",
"websocket": {
"error": null,
"response": {
"body": "string",
"code": 0
}
}
}
```

45
docs/api/schemas.md
View File

@ -6377,7 +6377,14 @@ Parameter represents a set value for the scope.
}
},
"pass": true,
"time": "string"
"time": "string",
"websocket": {
"error": null,
"response": {
"body": "string",
"code": 0
}
}
}
```
@ -6389,6 +6396,42 @@ Parameter represents a set value for the scope.
| `derp` | [healthcheck.DERPReport](#healthcheckderpreport) | false | | |
| `pass` | 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 | | |
## healthcheck.WebsocketReport
```json
{
"error": null,
"response": {
"body": "string",
"code": 0
}
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------- | -------------------------------------------------------------- | -------- | ------------ | ----------- |
| `error` | any | false | | |
| `response` | [healthcheck.WebsocketResponse](#healthcheckwebsocketresponse) | false | | |
## healthcheck.WebsocketResponse
```json
{
"body": "string",
"code": 0
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------ | ------- | -------- | ------------ | ----------- |
| `body` | string | false | | |
| `code` | integer | false | | |
## netcheck.Report