feat(jobreceiver): Implement the command package #1240
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds a new jobreceiver/command package that encapsulates the handling of executing commands. Mostly borrowed from sensu-go's robust commands package used by it's multi-platform agents. Signed-off-by: Christian Kruse <[email protected]>
c-kruse
force-pushed
the
ck/jobreceiver-command
branch
from
ea23a21 to
7393266
Compare
Signed-off-by: Christian Kruse <[email protected]>
c-kruse
force-pushed
the
ck/jobreceiver-command
branch
from
7393266 to
c407b49
Compare
Signed-off-by: Christian Kruse <[email protected]>
Signed-off-by: Christian Kruse <[email protected]>
c-kruse
force-pushed
the
ck/jobreceiver-command
branch
from
d23dfe8 to
98c5bea
Compare
Signed-off-by: Christian Kruse <[email protected]>
Signed-off-by: Christian Kruse <[email protected]>
echlebek
reviewed
Sep 11, 2023
swiatekm
reviewed
Sep 22, 2023
Signed-off-by: Christian Kruse <[email protected]>
swiatekm
approved these changes
Sep 22, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implements
pkg/receiver/jobreceiver/command/commandI had a hard time with this one. I started by copying the work @portertech did in the PoC that had been adapted from sensu, but I ran into several issues.
First. The sensu command package had lots of opinionated behavior that I felt was not appropriate to copy over. Things like timeout behavior (hard coding exit code 2 and writing a blurb to stderr). More difficult to suss out was the bespoke timeout, process group and cleanup logic that all seemed geared towards the assumption of a shell environment (which is no longer obligated.)
Second. Our usage pattern here is different than Sensu's. Sensu's command interface buffers the entirety of command output before returning it to the caller. Here we need to stream that output to the pipeline to accommodate the log_entries output format. Handling this inner process communication is actually quite nuanced. Go's os/exec package takes a reasonable approach to handling this with exec.Cmd.Std[out|err]Pipe but it wasn't particularly compatible with sensu's command interface or the way it was doing timeouts.
In the end I decided to lean towards default behavior and accept that we may end up needing to re-learn some of lessons in the future.