Repository navigation
docs: add guide for tracing workspace connections - #31342
Merged
Merged
Conversation
Correct the agent log location (system temporary directory, CODER_AGENT_LOG_DIR), document the VS Code coder.proxyLogDirectory fallback, and apply wording suggestions.
… connections guide The agent logs server_shutdown with disconnect_initiator on ssh connection complete, and only the coder ssh log carries build_id, build_reason, and transition. coderd rewrites server_shutdown to workspace_stopped in the connection log when a stop or delete build caused it.
Plugin 0.9.5 requires JetBrains Toolbox 3.9.0, and earlier plugin versions collect only Toolbox logs without a Coder support bundle. Link the Toolbox support bundle section.
Contributor
Docs previewCheck off each page once it's been reviewed. If a page changes in a later push, its checkbox clears automatically so it gets a fresh look. Pages not yet wired into the docs navigation aren't listed here. |
fioan89
reviewed
Oct 27, 2026
code-asher
approved these changes
Oct 27, 2026
fioan89
reviewed
Oct 27, 2026
fioan89
approved these changes
Oct 27, 2026
EhabY
reviewed
Oct 27, 2026
EhabY
reviewed
Oct 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a Monitoring guide for deployment administrators and platform teams to collect client,
coderd, and agent logs, correlate entries by client session ID, and interpret connection and workspace lifecycle fields. Links it from Connection logs and adds it to the docs navigation.Replaces #30707 under @matifali, carrying forward its changes and review history with accuracy fixes in 052d9e8 and the follow-up prose fixes in 3a777bf and 04feb81.
Resolves CLIENT-1032.
Preview: https://coder.com/docs/@superblink%2Fclient-1032-trace-connections/admin/monitoring/trace-connections
Note
This guide is intended for the 2.39.0 docs under the multi-PR launch exception. Coder Remote 1.17.2 and Toolbox plugin 0.9.5 must be available before merge. At the last source check, the VS Code prefix/release PRs (coder/vscode-coder#1164 and coder/vscode-coder#1165) remained open, and Toolbox 0.9.5 remained a draft release.
Validation
pwshis unavailable.Review decisions and remaining caveats
coder-*.logpattern; missing connection events can also result from reporting failures.autostopandnetwork_errorcases.