Skip to content

Include Coder support bundles in workspace diagnostics - #363

Merged
fioan89 merged 3 commits into
mainfrom
feature/workspace-support-bundles
Sep 17, 2026
Merged

fioan89 merged 3 commits into
mainfrom
feature/workspace-support-bundles

Conversation

@fioan89

@fioan89 fioan89 commented Sep 16, 2026 •

Copy link
Copy Markdown
Collaborator

Workspace log archives previously lacked Coder deployment and workspace diagnostics, so troubleshooting connection issues required collecting a separate support bundle.

In this change, we added a Coder support bundle to the Toolbox ZIP generated by an environment's Collect logs action. The plugin uses the existing deployment login to collect diagnostics for the selected workspace and its agent, when available.

Collection supports cancellation and has a two-minute timeout. If it fails, the plugin preserves the other Toolbox diagnostics and adds a failure report instead of a partial bundle.

We also documented where bundle collection is available and added tests for collection, cancellation, timeout, and cleanup.

Workspace log archives previously lacked Coder deployment and workspace
diagnostics, so troubleshooting connection issues required collecting a
separate support bundle.

In this change, we added a Coder support bundle to the Toolbox ZIP
generated by an environment's Collect logs action. The plugin uses the
existing deployment login to collect diagnostics for the selected
workspace and its agent, when available.

Collection supports cancellation and has a two-minute timeout. If it
fails, the plugin preserves the other Toolbox diagnostics and adds a
failure report instead of a partial bundle.

We also documented where bundle collection is available and added tests
for collection, cancellation, timeout, and cleanup.

@code-asher code-asher left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonderful!

Comment thread src/main/kotlin/com/coder/toolbox/cli/CoderCLIManager.kt Outdated
Comment thread src/main/kotlin/com/coder/toolbox/cli/CoderCLIManager.kt Outdated
We merged the latest workspace progress reporting changes from main and
resolved overlapping additions while preserving support-bundle collection
and coverage for both features.
The fixed two-minute limit could interrupt a valid diagnostic collection,
and the plugin discarded an inherited session token that would normally
take precedence over stored credentials.

We changed support-bundle collection to wait until the Coder CLI finishes
or the user cancels. The plugin still terminates the process on
cancellation, while the CLI can now use inherited credentials according
to its normal precedence. We also removed redundant header-command
cleanup without changing the existing header configuration behavior.

We updated the README to describe the revised behavior and removed the
obsolete timeout test. The CLI manager and diagnostic collector tests
passed, including cancellation and process cleanup coverage.
@fioan89

fioan89 commented Sep 17, 2026

Copy link
Copy Markdown
Collaborator Author
Demo-support-bundle-on-single-workspace.mp4

@fioan89
fioan89 merged commit 1bf5f11 into main Sep 17, 2026
6 checks passed
@fioan89
fioan89 deleted the feature/workspace-support-bundles branch September 17, 2026 20:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add command to create a support bundle

2 participants