Update go-plugin, and use hclog.Logger when serving a plugin #639
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
The major fix here is go-plugin no longer overrides the default output for the log package, allowing us to set it globally for providers.
Go-plugin can transfer JSON structured hclog output to a client logger. Rather than requiring existing providers to udpate all logging calls, we inject a wrapper into the std log package output which translates the defacto log format into structured log output with the correct levels. This will allow terraform to correctly filter the output, rather than default to handling all logs as Debug.
paddycarver
approved these changes
Dec 17, 2020
There was a problem hiding this comment.
Let's do it. Thanks @jbardin. I think we're going to want to follow up in the testing framework, but for the moment, we can ship this incremental improvement.
Merged
paddycarver
added a commit
that referenced
this pull request
Dec 18, 2020
When testing, we don't want to override where log output gets sent--the test framework takes care of that itself. go-plugin has disabled its use of log.SetOutput for us, but #639 introduced a log.SetOutput in plugin.Serve. This adds a plugin.ServeOpt property to disable that log.SetOutput call so we can finally have tests where log lines don't randomly show up in test output.
paddycarver
added a commit
that referenced
this pull request
Dec 18, 2020
When testing, we don't want to override where log output gets sent--the test framework takes care of that itself. go-plugin has disabled its use of log.SetOutput for us, but #639 introduced a log.SetOutput in plugin.Serve. This adds a plugin.ServeOpt property to disable that log.SetOutput call so we can finally have tests where log lines don't randomly show up in test output.
|
I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
ghost
locked as resolved and limited conversation to collaborators
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Update go-plugin, so that it no longer overrides the default output in the
logpackage.Go-plugin can transfer JSON structured hclog output to a client logger. Rather than requiring existing providers to update all logging calls, we inject a wrapper into the std log package output which translates the defacto log format into structured log output with the correct levels. This will allow terraform to correctly filter the output, rather than default to handling all logs as Debug. This allows the logger to remove redundant tags and timestamps in the log output, and fixes multi-line log output where the first line may have a tag other than
[DEBUG], but the remainder of the lines will be converted to[DEBUG].This PR intends to only configure the logging when running as a plugin. The same logger could also be adapted for testing, but that is to be left for another PR.