Add --log-dir flag

Author: code-asher

CHANGELOG.md

@@ -15,6 +15,10 @@
 ### Added
 
 - Extra logging around the IDE spawn to help debugging.
+- Set `--log-dir` for debugging SSH connections. These logs go into
+  `<data>/<domain>/logs` where `<domain>` is your Coder deployment's domain and
+  `<data>` is `XDG_DATA_HOME` on Linux, `LOCALAPPDATA` on Windows, and
+  `~/Library/Application Support` on macOS.
 
 ## 2.13.0 - 2024-07-16
 

src/main/kotlin/com/coder/gateway/cli/CoderCLIManager.kt

@@ -129,6 +129,7 @@ class CoderCLIManager(
     val remoteBinaryURL: URL = settings.binSource(deploymentURL)
     val localBinaryPath: Path = settings.binPath(deploymentURL, forceDownloadToData)
     val coderConfigPath: Path = settings.dataDir(deploymentURL).resolve("config")
+    val coderLogPath: Path = settings.dataDir(deploymentURL).resolve("logs")
 
     /**
      * Download the CLI from the deployment if necessary.
@@ -262,7 +263,10 @@ class CoderCLIManager(
                 "--stdio",
                 if (settings.disableAutostart && feats.disableAutostart) "--disable-autostart" else null,
             )
-        val proxyArgs = baseArgs + listOfNotNull(if (feats.reportWorkspaceUsage) "--usage-app=jetbrains" else null)
+        val proxyArgs = baseArgs + listOfNotNull(
+            "--log-dir",
+            escape(coderLogPath.toString()),
+            if (feats.reportWorkspaceUsage) "--usage-app=jetbrains" else null)
         val backgroundProxyArgs = baseArgs + listOfNotNull(if (feats.reportWorkspaceUsage) "--usage-app=disable" else null)
         val extraConfig =
             if (settings.sshConfigOptions.isNotBlank()) {
@@ -368,6 +372,8 @@ class CoderCLIManager(
         if (contents != null) {
             settings.sshConfigPath.parent.toFile().mkdirs()
             settings.sshConfigPath.toFile().writeText(contents)
+            // The Coder cli will *not* create the log directory.
+            coderLogPath.toFile().mkdirs()
         }
     }
 
@@ -453,7 +459,6 @@ class CoderCLIManager(
                 Features()
             } else {
                 Features(
-                    // Autostart with SSH was added in 2.5.0.
                     disableAutostart = version >= SemVer(2, 5, 0),
                     reportWorkspaceUsage = version >= SemVer(2, 13, 0),
                 )