helper/resource: Added terraform-plugin-log logger and extensive log entries #891
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
detro
approved these changes
Feb 21, 2022
internal/logging/helper_resource.go
Outdated
Comment on lines
14
to
32
| // HelperResourceDebug emits a helper/resource subsystem log at DEBUG level. | ||
| func HelperResourceDebug(ctx context.Context, msg string, args ...interface{}) { | ||
| tfsdklog.SubsystemDebug(ctx, SubsystemHelperResource, msg, args) | ||
| } | ||
|
|
||
| // HelperResourceError emits a helper/resource subsystem log at ERROR level. | ||
| func HelperResourceError(ctx context.Context, msg string, args ...interface{}) { | ||
| tfsdklog.SubsystemError(ctx, SubsystemHelperResource, msg, args) | ||
| } | ||
|
|
||
| // HelperResourceTrace emits a helper/resource subsystem log at TRACE level. | ||
| func HelperResourceTrace(ctx context.Context, msg string, args ...interface{}) { | ||
| tfsdklog.SubsystemTrace(ctx, SubsystemHelperResource, msg, args) | ||
| } | ||
|
|
||
| // HelperResourceWarn emits a helper/resource subsystem log at WARN level. | ||
| func HelperResourceWarn(ctx context.Context, msg string, args ...interface{}) { | ||
| tfsdklog.SubsystemWarn(ctx, SubsystemHelperResource, msg, args) | ||
| } |
There was a problem hiding this comment.
nitpick: would prefer if those functions where either sorted "trace, debug, warn, error" or "error, warn, debug, trace".
There was a problem hiding this comment.
Typically I'll code function/method definitions alphabetically, but pushed up the ordering change.
bflad
added a commit
that referenced
this pull request
Feb 21, 2022
…entries Reference: #838 This new subsystem logger is meant for instrumenting the acceptance testing framework. Most of the changes are to support passing the context to many of the functions and adding `DEBUG`/`TRACE` log entries for provider developer and SDK maintainer troubleshooting. Verified `go test` logging behaviors via terraform-provider-corner: - No logs by default - `TF_LOG_SDK_HELPER_RESOURCE` environment variable control of new logger - `TF_LOG` enabling new logger - `TF_ACC_LOG_PATH` enabling new logger
bflad
force-pushed
the
bflad-helper-resource-logging
branch
from
6ade90a
to
55ec1bb
Compare
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
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.
Closes #838
This new subsystem logger is meant for instrumenting the acceptance testing framework. Most of the changes are to support passing the context to many of the functions and adding
DEBUG/TRACElog entries for provider developer and SDK maintainer troubleshooting.Verified
go testlogging behaviors via terraform-provider-corner:TF_LOG_SDK_HELPER_RESOURCEenvironment variable control of new loggerTF_LOGenabling new loggerTF_ACC_LOG_PATHenabling new logger