mirror of
https://github.com/coder/coder.git
synced 2026-09-21 20:51:01 +08:00
Ehab Younes
35ade9e3d2
Add workspace-side file collection to `coder support bundle` via repeatable --workspace-file flags. The agent resolves the requested paths or globs inside the remote workspace and streams back a tar with a manifest and the collected files; nothing is read from the machine running the command. - Add POST /api/v0/bundle-files to the agent's agentfiles package. - Expand env vars in the agent's environment; paths must then be absolute or start with ~/ (the agent user's home directory). - Support ** globs and tail oversized files. - Record requested patterns, per-path errors, truncation, and the applied limits in a manifest. - Unpack the archive into the bundle under agent/workspace_files/, recording dropped entries in collection_errors.txt. - Write a manifest-only archive marking collection as unsupported for agents that predate the endpoint. - Bound collection: 64 KB request body, 10000 files, 10 MiB per file, 100 MiB total including archive overhead, 110 MiB client-side read cap, 5 minute timeout. Closes #26020
81 lines
3.2 KiB
Markdown
Generated
81 lines
3.2 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 may specify a single workspace (and optionally an agent name). When run inside a workspace, the workspace and agent are inferred from the environment if not provided.
|
|
```
|
|
|
|
## 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.
|
|
|
|
### --workspace-file
|
|
|
|
| | |
|
|
|-------------|---------------------------------------------------|
|
|
| Type | <code>string-array</code> |
|
|
| Environment | <code>$CODER_SUPPORT_BUNDLE_WORKSPACE_FILE</code> |
|
|
|
|
File path or glob to collect from inside the remote workspace. Environment variables are expanded in the workspace; paths must then be absolute or start with ~/, which resolves against the agent user's home directory. Files local to the machine running this command are not collected. Can be specified multiple times.
|
|
|
|
### --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.
|