[Heartbeat] Stop logging sensitive params #28774
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
This change causes heartbeat to no longer log parameter values, instead interpolating an opaque string. Fixes elastic#28771 We now create logs like: ``` 2021-11-02T17:25:27.804-0500 INFO synthexec/synthexec.go:148 Running command: /tmp/elastic-synthetics-unzip-714880603/node_modules/.bin/elastic-synthetics /tmp/elastic-synthetics-unzip-714880603/node_modules/.bin/elastic-synthetics /tmp/elastic-synthetics-unzip-714880603 --screenshots on --rich-events --params "{1 hidden params}" in directory: '/tmp/elastic-synthetics-unzip-714880603' ```
|
Pinging @elastic/uptime (Team:Uptime) |
andrewvc
commented
Nov 2, 2021
| @@ -122,11 +122,6 @@ func runCmd( | |||
| cmd.Env = append(os.Environ(), "NODE_ENV=production") | |||
| cmd.Args = append(cmd.Args, "--rich-events") | |||
|
|
|||
| if len(params) > 0 { | |||
There was a problem hiding this comment.
I moved this lower since that we we only have to instantiate loggableCmd once without updating args as they are added.
💚 Build Succeeded
Expand to view the summary
Build stats
Test stats 🧪
💚 Flaky test reportTests succeeded. 🤖 GitHub commentsTo re-run your PR in the CI, just comment with:
|
vigneshshanmugam
approved these changes
Nov 2, 2021
| @@ -135,14 +130,22 @@ func runCmd( | |||
| cmd.Args = append(cmd.Args, "--match", filterJourneys.Match) | |||
| } | |||
|
|
|||
| // Variant of the command with no params, which could contain sensitive stuff | |||
| loggableCmd := exec.Command(cmd.Path, cmd.Args...) | |||
There was a problem hiding this comment.
can we move this inside if statement and do only if user has specified params. We could initialize it with loggableCmd as cmd till this point.
There was a problem hiding this comment.
We can't do that really since we use it further down outside the if.
There was a problem hiding this comment.
My comment wasn't clear, I meant to move the exec command creation only when required like this.
loggableCmd := cmd
if len(params) > 0 {
loggableCmd = exec.Command(cmd.Path, cmd.Args...)
paramsBytes, _ := json.Marshal(params)
cmd.Args = append(cmd.Args, "--params", string(paramsBytes))
loggableCmd.Args = append(loggableCmd.Args, "--params", fmt.Sprintf("\"{%d hidden params}\"", len(params)))
}
mergify bot
pushed a commit
that referenced
this pull request
Nov 2, 2021
* [Heartbeat] Stop logging sensitive params This change causes heartbeat to no longer log parameter values, instead interpolating an opaque string. Fixes #28771 We now create logs like: ``` 2021-11-02T17:25:27.804-0500 INFO synthexec/synthexec.go:148 Running command: /tmp/elastic-synthetics-unzip-714880603/node_modules/.bin/elastic-synthetics /tmp/elastic-synthetics-unzip-714880603/node_modules/.bin/elastic-synthetics /tmp/elastic-synthetics-unzip-714880603 --screenshots on --rich-events --params "{1 hidden params}" in directory: '/tmp/elastic-synthetics-unzip-714880603' ``` * Changelog (cherry picked from commit 40e949d)
andrewvc
added a commit
that referenced
this pull request
Nov 3, 2021
* [Heartbeat] Stop logging sensitive params This change causes heartbeat to no longer log parameter values, instead interpolating an opaque string. Fixes #28771 We now create logs like: ``` 2021-11-02T17:25:27.804-0500 INFO synthexec/synthexec.go:148 Running command: /tmp/elastic-synthetics-unzip-714880603/node_modules/.bin/elastic-synthetics /tmp/elastic-synthetics-unzip-714880603/node_modules/.bin/elastic-synthetics /tmp/elastic-synthetics-unzip-714880603 --screenshots on --rich-events --params "{1 hidden params}" in directory: '/tmp/elastic-synthetics-unzip-714880603' ``` * Changelog (cherry picked from commit 40e949d) Co-authored-by: Andrew Cholakian <andrew@andrewvc.com>
mergify bot
pushed a commit
that referenced
this pull request
Dec 9, 2021
* [Heartbeat] Stop logging sensitive params This change causes heartbeat to no longer log parameter values, instead interpolating an opaque string. Fixes #28771 We now create logs like: ``` 2021-11-02T17:25:27.804-0500 INFO synthexec/synthexec.go:148 Running command: /tmp/elastic-synthetics-unzip-714880603/node_modules/.bin/elastic-synthetics /tmp/elastic-synthetics-unzip-714880603/node_modules/.bin/elastic-synthetics /tmp/elastic-synthetics-unzip-714880603 --screenshots on --rich-events --params "{1 hidden params}" in directory: '/tmp/elastic-synthetics-unzip-714880603' ``` * Changelog (cherry picked from commit 40e949d)
andrewvc
added a commit
that referenced
this pull request
Dec 9, 2021
* [Heartbeat] Stop logging sensitive params This change causes heartbeat to no longer log parameter values, instead interpolating an opaque string. Fixes #28771 We now create logs like: ``` 2021-11-02T17:25:27.804-0500 INFO synthexec/synthexec.go:148 Running command: /tmp/elastic-synthetics-unzip-714880603/node_modules/.bin/elastic-synthetics /tmp/elastic-synthetics-unzip-714880603/node_modules/.bin/elastic-synthetics /tmp/elastic-synthetics-unzip-714880603 --screenshots on --rich-events --params "{1 hidden params}" in directory: '/tmp/elastic-synthetics-unzip-714880603' ``` * Changelog (cherry picked from commit 40e949d) Co-authored-by: Andrew Cholakian <andrew@andrewvc.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.
This change causes heartbeat to no longer log parameter values, instead
interpolating an opaque string.
Fixes #28771
We now create logs like:
Checklist
CHANGELOG.next.asciidocorCHANGELOG-developer.next.asciidoc.How to test this PR locally
Tested with https://github.com/elastic/synthetics-demo/blob/main/heartbeat/monitors.d/todos-zipurl.yml