Added option to remove all CRs from input stream #1606
Conversation
|
I'm not sure why the test failed, it is the TestCombinedOutputTimeout test that is failing. It runs fine on my test machine (Windows) (though many other tests fail because they're expecting services...). Perhaps the test just need to be re-run? (Or maybe my change affects this, but don't see anything I changed getting called) |
|
Why did you make it a configurable option? is there ever a reason someone would want to keep the carriage returns? |
|
I can't think of a reason, should I remove the option? |
|
yes, please do, but possibly we should be doing this at a lower level in the command running exec functions: https://github.com/influxdata/telegraf/blob/master/internal/internal.go#L168 and it should also only happen |
| err := WaitTimeout(c, timeout) | ||
|
|
||
| if runtime.GOOS == "windows" { | ||
| var buf bytes.Buffer |
There was a problem hiding this comment.
put this logic within the if-statement in it's own function, then unit test it and put a comment above the function explaining what it's doing.
|
@sparrc inputs.exec does not call internal.CombinedOutputTimeout(), it calls exec.Command() directly, only using internal for internal.RunTImeout(). Should it be using internal.CombinedOutputTimeout()? (Currently it does not include stderr in the output.) |
|
yes, I think I was wrong, we should probably just strip the CRs from the exec plugin only, as you had it before. |
|
looks good @butitsnotme, but you need to fix your CHANGELOG update. I would suggest just throwing away your changes to the changelog and rebasing, then adding your PR to the list again. |
|
+1 would like this in the RC |
Added the option removecr to inputs.exec to remove all carraige returns (CR, ASCII 0x0D, Unicode codepoint \u0D, ^M). The option is boolean and not enabled if not present in the config file.
Moved the code to remove carriage returns from plugins/inputs/exec/exec.go to internal/internal.go. Additionally changed the conditional on which it gets applied from using a configuration file option to checking if it is running on Windows.
Moved the carriage return removal back to the exec plugin. Added unit testing for it. Fixed a bug (removing too many characters).
|
I've updated the changelog and rebased on master. I've tested the latest commit on Windows, it all works. The failed check appears to be unrelated (it looks like one of the docker images didn't initialize in time). I would very much appreciate it if this could be incorporated into the 1.0 release, as without it the exec plugin is nearly useless on Windows. |
|
The failed check looks like it has nothing to do with this... (Aerospike failed) |
|
thx @butitsnotme |
Added the option removecr to inputs.exec to remove all carraige returns (CR, ASCII 0x0D, Unicode codepoint \u0D, ^M). The option is boolean and not enabled if not present in the config file. closes #1606 Updated CHANGELOG.md with information about removecr Ran go fmt ./... Moved removal of CRs to internal/internal.go Moved the code to remove carriage returns from plugins/inputs/exec/exec.go to internal/internal.go. Additionally changed the conditional on which it gets applied from using a configuration file option to checking if it is running on Windows. Moved Carriage Return check to correct place Moved the carriage return removal back to the exec plugin. Added unit testing for it. Fixed a bug (removing too many characters). Ran go fmt ./... Reverted CHANGELOG to master Updated Changelog
Required for all PRs:
Added the option
removecrtoinputs.execto remove all carriage returns(CR, ASCII 0x0D, Unicode codepoint \u0D, ^M). The option is boolean and
not enabled if not present in the config file.
To be clear it removes them from the output of the command before it is processed by the parser.