mirror of https://github.com/coder/coder.git synced 2026-06-03 13:08:25 +00:00

Files

T

Rowan Smith b163b4c950 feat: support bundle updates to enable pprof and telemetry collection (#21486 )

- Adds pprof collection support now that we have the listeners
automatically starting (requires Coder server 2.28.0+, includes a
version check). Collects heap, allocs, profile (30s), block, mutex,
goroutine, threadcreate, trace (30s), cmdline, symbol. Performs capture
for 30 seconds and emits a log line stating as such. Enable capture by
supplying the `--pprof` flag or `CODER_SUPPORT_BUNDLE_PPROF` env var.
Collection of pprof data from both coderd and the Coder agent occurs.
- Adds collection of Prometheus metrics, also requires 2.28.0+
- Adds the ability to include a template in the bundle independently of
supplying the details of a running workspace by supplying the
`--template` flag or `CODER_SUPPORT_BUNDLE_TEMPLATE` env var
- Captures a list of workspaces the user has access to. Defaults to a
max of 10, configurable via `--workspaces-total-cap` /
`CODER_SUPPORT_BUNDLE_WORKSPACES_TOTAL_CAP`
- Collects additional stats from the coderd deployment (aggregated
workspace/session metrics), as well as entitlements via license and
dismissed health checks.

created with help from mux

2026-01-20 10:28:52 +11:00

2.5 KiB

Generated

Raw Blame History

support bundle

Generate a support bundle to troubleshoot issues connecting to a workspace.

Usage

coder support bundle [flags] <workspace> [<agent>]

Description

This command generates a file containing detailed troubleshooting information about the Coder deployment and workspace connections. You must specify a single workspace (and optionally an agent name).

Options

-y, --yes


Type	`bool`

Bypass confirmation prompts.

-O, --output-file


Type	`string`
Environment	`$CODER_SUPPORT_BUNDLE_OUTPUT_FILE`

File path for writing the generated support bundle. Defaults to coder-support-$(date +%s).zip.

--url-override


Type	`string`
Environment	`$CODER_SUPPORT_BUNDLE_URL_OVERRIDE`

Override the URL to your Coder deployment. This may be useful, for example, if you need to troubleshoot a specific Coder replica.

--workspaces-total-cap


Type	`int`
Environment	`$CODER_SUPPORT_BUNDLE_WORKSPACES_TOTAL_CAP`

Maximum number of workspaces to include in the support bundle. Set to 0 or negative value to disable the cap. Defaults to 10.

--template


Type	`string`
Environment	`$CODER_SUPPORT_BUNDLE_TEMPLATE`

Template name to include in the support bundle. Use org_name/template_name if template name is reused across multiple organizations.

--pprof


Type	`bool`
Environment	`$CODER_SUPPORT_BUNDLE_PPROF`

Collect pprof profiling data from the Coder server and agent. Requires Coder server version 2.28.0 or newer.

2.5 KiB Generated Raw Blame History