Commands can Opt-out of Logging #116
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
Signed-off-by: Ken Sipe <kensipe@gmail.com>
kensipe
requested review from
ANeumann82,
gerred,
jbarrick-mesosphere,
porridge,
zen-dog and
zmalik
as code owners
porridge
requested changes
May 22, 2020
There was a problem hiding this comment.
I have two problems with the field name:
- it is two words joined without camelCasing makint inconsistent and hard to read
- without reading the code it sounds as if this is going to not log the
running command [echo foo]message. We should mention that it's the stderr/out output that is not going to be logged. - I feel that the word
ignoreis more suited to situations where we do not react to some event (such as withignoreFailureabove. Here we kind of spontaneously decide to not do something, so I thinkskipis better.
| @@ -114,6 +114,8 @@ type Command struct { | |||
| Background bool `json:"background"` | |||
| // Override the TestSuite timeout for this command (in seconds). | |||
| Timeout int `json:"timeout"` | |||
| // If set, the command is NOT logged. Useful to sensitive logs or to reduce noise. | |||
There was a problem hiding this comment.
Suggested change
| // If set, the command is NOT logged. Useful to sensitive logs or to reduce noise. | |
| // If set, the OUTPUT from the command is NOT logged. Useful to sensitive logs or to reduce noise. |
| @@ -114,6 +114,8 @@ type Command struct { | |||
| Background bool `json:"background"` | |||
| // Override the TestSuite timeout for this command (in seconds). | |||
| Timeout int `json:"timeout"` | |||
| // If set, the command is NOT logged. Useful to sensitive logs or to reduce noise. | |||
| IgnoreLog bool `json:"ignorelog"` | |||
There was a problem hiding this comment.
Suggested change
| IgnoreLog bool `json:"ignorelog"` | |
| SkipOutputLog bool `json:"skipOutputLog"` |
There was a problem hiding this comment.
Not sure whether this should be skipLogOutput or skipOutputLog...
ANeumann82
approved these changes
May 22, 2020
|
thanks @porridge ! I struggled with the naming a bit as well... and prefer your suggestions. thanks @ANeumann82 . If debugging is needed they can always remove the flag. Your comment gave me pause to consider |
Signed-off-by: Ken Sipe <kensipe@gmail.com>
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.
Provides the ability for a command to opt-out of logging.
This is useful when:
Co-authored-by: Marcin Owsiany mowsiany@D2iQ.com
Signed-off-by: Ken Sipe kensipe@gmail.com
Fixes #