Support whitelisting log lines via regular expressions #25086
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
|
|
Codecov Report
|
PSanetra
commented
May 30, 2020
| pattern, err := regexp.Compile(envVarValue) | ||
|
|
||
| if err != nil { | ||
| log.Fatalln("Can not compile "+envVarName+":", err) |
There was a problem hiding this comment.
I am not sure if it is ok to panic if the pattern can not compile. But I guess the user expects terraform to fail if this is the case.
…_PATTERN_" prefix This commit makes it possible to whitelist log lines, matching regular expressions, defined in environment variables. Lines matching these patterns will be logged regardless of the defined log level in TF_LOG. Example: The following environment variable would whitelist log lines, which match the regular expression "\[\w+\] plugin.terraform-provider-helm" TF_LOG_PATTERN_HELM_PLUGIN=\[\w+\] plugin.terraform-provider-helm
PSanetra
force-pushed
the
support-whitelisted-log-patterns
branch
from
27598e1
to
d81f7c2
Compare
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 PR makes it possible to whitelist log lines, matching regular expressions, defined in environment variables with a
TF_LOG_PATTERN_prefix.Lines matching these patterns will be logged regardless of the defined log level in
TF_LOG.Example:
The following environment variable would whitelist log lines, which are logged by the helm terraform provider
\[\w+\] plugin.terraform-provider-helm:TF_LOG_PATTERN_HELM_PLUGIN=\[\w+\] plugin.terraform-provider-helmThis features helps with debugging plugins as you can easily define a pattern, which matches the log lines of you own plugin. A related issue does already exist: hashicorp/terraform-plugin-sdk#88
The feature can also be helpful in ci/cd pipelines if you are interested in debug log lines, which match a certain pattern.