log shell

ammario · ammario · commit 62a76f4c5f20 · 2023-04-21T20:59:35.000-05:00
diff --git a/agent/agent.go b/agent/agent.go
@@ -247,11 +247,10 @@ func (*agent) collectMetadata(ctx context.Context, md codersdk.WorkspaceAgentMet
 	var out bytes.Buffer
 	result := &codersdk.WorkspaceAgentMetadataResult{
 		// CollectedAt is set here for testing purposes and overrode by
-		// the server to the time the server received the result to protect
-		// against clock skew.
+		// coderd to the time of server receipt to solve clock skew.
 		//
 		// In the future, the server may accept the timestamp from the agent
-		// if it is certain the clocks are in sync.
+		// if it can guarantee the clocks are synchronized.
 		CollectedAt: time.Now(),
 	}
 	cmd, err := createMetadataCommand(ctx, md.Script)
@@ -264,7 +263,7 @@ func (*agent) collectMetadata(ctx context.Context, md codersdk.WorkspaceAgentMet
 	cmd.Stderr = &out
 	cmd.Stdin = io.LimitReader(nil, 0)
 
-	// We split up Start and Wait so that we can return a more useful error.
+	// We split up Start and Wait instead of calling Run so that we can return a more precise error.
 	err = cmd.Start()
 	if err != nil {
 		result.Error = fmt.Sprintf("start cmd: %+v", err)
@@ -283,7 +282,7 @@ func (*agent) collectMetadata(ctx context.Context, md codersdk.WorkspaceAgentMet
 	}
 
 	if err != nil {
-		result.Error = fmt.Sprintf("run cmd: %+v", err)
+		result.Error = fmt.Sprintf("run cmd (shell %v): %+v", cmd.Path, err)
 	}
 	result.Value = out.String()
 	return result
