Commits on Apr 13, 2022

1. all: Replace various log.Printf calls with tfsdklog calls …

   Reference: #863
   
   By default, the standard library `log` package will include the short timestamp and date flags, which when output will prefix any messaging, e.g.
   
   ```text
   # From log.Printf("[DEBUG] Test message")
   2022/01/26 16:25:33 [DEBUG] Test message
   ```
   
   When a provider is running in production and the log output is being sent across the go-plugin boundary, Terraform CLI generally expects a hc-log formatted entry (square bracket log level prefixed message) or will output the raw message. So in many cases, this class of logging shows up in production logs as the raw message and the log level is not recognized, which is confusing for practitioners and provider developers:
   
   ```text
   2022-01-26T16:25:33.123-0800 [INFO] provider.terraform-provider-example_v9.9.9_x5: 2022/01/26 16:25:33 [DEBUG] Test Message: timestamp=2022-01-26T16:25:33.123-0800
   ```
   
   Setting the `log` package default logger to not include those flags via `log.SetFlags(0)` early in the SDK lifecycle may represent a breaking change for any providers depending on the current behavior, so this easier class of fix is not acceptable.
   
   Now that this SDK implements the `tfsdklog` package, logging can be converted to that style, which fixes the above issue and these messages will now also include all the gathered logging context up to the call such as the RPC name and a request UUID.
   
   There are quite a few other `log.Printf()` calls across the project, however they are non-trivial to update as:
   
   * The logging context is not present or not guaranteed to be present (as is the case with `(helper/resource.StateChangeConf).WaitContext()`)
   * The functions/methods are exported, so changing the signature is an unacceptable change
   * The functions/methods while unexported are eventually surfaced via an exported type/function, so it could indirectly require breaking changes
   
   Given that `helper/resource.StateChangeConf`, which also underlies `helper/resource.Retry*` functionality, is quite common across provider usage, a separate custom logging solution may be introduced there as a separate change.

   

   bflad committed Apr 13, 2022
   Copy the full SHA

   3dd1bf9 View commit details

   Browse the repository at this point in the history