feat(client): emit X-DevHelm-Surface telemetry headers#14
Merged
Conversation
Adds Terraform-provider surface identification to every authenticated API call so the GTM rollup can attribute usage to the provider vs. SDKs / MCP / CLI. Wire contract docs at https://devhelm.io/telemetry; matching API-side handler in mono#332. Headers emitted by default (every request): - X-DevHelm-Surface: tf - X-DevHelm-Surface-Version: provider version (already passed into NewClient via main.go ldflags-overridden const, no extra plumbing) - X-DevHelm-Tf-Os: <GOOS>-<GOARCH> (e.g. darwin-arm64). Helps the platform team prioritise binary builds. Cheap to ship — runtime values are already constants once the binary is built. Opt-out is a single env var, not a provider attribute: DEVHELM_TELEMETRY=0 returns nil from buildSurfaceHeaders and the API receives no surface signal at all. Auth + tenant + User-Agent headers are unaffected. Strict equality on "0" so DEVHELM_TELEMETRY=on / true / yes don't accidentally read as opt-out. Zero callsite changes — headers are computed once in NewClient and applied uniformly in doRequestOnce alongside the existing static headers. Every existing resource using the api.Client keeps working unchanged. Tests: 3 new tests in internal/api/surface_telemetry_test.go using httptest.Server to capture the outbound request and assert headers (default emit, opt-out, strict-on-"0" parsing). Existing client tests unaffected. golangci-lint clean. Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Reports the Terraform provider's identity to the DevHelm API on every authenticated request so the GTM rollup can attribute usage to the provider vs. SDKs / MCP / CLI. Wire contract documented at https://devhelm.io/telemetry; the matching API-side handler shipped in `devhelmhq/mono#332`.
What lands on the wire (defaults)
Opt-out
`DEVHELM_TELEMETRY=0` returns `nil` from `buildSurfaceHeaders` and the API receives no surface signal at all. Single env var, not a provider attribute. Auth + tenant + User-Agent headers are unaffected. Strict equality on `"0"` (so `DEVHELM_TELEMETRY=on` / `true` / `yes` don't accidentally read as opt-out).
Zero callsite changes
Headers are computed once in `NewClient` and applied uniformly inside `doRequestOnce` alongside the existing static headers (`Authorization`, `x-phelm-org-id`, `User-Agent`). Every existing resource using `api.Client` keeps working unchanged.
Tests
Test plan
Made with Cursor