Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the new NewLoggingHTTPTransport and NewSubsystemLoggingHTTPTransport #1007

Closed
detro opened this issue Jul 20, 2022 · 1 comment · Fixed by #1011
Closed

Document the new NewLoggingHTTPTransport and NewSubsystemLoggingHTTPTransport #1007

detro opened this issue Jul 20, 2022 · 1 comment · Fixed by #1011
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@detro
Copy link
Contributor

detro commented Jul 20, 2022

SDK version

2.19.0

Use-cases

The work in #1006 involves creating a feature that replaces a previously undocumented one: the NewTransport implementation of an http.RoundTripper, hosted in the helper/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 with tflog.

Proposal

Write a guide documentation to explain:

  1. why using the legacy NewTransport is bad idea
  2. what the new Transport(s) offer
  3. how to correctly configure and pass context.Context to the transport via requests, to control logging
  4. how to use NewSubsystemLoggingHTTPTransport to log via a subsystem logger, instead of the provider root logger used by NewLoggingHTTPTransport

The documentation should probably sit under the ? section of website/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

@detro detro added enhancement New feature or request documentation Improvements or additions to documentation labels Jul 20, 2022
@detro detro added this to the v2.20.0 milestone Jul 20, 2022
@detro detro self-assigned this Jul 26, 2022
@github-actions
Copy link

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant