chore: Enhances User-Agent with additional metadata support #3463
+387
−2
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces enhanced user agent context propagation and analytics metadata for all resource, data source, and function operations. The changes include:
UserAgentExtra
tointernal/config/transport.go
struct and related helpers to capture operation type, name, and action for every provider call.WrappedProviderServer
ininternal/provider/wrapper_provider_server.go
. A new file that wraps the provider server to inject detailed operation metadata into the context for every gRPC entrypoint. This wrapper ensures that all resource, data source, and function operations are enriched with type, name, and operation metadata, enabling improved observability, analytics, and debugging. The wrapper works by intercepting each call and usingAddUserAgentExtra
.TFSrcUserAgentAdder
HTTP middleware that reads theUserAgentExtra
and updates the request header.These changes improve observability, analytics, and debugging capabilities by making operation context available for logging and downstream systems.
Link to any related issue(s): CLOUDP-329015
Sequence diagram
gRPC request arrives
A Terraform CLI or Cloud call triggers a gRPC request to the provider (for example, ReadResource:
internal/provider/wrapper_provider_server.go
, PlanResourceChangeinternal/provider/wrapper_provider_server.go
, etc.).WrappedProviderServer
internal/provider/wrapper_provider_server.go
receives the requestInstead of going directly to the “old” provider server, the request first hits the new WrappedProviderServer (see internal/provider/wrapper_provider_server.go)
AddUserAgentExtra internal/config/transport.go is called
The wrapper method (such as ReadResource
internal/provider/wrapper_provider_server.go
) creates a UserAgentExtrainternal/config/transport.go
struct. This struct includes:internal/provider/wrapper_provider_server.go
)It then calls AddUserAgentExtra(ctx, extra)
internal/config/transport.go
to add this info to the context.Delegation to the old server
The wrapper method calls the original provider server’s method, passing along the new context with the extra metadata.
Downstream usage
Any logic, logging, or HTTP requests made further down the stack (including SDK calls) can now read this metadata from the context.
For example, the HTTP roundtripper can add this info to the User-Agent header for all outgoing API requests.
Result returned
The response is returned up the stack, now with enriched context and observability.
Type of change:
Required Checklist: