Repository navigation
feat(logging): prefix output lines with the full client_session_id - #1164
Merged
Merged
Conversation
Merged
matifali
approved these changes
Oct 26, 2026
Member
|
Please also get a ✅ from @code-asher. |
code-asher
approved these changes
Oct 27, 2026
matifali
added a commit
to coder/coder
that referenced
this pull request
Oct 27, 2026
## 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](https://linear.app/codercom/issue/CLIENT-1032/document-how-a-platform-team-can-use-this-data). 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 - Full Markdown and table-format checks passed (525 files). - Emdash, docs HTML, manifest, and changed-page Vale checks passed, with zero Vale findings. - Docs self-check found no remaining verified blockers; all 28 relative links and procedure word counts passed. - Product behavior was source-verified. No live IDE/deployment validation was performed, and the PowerShell example was not executed because `pwsh` is unavailable. <details> <summary>Review decisions and remaining caveats</summary> - Keep this as a log-correlation how-to in Monitoring, not a failure-recovery procedure. The introduction and instructions reflect that scope. - Omit Coder version pins because the docs are versioned. Readers must match their Coder CLI and workspace agents to the control plane. Keep extension/plugin/Toolbox version requirements because those products release independently. - Document log pruning before new-file creation, including modification-time ordering and the `coder-*.log` pattern; missing connection events can also result from reporting failures. - Include Toolbox forwarded-channel session IDs, disambiguate terminal/speedtest logger messages, clarify nonzero command exits, and cover all documented `autostop` and `network_error` cases. - Follow merged #31289's Toolbox 3.9.0 prerequisite. The plugin's draft release notes still name 3.7.2; maintainer confirmation is needed before changing that requirement. - The optional suggestion for an invocation-level log-retention regression test was not implemented: this is a docs-only correction with no production behavior change. - The original dependency timeline and discussion remain on #30707. #30759 has since merged; the former description's unmerged status is historical. </details> > 🤖 This PR was created with the help of Coder Agents, and has been reviewed by my human. 🧑💻 --------- Co-authored-by: coder[bot] <137810501+coder[bot]@users.noreply.github.com> Co-authored-by: Coder Prototypes <294797144+coder-prototypes@users.noreply.github.com> Co-authored-by: default <default@example.com>
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes the Coder output channel line prefix from
[session <first 8 chars>]to[client_session_id=<full 32 hex id>].The
coderCLI,coderd, the agent and JetBrains Toolbox already log the full ID under theclient_session_idkey, so one search now finds a session across every log, including isolated client logs outside a support bundle.Context: coder/coder#30707 (comment)
Before:
After:
Kept as a prefix for now; moving it to a suffix to keep lines readable can follow if we want.
Generated by Coder Agents on behalf of @EhabY.