Skip to content

Commit 8080874

Browse files
committed
add remaining health codes, todo writing words
1 parent 5ea61dd commit 8080874

File tree

1 file changed

+50
-4
lines changed

1 file changed

+50
-4
lines changed

docs/admin/healthcheck.md

Lines changed: 50 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,20 @@ validate that the response is `200 OK`.
1818

1919
If there is an issue, you may see one of the following errors reported:
2020

21-
### <a name="EACSURL01">EACSURL01: Access URL not set</a>
21+
### <a name="EACS01">EACS01: Access URL not set</a>
2222

2323
**Problem:** no access URL has been configured.
2424

2525
**Solution:** configure an [access URL](./configure.md#access-url) for Coder.
2626

27-
### <a name="EACSURL02">EACSURL02: Access URL invalid</a>
27+
### <a name="EACS02">EACS02: Access URL invalid</a>
2828

2929
**Problem:** `${CODER_ACCESS_URL}/healthz` is not a valid URL.
3030

3131
**Solution:** Ensure that the access URL is a valid URL accepted by
3232
[`url.Parse`](https://pkg.go.dev/net/url#Parse).
3333

34-
### <a name="EACSURL03">EACSURL03: Failed to fetch /healthz</a>
34+
### <a name="EACS03">EACS03: Failed to fetch /healthz</a>
3535

3636
**Problem:** Coder was unable to execute a GET request to
3737
`${CODER_ACCESS_URL}/healthz`.
@@ -54,7 +54,7 @@ curl -v ${CODER_ACCESS_URL}
5454

5555
The output of this command should aid further diagnosis.
5656

57-
### <a name="EACSURL04">EACSURL04: /healthz did not return 200 OK</a>
57+
### <a name="EACS04">EACS04: /healthz did not return 200 OK</a>
5858

5959
**Problem:** Coder was able to execute a GET request to
6060
`${CODER_ACCESS_URL}/healthz`, but the response code was not `200 OK` as
@@ -72,8 +72,54 @@ should give you a good indication of the root cause.
7272

7373
## Database
7474

75+
### <a name="EDB01">EDB01: TODO</a>
76+
77+
TODO
78+
79+
### <a name="EDB02">EDB02: TODO</a>
80+
81+
TODO
82+
7583
## DERP
7684

85+
### <a name="EDERP01">EDERP01: TODO</a>
86+
87+
TODO
88+
89+
### <a name="EDERP02">EDERP02: TODO</a>
90+
91+
TODO
92+
7793
## Websocket
7894

95+
### <a name="EWS01">EWS01: TODO</a>
96+
97+
TODO
98+
99+
### <a name="EWS02">EWS02: TODO</a>
100+
101+
TODO
102+
79103
## Workspace Proxy
104+
105+
### <a name="EWP01">EWP01: TODO</a>
106+
107+
TODO
108+
109+
### <a name="EWP02">EWP02: TODO</a>
110+
111+
TODO
112+
113+
### <a name="EWP03">EWP03: TODO</a>
114+
115+
TODO
116+
117+
### <a name="EWP04">EWP04: TODO</a>
118+
119+
TODO
120+
121+
## <a name="EUNKNOWN">Unknown Error</a>
122+
123+
**Problem:** lazy dev
124+
125+
**Solution:** motivate them with cheese

0 commit comments

Comments
 (0)