Skip to content

Commit 987ff6a

Browse files
Docs: Add hidden user agent extension env var info to terraform website (#7470) (#14054)
Signed-off-by: Modular Magician <[email protected]>
1 parent 6d421ea commit 987ff6a

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

.changelog/7470.txt

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
```release-note:none
2+
```

website/docs/guides/provider_reference.html.markdown

+12
Original file line numberDiff line numberDiff line change
@@ -321,6 +321,18 @@ Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
321321
* `enable_batching` - (Optional) Defaults to true. If false, disables global
322322
batching and each request is sent normally.
323323

324+
---
325+
326+
You can extend the user agent header for each request made by the provider by setting the `GOOGLE_TERRAFORM_USERAGENT_EXTENSION` environment variable. This can be helpful for tracking (e.g. compliance through [audit logs](https://cloud.google.com/logging/docs/audit)) or debugging purposes.
327+
328+
Example:
329+
330+
```sh
331+
export GOOGLE_TERRAFORM_USERAGENT_EXTENSION="my-extension/1.0"
332+
```
333+
334+
See [RFC 9110](https://www.rfc-editor.org/rfc/rfc9110#field.user-agent) for format compliance of user agent header fields.
335+
324336
[OAuth 2.0 access token]: https://developers.google.com/identity/protocols/OAuth2
325337
[service account key file]: https://cloud.google.com/iam/docs/creating-managing-service-account-keys
326338
[manage key files using the Cloud Console]: https://console.cloud.google.com/apis/credentials/serviceaccountkey

0 commit comments

Comments
 (0)