Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix: Add reaper to coder agent #2441

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 12 commits into from
Jun 17, 2022
Merged

fix: Add reaper to coder agent #2441

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
99ab87e
fix: Add reaper to coder agent
sreya Jun 16, 2022
5330e8c
add some comments
sreya Jun 16, 2022
b1cc536
add doc.go
sreya Jun 16, 2022
1703e6d
fix test
sreya Jun 16, 2022
2806ab9
try again
sreya Jun 16, 2022
8f2fa52
skip non-linux OS
sreya Jun 16, 2022
85d0635
Improve env marker and code conventions
sreya Jun 16, 2022
41e0165
make windows-specific stubs
sreya Jun 16, 2022
757257c
linux only
sreya Jun 16, 2022
282b583
typo
sreya Jun 16, 2022
fb11daf
whoops
sreya Jun 16, 2022
c66d7be
skip reaper tests in CI
sreya Jun 17, 2022
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
add some comments
  • Loading branch information
@sreya
sreya committed Jun 16, 2022
commit 5330e8c59e35a0a4b195bb29cdc5dc62b37a366f
5 changes: 5 additions & 0 deletions agent/reaper/reaper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ func IsChild() bool {
return os.Getenv(agentEnvMark) != ""
}

// IsInitProcess returns true if the current process's PID is 1.
func IsInitProcess() bool {
return os.Getpid() == 1
}

// ForkReap spawns a goroutine that reaps children. In order to avoid
// complications with spawning `exec.Commands` in the same process that
// is reaping, we forkexec a child process. This prevents a race between
Expand Down
28 changes: 18 additions & 10 deletions cli/agent.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"net/url"
"os"
"path/filepath"
"runtime"
"time"

"cloud.google.com/go/compute/metadata"
Expand Down Expand Up @@ -36,16 +37,6 @@ func workspaceAgent() *cobra.Command {
// This command isn't useful to manually execute.
Hidden: true,
RunE: func(cmd *cobra.Command, args []string) error {
// Spawn a reaper so that we don't accumulate a ton
// of zombie processes.
if !reaper.IsChild() {
err := reaper.ForkReap(nil)
if err != nil {
return xerrors.Errorf("fork reap: %w", err)
}
return nil
}

rawURL, err := cmd.Flags().GetString(varAgentURL)
if err != nil {
return xerrors.Errorf("CODER_AGENT_URL must be set: %w", err)
Expand All @@ -61,6 +52,23 @@ func workspaceAgent() *cobra.Command {
}
defer logWriter.Close()
logger := slog.Make(sloghuman.Sink(cmd.ErrOrStderr()), sloghuman.Sink(logWriter)).Leveled(slog.LevelDebug)

isLinux := runtime.GOOS == "linux"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any reason to limit this to linux only? I suppose this should work on Darwin and other BSD flavors too?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was causing things to fail when it ran on macos. I don't think limiting it to linux is going to be a big deal because the reaper is primarily going to be used for docker containers and on mac that's going to be run in a linux vm anyway.


// Spawn a reaper so that we don't accumulate a ton
// of zombie processes.
if reaper.IsInitProcess() && !reaper.IsChild() && isLinux {
logger.Info(cmd.Context(), "spawning reaper process")
err := reaper.ForkReap(nil)
if err != nil {
logger.Error(cmd.Context(), "failed to reap", slog.Error(err))
return xerrors.Errorf("fork reap: %w", err)
}

logger.Info(cmd.Context(), "reaper process exiting")
return nil
}

client := codersdk.New(coderURL)

if pprofEnabled {
Expand Down
7 changes: 2 additions & 5 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ require (
github.com/golang-migrate/migrate/v4 v4.15.2
github.com/google/go-github/v43 v43.0.1-0.20220414155304-00e42332e405
github.com/google/uuid v1.3.0
github.com/hashicorp/go-reap v0.0.0-20170704170343-bf58d8a43e7b
github.com/hashicorp/go-version v1.5.0
github.com/hashicorp/hc-install v0.3.2
github.com/hashicorp/hcl/v2 v2.12.0
Expand Down Expand Up @@ -134,11 +135,6 @@ require (
storj.io/drpc v0.0.30
)

require (
github.com/hashicorp/go-reap v0.0.0-20170704170343-bf58d8a43e7b // indirect
github.com/xi2/xz v0.0.0-20171230120015-48954b6210f8 // indirect
)

require (
github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect
github.com/Microsoft/go-winio v0.5.2 // indirect
Expand Down Expand Up @@ -239,6 +235,7 @@ require (
github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb // indirect
github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect
github.com/xeipuuv/gojsonschema v1.2.0 // indirect
github.com/xi2/xz v0.0.0-20171230120015-48954b6210f8 // indirect
github.com/yashtewari/glob-intersection v0.1.0 // indirect
github.com/yuin/goldmark v1.4.12 // indirect
github.com/zclconf/go-cty v1.10.0 // indirect
Expand Down