synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-29 10:35:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor(coderd/healthcheck): make Warnings an object with { Code, Message } (#10950)

Browse Source 
- Adds health.Message { code string, mesasge string }
- Refactors existing warnings []string to be of type []health.Message instead
This commit is contained in:
Cian Johnston
2023-11-30 14:49:50 +00:00
committed by GitHub
parent 4f9292859d
commit 07895006d9
18 changed files with 459 additions and 151 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
docs/api/debug.md generated
View File

@@ -54,7 +54,12 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
"reachable": true,
"severity": "ok",
"status_code": 0,
"warnings": ["string"]
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
},
"coder_version": "string",
"database": {
@@ -66,7 +71,12 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
"reachable": true,
"severity": "ok",
"threshold_ms": 0,
"warnings": ["string"]
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
},
"derp": {
"dismissed": true,
@@ -143,7 +153,12 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
"error": "string"
},
"uses_websocket": true,
"warnings": ["string"]
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
}
],
"region": {
@@ -171,7 +186,12 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
"regionName": "string"
},
"severity": "ok",
"warnings": ["string"]
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
},
"property2": {
"error": "string",
@@ -211,7 +231,12 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
"error": "string"
},
"uses_websocket": true,
"warnings": ["string"]
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
}
],
"region": {
@@ -239,11 +264,21 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
"regionName": "string"
},
"severity": "ok",
"warnings": ["string"]
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
}
},
"severity": "ok",
"warnings": ["string"]
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
},
"failing_sections": ["string"],
"healthy": true,
@@ -263,7 +298,12 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
"error": "string",
"healthy": true,
"severity": "ok",
"warnings": ["string"],
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
],
"workspace_proxies": {
"regions": [
{