Document the new NewLoggingHTTPTransport
and NewSubsystemLoggingHTTPTransport
#1007
Labels
Milestone
NewLoggingHTTPTransport
and NewSubsystemLoggingHTTPTransport
#1007
SDK version
Use-cases
The work in #1006 involves creating a feature that replaces a previously undocumented one: the
NewTransport
implementation of anhttp.RoundTripper
, hosted in thehelper/logging
package.The new transport is built around
tflog
logging library (https://github.com/hashicorp/terraform-plugin-log), and it requires website documentation to introduce it, explain why we deprecate the old one, and how to use it in tandem withtflog
.Proposal
Write a guide documentation to explain:
NewTransport
is bad ideacontext.Context
to the transport via requests, to control loggingNewSubsystemLoggingHTTPTransport
to log via a subsystem logger, instead of the provider root logger used byNewLoggingHTTPTransport
The documentation should probably sit under the
?
section ofwebsite/docs/plugin/sdkv2
.The documentation should definitely not try to cover the same content of https://www.terraform.io/plugin/log, and instead focus on the little amount of change necessary to use the new
NewLoggingHTTPTransport
, and then send to the Logging documentation for details.References
Depends on: #1006
The text was updated successfully, but these errors were encountered: