feat: include health severity in reports (#10817)

This commit is contained in:
Marcin Tojek
2023-11-23 16:08:41 +01:00
committed by GitHub
parent e311e9ec24
commit 78df68348a
18 changed files with 542 additions and 91 deletions

106
coderd/apidoc/docs.go generated
View File

@ -12103,6 +12103,7 @@ const docTemplate = `{
"type": "string"
},
"healthy": {
"description": "Healthy is deprecated and left for backward compatibility purposes, use ` + "`" + `Severity` + "`" + ` instead.",
"type": "boolean"
},
"node": {
@ -12117,6 +12118,18 @@ const docTemplate = `{
"round_trip_ping_ms": {
"type": "integer"
},
"severity": {
"enum": [
"ok",
"warning",
"error"
],
"allOf": [
{
"$ref": "#/definitions/health.Severity"
}
]
},
"stun": {
"$ref": "#/definitions/derphealth.StunReport"
},
@ -12138,6 +12151,7 @@ const docTemplate = `{
"type": "string"
},
"healthy": {
"description": "Healthy is deprecated and left for backward compatibility purposes, use ` + "`" + `Severity` + "`" + ` instead.",
"type": "boolean"
},
"node_reports": {
@ -12149,6 +12163,18 @@ const docTemplate = `{
"region": {
"$ref": "#/definitions/tailcfg.DERPRegion"
},
"severity": {
"enum": [
"ok",
"warning",
"error"
],
"allOf": [
{
"$ref": "#/definitions/health.Severity"
}
]
},
"warnings": {
"type": "array",
"items": {
@ -12164,6 +12190,7 @@ const docTemplate = `{
"type": "string"
},
"healthy": {
"description": "Healthy is deprecated and left for backward compatibility purposes, use ` + "`" + `Severity` + "`" + ` instead.",
"type": "boolean"
},
"netcheck": {
@ -12184,6 +12211,18 @@ const docTemplate = `{
"$ref": "#/definitions/derphealth.RegionReport"
}
},
"severity": {
"enum": [
"ok",
"warning",
"error"
],
"allOf": [
{
"$ref": "#/definitions/health.Severity"
}
]
},
"warnings": {
"type": "array",
"items": {
@ -12206,6 +12245,19 @@ const docTemplate = `{
}
}
},
"health.Severity": {
"type": "string",
"enum": [
"ok",
"warning",
"error"
],
"x-enum-varnames": [
"SeverityOK",
"SeverityWarning",
"SeverityError"
]
},
"healthcheck.AccessURLReport": {
"type": "object",
"properties": {
@ -12216,6 +12268,7 @@ const docTemplate = `{
"type": "string"
},
"healthy": {
"description": "Healthy is deprecated and left for backward compatibility purposes, use ` + "`" + `Severity` + "`" + ` instead.",
"type": "boolean"
},
"healthz_response": {
@ -12224,6 +12277,18 @@ const docTemplate = `{
"reachable": {
"type": "boolean"
},
"severity": {
"enum": [
"ok",
"warning",
"error"
],
"allOf": [
{
"$ref": "#/definitions/health.Severity"
}
]
},
"status_code": {
"type": "integer"
},
@ -12242,6 +12307,7 @@ const docTemplate = `{
"type": "string"
},
"healthy": {
"description": "Healthy is deprecated and left for backward compatibility purposes, use ` + "`" + `Severity` + "`" + ` instead.",
"type": "boolean"
},
"latency": {
@ -12253,6 +12319,18 @@ const docTemplate = `{
"reachable": {
"type": "boolean"
},
"severity": {
"enum": [
"ok",
"warning",
"error"
],
"allOf": [
{
"$ref": "#/definitions/health.Severity"
}
]
},
"threshold_ms": {
"type": "integer"
},
@ -12288,9 +12366,22 @@ const docTemplate = `{
}
},
"healthy": {
"description": "Healthy is true if the report returns no errors.",
"description": "Healthy is true if the report returns no errors.\nDeprecated: use ` + "`" + `Severity` + "`" + ` instead",
"type": "boolean"
},
"severity": {
"description": "Severity indicates the status of Coder health.",
"enum": [
"ok",
"warning",
"error"
],
"allOf": [
{
"$ref": "#/definitions/health.Severity"
}
]
},
"time": {
"description": "Time is the time the report was generated at.",
"type": "string"
@ -12313,8 +12404,21 @@ const docTemplate = `{
"type": "string"
},
"healthy": {
"description": "Healthy is deprecated and left for backward compatibility purposes, use ` + "`" + `Severity` + "`" + ` instead.",
"type": "boolean"
},
"severity": {
"enum": [
"ok",
"warning",
"error"
],
"allOf": [
{
"$ref": "#/definitions/health.Severity"
}
]
},
"warnings": {
"type": "array",
"items": {