Skip to content

feat(cli/ssh): simplify log file flags #7863

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Jun 12, 2023
Merged

feat(cli/ssh): simplify log file flags #7863

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
4b3b2bd
feat(cli/ssh): simplify log file flags
ammario Jun 5, 2023
82ce7a2
Fix race
ammario Jun 6, 2023
ad2c946
Fix race the right way
ammario Jun 6, 2023
1ca5930
Restore directory flag
ammario Jun 6, 2023
d7b26ad
Update tests
ammario Jun 6, 2023
48cb9b2
make
ammario Jun 6, 2023
3c43cfc
Merge remote-tracking branch 'origin/main' into log-race
ammario Jun 7, 2023
a1b68e5
mess around
ammario Jun 8, 2023
23a6833
Fix another race
ammario Jun 8, 2023
f17e7ce
fixup! Fix another race
ammario Jun 8, 2023
5a311b3
Update cli/ssh.go
ammario Jun 8, 2023
65cdbcc
Move CloseStdin into clibase
ammario Jun 9, 2023
d1cb325
Merge remote-tracking branch 'origin/main' into log-race
ammario Jun 9, 2023
8471555
Revert "Move CloseStdin into clibase"
ammario Jun 10, 2023
6593dfe
Merge remote-tracking branch 'origin/main' into log-race
ammario Jun 10, 2023
c5a1968
Spike-ify
ammario Jun 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix race
  • Loading branch information
@ammario
ammario committed Jun 6, 2023
commit 82ce7a21410c038d8c83e3bd1e16311df125e876
14 changes: 12 additions & 2 deletions cli/ssh.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,18 @@ func (r *RootCmd) ssh() *clibase.Cmd {
if err != nil {
return xerrors.Errorf("error opening %s for logging: %w", logFilePath, err)
}
logger = slog.Make(sloghuman.Sink(logFile))
defer logFile.Close()
// HACK: Something was keeping a reference to this file
// after the goroutine ends, leading to the race observed
// here: https://github.com/coder/coder/actions/runs/5178818818/jobs/9331016395.
rd, wr := io.Pipe()
go func() {
_, _ = io.Copy(logFile, rd)
}()
defer func() {
_ = wr.Close()
_ = logFile.Close()
}()
logger = slog.Make(sloghuman.Sink(wr))
if r.verbose {
logger = logger.Leveled(slog.LevelDebug)
}
Expand Down
4 changes: 3 additions & 1 deletion cli/ssh_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,10 +441,12 @@ func TestSSH(t *testing.T) {
pty.WriteLine("exit")
<-cmdDone

_, err := os.Stat(logFile)
info, err := os.Stat(logFile)
if err != nil {
t.Fatalf("failed to find ssh logfile: %v", err)
}

require.Greater(t, info.Size(), int64(0), "ssh logfile is empty")
})
}

Expand Down
22 changes: 6 additions & 16 deletions docs/cli/ssh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,24 +39,14 @@ Specifies whether to forward the GPG agent. Unsupported on Windows workspaces, b

Specifies which identity agent to use (overrides $SSH_AUTH_SOCK), forward agent must also be enabled.

### --log-dir
### -l, --log-file

| | |
| ----------- | ------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_LOG_DIR</code> |
| Default | <code>/tmp</code> |

Specify the location for the log files.

### -l, --log-to-file

| | |
| ----------- | ----------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_LOG_TO_FILE</code> |
| | |
| ----------- | -------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_LOG_FILE</code> |

Enable diagnostic logging to file.
Specify the location of an SSH diagnostic log file.

### --no-wait

Expand Down