Skip to content

Commit 4e66630

Browse files
committed
fixup! Merge branch 'main' into dean/dogfood-v2
1 parent f46721f commit 4e66630

File tree

2 files changed

+17
-15
lines changed

2 files changed

+17
-15
lines changed

.github/workflows/ci.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -616,6 +616,8 @@ jobs:
616616
echo "- test-go-pg: ${{ needs.test-go-pg.result }}"
617617
echo "- test-go-race: ${{ needs.test-go-race.result }}"
618618
echo "- test-js: ${{ needs.test-js.result }}"
619+
echo "- test-e2e: ${{ needs.test-e2e.result }}"
620+
echo "- offlinedocs: ${{ needs.offlinedocs.result }}"
619621
echo
620622
621623
# We allow skipped jobs to pass, but not failed or cancelled jobs.

docs/admin/healthcheck.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ string `OK`.
1919

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

22-
### <a name="EACS01">EACS01: Access URL not set</a>
22+
### EACS01: Access URL not set
2323

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

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

28-
### <a name="EACS02">EACS02: Access URL invalid</a>
28+
### EACS02: Access URL invalid
2929

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

@@ -35,7 +35,7 @@ If there is an issue, you may see one of the following errors reported:
3535

3636
> **Tip:** You can check this [here](https://go.dev/play/p/CabcJZyTwt9).
3737
38-
### <a name="EACS03">EACS03: Failed to fetch `/healthz`</a>
38+
### EACS03: Failed to fetch `/healthz`
3939

4040
**Problem:** Coder was unable to execute a GET request to
4141
`${CODER_ACCESS_URL}/healthz`.
@@ -63,7 +63,7 @@ curl -v ${CODER_ACCESS_URL}/healthz
6363

6464
The output of this command should aid further diagnosis.
6565

66-
### <a name="EACS04">EACS04: /healthz did not return 200 OK</a>
66+
### EACS04: /healthz did not return 200 OK
6767

6868
**Problem:** Coder was able to execute a GET request to
6969
`${CODER_ACCESS_URL}/healthz`, but the response code was not `200 OK` as
@@ -84,14 +84,14 @@ should give you a good indication of the root cause.
8484
Coder continuously executes a short database query to validate that it can reach
8585
its configured database, and also measures the median latency over 5 attempts.
8686

87-
### <a name="EDB01">EDB01: Database Ping Failed</a>
87+
### EDB01: Database Ping Failed
8888

8989
**Problem:** This error code is returned if any attempt to execute this database
9090
query fails.
9191

9292
**Solution:** Investigate the health of the database.
9393

94-
### <a name="EDB02">EDB02: Database Latency High</a>
94+
### EDB02: Database Latency High
9595

9696
**Problem:** This code is returned if the median latency is higher than the
9797
[configured threshold](../cli/server.md#--health-check-threshold-database). This
@@ -120,7 +120,7 @@ traffic between Coder and workspace agents. Coder periodically queries the
120120
health of its configured DERP servers and may return one or more of the
121121
following:
122122

123-
### <a name="EDERP01">EDERP01: DERP Node Uses Websocket</a>
123+
### EDERP01: DERP Node Uses Websocket
124124

125125
**Problem:** When Coder attempts to establish a connection to one or more DERP
126126
servers, it sends a specific `Upgrade: derp` HTTP header. Some load balancers
@@ -137,7 +137,7 @@ still be able to reach their workspaces, connection performance may be degraded.
137137
**Solution:** ensure that any configured reverse proxy does not strip the
138138
`Upgrade: derp` header.
139139

140-
### <a name="EDERP02">EDERP02: One or more DERP nodes are unhealthy</a>
140+
### EDERP02: One or more DERP nodes are unhealthy
141141

142142
**Problem:** This is shown if Coder is unable to reach one or more configured
143143
DERP servers. Clients will fall back to use the remaining DERP servers, but
@@ -170,7 +170,7 @@ functionality, Coder will periodically attempt to establish a WebSocket
170170
connection with itself using the configured [Access URL](#access-url), send a
171171
message over the connection, and attempt to read back that same message.
172172

173-
### <a name="EWS01">EWS01: Failed to establish a WebSocket connection</a>
173+
### EWS01: Failed to establish a WebSocket connection
174174

175175
**Problem:** Coder was unable to establish a WebSocket connection over its own
176176
Access URL.
@@ -187,7 +187,7 @@ Access URL.
187187
2. Ensure that any reverse proxy that is sitting in front of Coder's configured
188188
access URL is not stripping the HTTP header `Upgrade: websocket`.
189189

190-
### <a name="EWS02">EWS02: Failed to echo a WebSocket message</a>
190+
### EWS02: Failed to echo a WebSocket message
191191

192192
**Problem:** Coder was able to establish a WebSocket connection, but was unable
193193
to write a message.
@@ -206,23 +206,23 @@ to write a message.
206206
If you have configured [Workspace Proxies](../admin/workspace-proxies.md), Coder
207207
will periodically query their availability and show their status here.
208208

209-
### <a name="EWP01">EWP01: Error Updating Workspace Proxy Health</a>
209+
### EWP01: Error Updating Workspace Proxy Health
210210

211211
**Problem:** Coder was unable to query the connected workspace proxies for their
212212
health status.
213213

214214
**Solution:** This may be a transient issue. If it persists, it could signify a
215215
connectivity issue.
216216

217-
### <a name="EWP02">EWP02: Error Fetching Workspace Proxies</a>
217+
### EWP02: Error Fetching Workspace Proxies
218218

219219
**Problem:** Coder was unable to fetch the stored workspace proxy health data
220220
from the database.
221221

222222
**Solution:** This may be a transient issue. If it persists, it could signify an
223223
issue with Coder's configured database.
224224

225-
### <a name="EWP03">EWP03: Workspace Proxy Version Mismatch</a>
225+
### EWP03: Workspace Proxy Version Mismatch
226226

227227
**Problem:** One or more workspace proxies are more than one major or minor
228228
version out of date with the main deployment. It is important that workspace
@@ -232,14 +232,14 @@ of API incompatibility.
232232
**Solution:** Update the workspace proxy to match the currently running version
233233
of Coder.
234234

235-
### <a name="EWP04">EWP04: One or more Workspace Proxies Unhealthy</a>
235+
### EWP04: One or more Workspace Proxies Unhealthy
236236

237237
**Problem:** One or more workspace proxies are not reachable.
238238

239239
**Solution:** Ensure that Coder can establish a connection to the configured
240240
workspace proxies on port 443.
241241

242-
## <a name="EUNKNOWN">Unknown Error</a>
242+
## Unknown Error
243243

244244
**Problem:** This error is shown when an unexpected error occurred evaluating
245245
deployment health. It may resolve on its own.

0 commit comments

Comments
 (0)