From a11f349c16a4f457f36326800463e1c90e39b880 Mon Sep 17 00:00:00 2001 From: "blinkagent[bot]" <237617714+blinkagent[bot]@users.noreply.github.com> Date: Tue, 23 Jun 2026 19:22:34 +0000 Subject: [PATCH] docs: document log collection for Coder Desktop on macOS and Windows (#26631) Co-authored-by: blink-so[bot] <211532188+blink-so[bot]@users.noreply.github.com> Co-authored-by: Atif Ali --- .github/.linkspector.yml | 1 + docs/user-guides/desktop/index.md | 56 +++++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+) diff --git a/.github/.linkspector.yml b/.github/.linkspector.yml index 012d9e7697..b93ed78e3f 100644 --- a/.github/.linkspector.yml +++ b/.github/.linkspector.yml @@ -25,6 +25,7 @@ ignorePatterns: - pattern: "www.gnu.org" - pattern: "wiki.ubuntu.com" - pattern: "mutagen.io" + - pattern: "dotnet.microsoft.com" - pattern: "docs.github.com" - pattern: "claude.ai" - pattern: "splunk.com" diff --git a/docs/user-guides/desktop/index.md b/docs/user-guides/desktop/index.md index bbcb657df6..e458883505 100644 --- a/docs/user-guides/desktop/index.md +++ b/docs/user-guides/desktop/index.md @@ -169,6 +169,62 @@ You can also configure a `Updater:ForcedChannel` string value to lock users to a - Check system permissions for network extensions - Ensure only one copy of Coder Desktop is installed +### Collecting Logs + +When reporting an issue, attach the relevant log files so we can diagnose it faster. + +
+ +#### macOS + +Coder Desktop and its network extension write to the Apple [unified logging system](https://developer.apple.com/documentation/os/logging). The file sync (Mutagen) daemon writes to a separate log file. + +1. Export the unified logs for the last hour with the `log` command: + + ```shell + log show --predicate 'subsystem == "com.coder.Coder-Desktop"' \ + --info --debug --last 1h > ~/Desktop/coder-desktop.log + ``` + + Adjust `--last` (e.g. `30m`, `2h`, `1d`) to cover the time the issue occurred. You can also view the same logs interactively in **Console.app** by filtering on the `com.coder.Coder-Desktop` subsystem. + +2. If you're using file sync, also collect the Mutagen daemon log: + + ```shell + ~/Library/Application\ Support/Coder\ Desktop/Mutagen/daemon.log + ``` + + Coder Desktop also opens this file in Console automatically when the file sync daemon fails. + +#### Windows + +Coder Desktop has three components that write logs: the app (UI), the VPN service, and the file sync (Mutagen) daemon. + +1. App log (daily rolling): + + ```powershell + %LOCALAPPDATA%\CoderDesktop\app.log + ``` + +2. VPN service log (default install path): + + ```powershell + C:\Program Files\Coder Desktop\coder-desktop-service.log + ``` + +3. File sync (Mutagen) daemon log, if you use file sync: + + ```powershell + %LOCALAPPDATA%\CoderDesktop\mutagen\daemon.log + ``` + +You can quickly open the app log directory by pasting `%LOCALAPPDATA%\CoderDesktop` into File Explorer. + +
+ +> [!TIP] +> Before attaching logs to a public issue, review them for any sensitive information (deployment URLs, usernames, hostnames) and redact as needed. + ### Getting Help If you encounter issues not covered here: