Skip to content

feat(coderd/healthcheck): add access URL error codes and healthcheck doc #10915

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Nov 30, 2023
Merged

feat(coderd/healthcheck): add access URL error codes and healthcheck doc #10915

Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
2f5530f
feat(coderd/healthcheck): add access URL error codes and healthcheck doc
johnstcn Nov 28, 2023
87e5f26
feat(coderd/healthcheck: add error codes for the rest of the owl
johnstcn Nov 28, 2023
1994ce1
add remaining health codes, todo writing words
johnstcn Nov 28, 2023
00505c9
database: assert that we put the right codes in the right places
johnstcn Nov 30, 2023
6cdc918
add words about database
johnstcn Nov 30, 2023
179fa17
Update docs/admin/healthcheck.md
johnstcn Nov 30, 2023
970cf5d
Update docs/admin/healthcheck.md
johnstcn Nov 30, 2023
1b56493
add DERP words
johnstcn Nov 30, 2023
942513e
add some words about websockets
johnstcn Nov 30, 2023
f259c25
add playground link for access url
johnstcn Nov 30, 2023
decf017
add more words about workspace proxies
johnstcn Nov 30, 2023
26c522e
add icon and manifest
johnstcn Nov 30, 2023
45f1689
make fmt
johnstcn Nov 30, 2023
aed87f4
address comments
johnstcn Nov 30, 2023
7bfe253
appease linter
johnstcn Nov 30, 2023
1bf956a
add another note about troubleshooting websockets
johnstcn Nov 30, 2023
f9494c8
adjust icon viewBox
johnstcn Nov 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
add words about database
  • Loading branch information
@johnstcn
johnstcn committed Nov 30, 2023
commit 6cdc91845f701840696081fc2ff2a1666db10422
24 changes: 20 additions & 4 deletions docs/admin/healthcheck.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,29 @@ should give you a good indication of the root cause.

## Database

### <a name="EDB01">EDB01: TODO</a>
Coder continuously executes a short database query to validate that it can reach its configured database, and also
measures the median latency over 5 attempts.

TODO
### <a name="EDB01">EDB01: Database Ping Failed</a>

### <a name="EDB02">EDB02: TODO</a>
**Problem:** This error code is returned if any attempt to execute this database query fails.

TODO
**Solution:** Investigate the health of the database.

### <a name="EDB02">EDB02: Database Ping Slow</a>

**Problem:** This code is returned if the median latency is higher than the [configured threshold](../cli/server.md#--health-check-threshold-database).
This may not be an error as such, but is an indication of a potential issue.

**Solution:** Investigate the sizing of the configured database with regard to Coder's current activity and usage. It
may be necessary to increase the resources allocated to Coder's database. Alternatively, you can raise the configured
threshold to a higher value (this will not address the root cause).

> 💡 Tip:
> - You can enable [detailed database metrics](../cli/server.md#--prometheus-collect-db-metrics) in Coder's
> Prometheus endpoint.
> - Fif you have [tracing enabled](../cli/server.md#--trace), these traces may also contain useful information regarding
> Coder's database activity.

## DERP

Expand Down