docs: clarify Toolbox logs and remove duplicate cross-reference
This commit is contained in:
1 parent
f1759d9cdc
commit
3a777bf195
2 files changed
+7
-4
No files matched your search
@@ -198,8 +198,6 @@ Example of a [human readable](../../reference/cli/server/index.md#--log-human) c
|
||||
2026-10-07 11:34:37.428 [info] coderd: connection_log ID=909a0310-a14c-4761-89d3-9779a328f14f OrganizationID=dc39157d-b298-415d-8fc7-590e9055f244 WorkspaceOwnerID=17f1cc14-ac7a-4703-976e-73ea4547dceb WorkspaceID=f2e648d4-95bc-4df3-a5c2-ee5be991da29 WorkspaceName=dev AgentName=main ConnectionMethod=workspace_app Code=200 IP=127.0.0.1 UserAgent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.4896.127 Safari/537.36" UserID=17f1cc14-ac7a-4703-976e-73ea4547dceb AppNameOrPort=code-server ConnectionID=<nil> DisconnectReason="" ClientSessionID="" Time="2026-10-07 11:34:37.428773435 +0000 UTC" ConnectionStatus=connected
|
||||
```
|
||||
|
||||
To follow one client session across client, `coderd`, and agent logs with `ClientSessionID`, refer to [Trace workspace connections](./trace-connections.md).
|
||||
|
||||
## Data Retention
|
||||
|
||||
Coder supports configurable retention policies that automatically purge old Connection Logs.
|
||||
|
||||
@@ -95,13 +95,18 @@ To change the number of entries, set `coder.connectionLogBuffer.size`.
|
||||
|
||||
Toolbox starts `coder ssh`.
|
||||
Toolbox log lines for a session include the full 32-character `client_session_id`.
|
||||
With Coder Toolbox plugin version 0.9.5 or later, the plugin chooses the directory for the `coder ssh` logs: the SSH log directory in the Coder plugin settings, then `CODER_SSH_LOG_DIR`, then an `ssh-logs` directory in the plugin's data directory for the deployment.
|
||||
With Coder Toolbox plugin version 0.9.5 or later, the plugin first checks the SSH log directory in the Coder plugin settings.
|
||||
If that setting is empty, it uses `CODER_SSH_LOG_DIR`.
|
||||
If neither is set, it uses an `ssh-logs` directory in the plugin's data directory for the deployment.
|
||||
|
||||
Ask the user to select **Collect logs** from the workspace action menu.
|
||||
With plugin version 0.9.5 or later, successful collection includes Toolbox logs and a nested Coder support bundle, `coder-support.zip`.
|
||||
The nested bundle contains recent `coder ssh` logs under `toolbox-logs/ssh/`.
|
||||
If Coder bundle collection fails, the plugin attempts to include the SSH logs in `coder-ssh.zip` and collection details in `coder-support-error.txt`.
|
||||
|
||||
With earlier plugin versions, **Collect logs** includes only the Toolbox logs.
|
||||
In that case, `coder ssh` writes to the [`coder ssh` log directory](#coder-ssh) unless an SSH log directory is set in the plugin settings, so ask the user for those files separately and [generate a support bundle with the CLI](../../support/support-bundle.md#generate-with-the-cli).
|
||||
These versions write `coder ssh` logs to the [`coder ssh` log directory](#coder-ssh), unless an SSH log directory is set in the plugin settings.
|
||||
Ask the user for those files separately and [generate a support bundle with the CLI](../../support/support-bundle.md#generate-with-the-cli).
|
||||
For details, refer to [Generate a support bundle](../../support/support-bundle.md) and [JetBrains Toolbox troubleshooting](../../user-guides/workspace-access/jetbrains/toolbox.md#troubleshooting).
|
||||
|
||||
### Web terminal
|
||||
|
||||
Reference in new issue
Block a user