mirror of
https://github.com/coder/coder.git
synced 2026-06-03 13:08:25 +00:00
Rowan Smith
b163b4c950
- 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
72 lines
2.5 KiB
Markdown
Generated
72 lines
2.5 KiB
Markdown
Generated
<!-- DO NOT EDIT | GENERATED CONTENT -->
|
|
# support bundle
|
|
|
|
Generate a support bundle to troubleshoot issues connecting to a workspace.
|
|
|
|
## Usage
|
|
|
|
```console
|
|
coder support bundle [flags] <workspace> [<agent>]
|
|
```
|
|
|
|
## Description
|
|
|
|
```console
|
|
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 | <code>bool</code> |
|
|
|
|
Bypass confirmation prompts.
|
|
|
|
### -O, --output-file
|
|
|
|
| | |
|
|
|-------------|------------------------------------------------|
|
|
| Type | <code>string</code> |
|
|
| Environment | <code>$CODER_SUPPORT_BUNDLE_OUTPUT_FILE</code> |
|
|
|
|
File path for writing the generated support bundle. Defaults to coder-support-$(date +%s).zip.
|
|
|
|
### --url-override
|
|
|
|
| | |
|
|
|-------------|-------------------------------------------------|
|
|
| Type | <code>string</code> |
|
|
| Environment | <code>$CODER_SUPPORT_BUNDLE_URL_OVERRIDE</code> |
|
|
|
|
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 | <code>int</code> |
|
|
| Environment | <code>$CODER_SUPPORT_BUNDLE_WORKSPACES_TOTAL_CAP</code> |
|
|
|
|
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 | <code>string</code> |
|
|
| Environment | <code>$CODER_SUPPORT_BUNDLE_TEMPLATE</code> |
|
|
|
|
Template name to include in the support bundle. Use org_name/template_name if template name is reused across multiple organizations.
|
|
|
|
### --pprof
|
|
|
|
| | |
|
|
|-------------|------------------------------------------|
|
|
| Type | <code>bool</code> |
|
|
| Environment | <code>$CODER_SUPPORT_BUNDLE_PPROF</code> |
|
|
|
|
Collect pprof profiling data from the Coder server and agent. Requires Coder server version 2.28.0 or newer.
|