Commit399c830

authored

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

Adds information on workspace build timings in workspace lifecycle andtemplate troubleshooting docs.

1 parente232aee commit399c830Copy full SHA for 399c830

File tree

+27

-0

lines changed

+27

-0

lines changed

Lines changed: 14 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -154,3 +154,17 @@ the top of the script to exit on error.`
`154`	`154`
`155`	`155`	>Note: If you aren't seeing any logs, check that the`dir` directive points
`156`	`156`	`>to a valid directory in the file system.`
	`157`	`+`
	`158`	`+##Slow workspace startup times`
	`159`	`+`
	`160`	`+If your workspaces are taking longer to start than expected, or longer than`
	`161`	`+desired, you can diagnose which steps have the highest impact in the workspace`
	`162`	`+build timings UI (available in v2.17 and beyond). Admins can can`
	`163`	`+programmatically pull startup times for individual workspace builds using our`
	`164`	`+[build timings API endpoint](../../reference/api/builds.md#get-workspace-build-timings-by-id).`
	`165`	`+`
	`166`	`+See our`
	`167`	`+[guide on optimizing workspace build times](../../tutorials/best-practices/speed-up-templates.md)`
	`168`	`+to optimize your templates based on this data.`
	`169`	`+`
	`170`	`+![Workspace build timings UI](../../images/admin/templates/troubleshooting/workspace-build-timings-ui.png)`

141 KB

Lines changed: 13 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -109,6 +109,19 @@ your template's Terraform file and the target resources on your infrastructure.`
`109`	`109`	`Unhealthy workspaces are usually caused by a misconfiguration in the agent or`
`110`	`110`	`workspace startup scripts.`
`111`	`111`
	`112`	`+##Workspace build times`
	`113`	`+`
	`114`	`+After a successful build, you can see a timing breakdown of the workspace`
	`115`	`+startup process from the dashboard (starting in v2.17). We capture and display`
	`116`	`+both time taken to provision the workspace's compute and agent startup steps.`
	`117`	`+These include any`
	`118`	+[`coder_script`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/script)s
	`119`	`+such as[dotfiles](./workspace-dotfiles.md) or`
	`120`	+[`coder_app`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/app)
	`121`	`+startups.`
	`122`	`+`
	`123`	`+![Workspace build timings UI](../images/admin/templates/troubleshooting/workspace-build-timings-ui.png)`
	`124`	`+`
`112`	`125`	`###Next steps`
`113`	`126`
`114`	`127`	`-[Connecting to your workspace](./index.md)`

Comments

(0)