Adopt new logging patterns from tflog

[zhelding]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

The tflog package provides functions for structured logging in lieu of using log.Printf("[LOG_LEVEL] some extended string"). This not only allows for more consistent writing of logging, but also allows us to designate a distinct subsystem of code that outputs logs at a separately set verbosity level.

For example: terraform-plugin-sdk/v2 by default uses tflog to set up TF_LOG_SDK and TF_LOG_PROVIDER when initializing tfserver; as such, these environmental variables are already supported by the provider. Similarly: we may be able to use tfsdklog to specify separate verbosity levels for provider, testing, and sweeper logs.

This is a sweeping change -- as it would alter every line of logging output across all files, but most of these can probably be replaced via a single complex sed command.

References

• Terraform best practices for writing log output
• Terraform best practices for managing log output

Relates: #22922

[ewbankkit]

We should consider adding an internal/logging package with useful wrapper/helper functions.
See e.g. hashicorp/terraform-plugin-framework#291.

[ewbankkit]

To be useful this will require using context.Context:

• Integrate Provider Context For Cancelling Requests #4177
• provider: Switch Resources To Terraform Plugin SDK V2 WithoutTimeout Signatures #15090

[github-actions]

Marking this issue as stale due to inactivity. This helps our maintainers find and focus on the active issues. If this issue receives no comments in the next 30 days it will automatically be closed. Maintainers can also remove the stale label.

If this issue was automatically closed and you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thank you!

[github-actions]

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.