Skip to content

Commit f045e6e

Browse files
coadlercoadler
committed
fixup! add healthy bool
1 parent 9f62a8c commit f045e6e

File tree

4 files changed

+56
-4
lines changed

4 files changed

+56
-4
lines changed

‎coderd/apidoc/docs.go

Lines changed: 14 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎coderd/apidoc/swagger.json

Lines changed: 14 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/api/debug.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
4040
```json
4141
{
4242
"derp": {
43+
"healthy": true,
4344
"netcheck": {
4445
"captivePortal": "string",
4546
"globalV4": "string",
@@ -73,11 +74,13 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
7374
"netcheck_logs": ["string"],
7475
"regions": {
7576
"property1": {
77+
"healthy": true,
7678
"node_reports": [
7779
{
7880
"can_exchange_messages": true,
7981
"client_errs": [[null]],
8082
"client_logs": [["string"]],
83+
"healthy": true,
8184
"node": {
8285
"certName": "string",
8386
"derpport": 0,
@@ -126,11 +129,13 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
126129
}
127130
},
128131
"property2": {
132+
"healthy": true,
129133
"node_reports": [
130134
{
131135
"can_exchange_messages": true,
132136
"client_errs": [[null]],
133137
"client_logs": [["string"]],
138+
"healthy": true,
134139
"node": {
135140
"certName": "string",
136141
"derpport": 0,
@@ -180,6 +185,7 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
180185
}
181186
}
182187
},
188+
"pass": true,
183189
"time": "string"
184190
}
185191
```

‎docs/api/schemas.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5463,6 +5463,7 @@ Parameter represents a set value for the scope.
54635463
"can_exchange_messages": true,
54645464
"client_errs": [[null]],
54655465
"client_logs": [["string"]],
5466+
"healthy": true,
54665467
"node": {
54675468
"certName": "string",
54685469
"derpport": 0,
@@ -5494,6 +5495,7 @@ Parameter represents a set value for the scope.
54945495
| `can_exchange_messages` | boolean | false | | |
54955496
| `client_errs` | array of array | false | | |
54965497
| `client_logs` | array of array | false | | |
5498+
| `healthy` | boolean | false | | |
54975499
| `node` | [tailcfg.DERPNode](#tailcfgderpnode) | false | | |
54985500
| `round_trip_ping` | integer | false | | |
54995501
| `stun` | [healthcheck.DERPStunReport](#healthcheckderpstunreport) | false | | |
@@ -5503,11 +5505,13 @@ Parameter represents a set value for the scope.
55035505

55045506
```json
55055507
{
5508+
"healthy": true,
55065509
"node_reports": [
55075510
{
55085511
"can_exchange_messages": true,
55095512
"client_errs": [[null]],
55105513
"client_logs": [["string"]],
5514+
"healthy": true,
55115515
"node": {
55125516
"certName": "string",
55135517
"derpport": 0,
@@ -5561,13 +5565,15 @@ Parameter represents a set value for the scope.
55615565

55625566
| Name | Type | Required | Restrictions | Description |
55635567
| -------------- | ----------------------------------------------------------------- | -------- | ------------ | ----------- |
5568+
| `healthy` | boolean | false | | |
55645569
| `node_reports` | array of [healthcheck.DERPNodeReport](#healthcheckderpnodereport) | false | | |
55655570
| `region` | [tailcfg.DERPRegion](#tailcfgderpregion) | false | | |
55665571

55675572
## healthcheck.DERPReport
55685573

55695574
```json
55705575
{
5576+
"healthy": true,
55715577
"netcheck": {
55725578
"captivePortal": "string",
55735579
"globalV4": "string",
@@ -5601,11 +5607,13 @@ Parameter represents a set value for the scope.
56015607
"netcheck_logs": ["string"],
56025608
"regions": {
56035609
"property1": {
5610+
"healthy": true,
56045611
"node_reports": [
56055612
{
56065613
"can_exchange_messages": true,
56075614
"client_errs": [[null]],
56085615
"client_logs": [["string"]],
5616+
"healthy": true,
56095617
"node": {
56105618
"certName": "string",
56115619
"derpport": 0,
@@ -5654,11 +5662,13 @@ Parameter represents a set value for the scope.
56545662
}
56555663
},
56565664
"property2": {
5665+
"healthy": true,
56575666
"node_reports": [
56585667
{
56595668
"can_exchange_messages": true,
56605669
"client_errs": [[null]],
56615670
"client_logs": [["string"]],
5671+
"healthy": true,
56625672
"node": {
56635673
"certName": "string",
56645674
"derpport": 0,
@@ -5714,6 +5724,7 @@ Parameter represents a set value for the scope.
57145724

57155725
| Name | Type | Required | Restrictions | Description |
57165726
| ------------------ | ------------------------------------------------------------ | -------- | ------------ | ----------- |
5727+
| `healthy` | boolean | false | | |
57175728
| `netcheck` | [netcheck.Report](#netcheckreport) | false | | |
57185729
| `netcheck_logs` | array of string | false | | |
57195730
| `regions` | object | false | | |
@@ -5742,6 +5753,7 @@ Parameter represents a set value for the scope.
57425753
```json
57435754
{
57445755
"derp": {
5756+
"healthy": true,
57455757
"netcheck": {
57465758
"captivePortal": "string",
57475759
"globalV4": "string",
@@ -5775,11 +5787,13 @@ Parameter represents a set value for the scope.
57755787
"netcheck_logs": ["string"],
57765788
"regions": {
57775789
"property1": {
5790+
"healthy": true,
57785791
"node_reports": [
57795792
{
57805793
"can_exchange_messages": true,
57815794
"client_errs": [[null]],
57825795
"client_logs": [["string"]],
5796+
"healthy": true,
57835797
"node": {
57845798
"certName": "string",
57855799
"derpport": 0,
@@ -5828,11 +5842,13 @@ Parameter represents a set value for the scope.
58285842
}
58295843
},
58305844
"property2": {
5845+
"healthy": true,
58315846
"node_reports": [
58325847
{
58335848
"can_exchange_messages": true,
58345849
"client_errs": [[null]],
58355850
"client_logs": [["string"]],
5851+
"healthy": true,
58365852
"node": {
58375853
"certName": "string",
58385854
"derpport": 0,
@@ -5882,16 +5898,18 @@ Parameter represents a set value for the scope.
58825898
}
58835899
}
58845900
},
5901+
"pass": true,
58855902
"time": "string"
58865903
}
58875904
```
58885905

58895906
### Properties
58905907

5891-
| Name | Type | Required | Restrictions | Description |
5892-
| ------ | ------------------------------------------------ | -------- | ------------ | ----------- |
5893-
| `derp` | [healthcheck.DERPReport](#healthcheckderpreport) | false | | |
5894-
| `time` | string | false | | |
5908+
| Name | Type | Required | Restrictions | Description |
5909+
| ------ | ------------------------------------------------ | -------- | ------------ | ------------------------------------------------ |
5910+
| `derp` | [healthcheck.DERPReport](#healthcheckderpreport) | false | | |
5911+
| `pass` | boolean | false | | Healthy is true if the report returns no errors. |
5912+
| `time` | string | false | | Time is the time the report was generated at. |
58955913

58965914
## netcheck.Report
58975915

0 commit comments

Comments
 (0)