chore(agent/agentscripts): log command cancellation (#16324)

johnstcn · dannykopping · aslilac · commit 225c5f90122c · 2025-01-29T22:12:48.000Z
Relates to coder/internal#329 It's currently unclear where the SIGHUP came from; adding some logging to make it more clear if it happens again in future. --------- Co-authored-by: Danny Kopping <danny@coder.com>
diff --git a/agent/agentscripts/agentscripts.go b/agent/agentscripts/agentscripts.go
@@ -290,7 +290,7 @@ func (r *Runner) run(ctx context.Context, script codersdk.WorkspaceAgentScript,
 	cmd = cmdPty.AsExec()
 	cmd.SysProcAttr = cmdSysProcAttr()
 	cmd.WaitDelay = 10 * time.Second
-	cmd.Cancel = cmdCancel(cmd)
+	cmd.Cancel = cmdCancel(ctx, logger, cmd)
 
 	// Expose env vars that can be used in the script for storing data
 	// and binaries. In the future, we may want to expose more env vars
diff --git a/agent/agentscripts/agentscripts_other.go b/agent/agentscripts/agentscripts_other.go
@@ -3,8 +3,11 @@
 package agentscripts
 
 import (
+	"context"
 	"os/exec"
 	"syscall"
+
+	"cdr.dev/slog"
 )
 
 func cmdSysProcAttr() *syscall.SysProcAttr {
@@ -13,8 +16,9 @@ func cmdSysProcAttr() *syscall.SysProcAttr {
 	}
 }
 
-func cmdCancel(cmd *exec.Cmd) func() error {
+func cmdCancel(ctx context.Context, logger slog.Logger, cmd *exec.Cmd) func() error {
 	return func() error {
+		logger.Debug(ctx, "cmdCancel: sending SIGHUP to process and children", slog.F("pid", cmd.Process.Pid))
 		return syscall.Kill(-cmd.Process.Pid, syscall.SIGHUP)
 	}
 }
diff --git a/agent/agentscripts/agentscripts_windows.go b/agent/agentscripts/agentscripts_windows.go
@@ -1,17 +1,21 @@
 package agentscripts
 
 import (
+	"context"
 	"os"
 	"os/exec"
 	"syscall"
+
+	"cdr.dev/slog"
 )
 
 func cmdSysProcAttr() *syscall.SysProcAttr {
 	return &syscall.SysProcAttr{}
 }
 
-func cmdCancel(cmd *exec.Cmd) func() error {
+func cmdCancel(ctx context.Context, logger slog.Logger, cmd *exec.Cmd) func() error {
 	return func() error {
+		logger.Debug(ctx, "cmdCancel: sending interrupt to process", slog.F("pid", cmd.Process.Pid))
 		return cmd.Process.Signal(os.Interrupt)
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,11 @@`
`3`	`3`	`package agentscripts`
`4`	`4`
`5`	`5`	`import (`
	`6`	`+ "context"`
`6`	`7`	`"os/exec"`
`7`	`8`	`"syscall"`
	`9`	`+`
	`10`	`+ "cdr.dev/slog"`
`8`	`11`	`)`
`9`	`12`
`10`	`13`	`func cmdSysProcAttr() *syscall.SysProcAttr {`
`@@ -13,8 +16,9 @@ func cmdSysProcAttr() *syscall.SysProcAttr {`
`13`	`16`	`}`
`14`	`17`	`}`
`15`	`18`
`16`		`-func cmdCancel(cmd *exec.Cmd) func() error {`
	`19`	`+func cmdCancel(ctx context.Context, logger slog.Logger, cmd *exec.Cmd) func() error {`
`17`	`20`	`return func() error {`
	`21`	`+ logger.Debug(ctx, "cmdCancel: sending SIGHUP to process and children", slog.F("pid", cmd.Process.Pid))`
`18`	`22`	`return syscall.Kill(-cmd.Process.Pid, syscall.SIGHUP)`
`19`	`23`	`}`
`20`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,17 +1,21 @@`
`1`	`1`	`package agentscripts`
`2`	`2`
`3`	`3`	`import (`
	`4`	`+ "context"`
`4`	`5`	`"os"`
`5`	`6`	`"os/exec"`
`6`	`7`	`"syscall"`
	`8`	`+`
	`9`	`+ "cdr.dev/slog"`
`7`	`10`	`)`
`8`	`11`
`9`	`12`	`func cmdSysProcAttr() *syscall.SysProcAttr {`
`10`	`13`	`return &syscall.SysProcAttr{}`
`11`	`14`	`}`
`12`	`15`
`13`		`-func cmdCancel(cmd *exec.Cmd) func() error {`
	`16`	`+func cmdCancel(ctx context.Context, logger slog.Logger, cmd *exec.Cmd) func() error {`
`14`	`17`	`return func() error {`
	`18`	`+ logger.Debug(ctx, "cmdCancel: sending interrupt to process", slog.F("pid", cmd.Process.Pid))`
`15`	`19`	`return cmd.Process.Signal(os.Interrupt)`
`16`	`20`	`}`
`17`	`21`	`}`