Skip to content

chore(docs): add info on new build timings in docs #15310

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

chore(docs): add info on new build timings in docs #15310

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a343419
added workspace startup times
stirby Oct 31, 2024
59e08e2
added to workspace lifecycle docs
stirby Oct 31, 2024
4aafa86
fix troubleshooting link
stirby Oct 31, 2024
a721357
added future link for build timings guide
stirby Oct 31, 2024
f39e3f8
Merge branch 'main' into ws-build-time-docs
stirby Nov 1, 2024
cbc5a86
reorged troubleshooting section
stirby Nov 1, 2024
5ee74d1
docs fixup on workspace lifecycle section
stirby Nov 1, 2024
122035d
version mention
stirby Nov 1, 2024
a7f22be
fmt
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
Next Next commit
added workspace startup times
  • Loading branch information
@stirby
stirby committed Oct 31, 2024
commit a343419861ef3de8a144e390784754ca4a484f99
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.

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

Additionally, you can programmatically pull startup time measurements using our
[build timings API endpoint](../../reference/api/builds#get-workspace-build-timings-by-id).

See our guide on optimizing templates to reduce startup times to take action on
this data.
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.