Skip to content

chore: cherry pick PRs for 2.17 #15339

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 10 commits into from
Nov 1, 2024
Merged

chore: cherry pick PRs for 2.17 #15339

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
aa8e262
fix: workspaces query to correctly user username from users table (#1…
Emyrk Oct 31, 2024
d799404
refactor(site): refactor DAU chart to avoid seat consumption focus (#…
BrunoQuaresma Oct 31, 2024
0cd5066
chore(cli): drop 'notification' prefix for configuring email auth (#1…
DanielleMaywood Oct 30, 2024
ced50fc
chore: fix concurrent `CommitQuota` transactions for unrelated users/…
Emyrk Nov 1, 2024
041eb99
feat: add prometheus metric for tracking user statuses (#15281)
coadler Oct 30, 2024
920c275
feat: add audit logs for dormancy events (#15298)
coadler Oct 31, 2024
131cb0d
docs: add new best practice doc to speed up templates and workspaces …
EdwardAngert Nov 1, 2024
7d44613
chore(docs): add documentation on custom roles (#15280)
stirby Oct 30, 2024
bc92a19
chore(docs): include custom roles examples and mention of password re…
stirby Oct 30, 2024
48f7555
chore(docs): add info on new build timings in docs (#15310)
stirby Nov 1, 2024
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
chore(docs): add info on new build timings in docs (#15310) 
Adds information on workspace build timings in workspace lifecycle and
template troubleshooting docs.

(cherry picked from commit 399c830)
  • Loading branch information
@stirby
stirby committed Nov 1, 2024
commit 48f7555e917dc352c0c861f7bf35a54707d0c01e
14 changes: 14 additions & 0 deletions docs/admin/templates/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,3 +154,17 @@ the top of the script to exit on error.

> **Note:** If you aren't seeing any logs, check that the `dir` directive points
> to a valid directory in the file system.

## Slow workspace startup times

If your workspaces are taking longer to start than expected, or longer than
desired, you can diagnose which steps have the highest impact in the workspace
build timings UI (available in v2.17 and beyond). Admins can can
programmatically pull startup times for individual workspace builds using our
[build timings API endpoint](../../reference/api/builds.md#get-workspace-build-timings-by-id).

See our
[guide on optimizing workspace build times](../../tutorials/best-practices/speed-up-templates.md)
to optimize your templates based on this data.

![Workspace build timings UI](../../images/admin/templates/troubleshooting/workspace-build-timings-ui.png)
Binary file added docs/images/admin/templates/troubleshooting/workspace-build-timings-ui.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions docs/user-guides/workspace-lifecycle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,19 @@ your template's Terraform file and the target resources on your infrastructure.
Unhealthy workspaces are usually caused by a misconfiguration in the agent or
workspace startup scripts.

## Workspace build times

After a successful build, you can see a timing breakdown of the workspace
startup process from the dashboard (starting in v2.17). We capture and display
both time taken to provision the workspace's compute and agent startup steps.
These include any
[`coder_script`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/script)s
such as [dotfiles](./workspace-dotfiles.md) or
[`coder_app`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/app)
startups.

![Workspace build timings UI](../images/admin/templates/troubleshooting/workspace-build-timings-ui.png)

### Next steps

- [Connecting to your workspace](./index.md)
Expand Down
Loading