chore: Add user agent headers to improve telemetry of Terraform usage (#86)

Author: alexluong

internal/provider/provider.go

@@ -11,6 +11,7 @@ import (
 	"terraform-provider-hookdeck/internal/provider/sourceverification"
 	"terraform-provider-hookdeck/internal/provider/transformation"
 	"terraform-provider-hookdeck/internal/provider/webhookregistration"
+	"terraform-provider-hookdeck/internal/sdkclient"
 
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
 	"github.com/hashicorp/terraform-plugin-framework/path"
@@ -19,7 +20,6 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 	"github.com/hashicorp/terraform-plugin-log/tflog"
-	hookdeckClient "github.com/hookdeck/hookdeck-go-sdk/client"
 )
 
 // Ensure the implementation satisfies various provider interfaces.
@@ -135,10 +135,7 @@ func (p *hookdeckProvider) Configure(ctx context.Context, req provider.Configure
 	tflog.Debug(ctx, apiBase+" "+apiKey)
 
 	// Create a new Hookdeck client using the configuration values
-	client := hookdeckClient.NewClient(
-		hookdeckClient.WithBaseURL(apiBase),
-		hookdeckClient.WithAuthToken(apiKey),
-	)
+	client := sdkclient.InitHookdeckSDKClient(apiBase, apiKey, p.version)
 
 	// Make the Hookdeck client available during DataSource and Resource
 	// type Configure methods.

internal/sdkclient/sdkclient.go

@@ -0,0 +1,17 @@
+package sdkclient
+
+import (
+	"net/http"
+
+	hookdeckClient "github.com/hookdeck/hookdeck-go-sdk/client"
+)
+
+func InitHookdeckSDKClient(apiBase string, apiKey string, providerVersion string) *hookdeckClient.Client {
+	header := http.Header{}
+	initUserAgentHeader(header, providerVersion)
+	return hookdeckClient.NewClient(
+		hookdeckClient.WithBaseURL(apiBase),
+		hookdeckClient.WithAuthToken(apiKey),
+		hookdeckClient.WithHTTPHeader(header),
+	)
+}

internal/sdkclient/uname_unix.go

@@ -0,0 +1,26 @@
+//go:build !windows
+// +build !windows
+
+package sdkclient
+
+import (
+	"bytes"
+	"fmt"
+
+	"golang.org/x/sys/unix"
+)
+
+func trimNulls(input []byte) []byte {
+	return bytes.Trim(input, "\x00")
+}
+
+func getUname() string {
+	u := new(unix.Utsname)
+
+	err := unix.Uname(u)
+	if err != nil {
+		panic(err)
+	}
+
+	return fmt.Sprintf("%s %s %s %s %s", trimNulls(u.Sysname[:]), trimNulls(u.Nodename[:]), trimNulls(u.Release[:]), trimNulls(u.Version[:]), trimNulls(u.Machine[:]))
+}

internal/sdkclient/useragent.go

@@ -0,0 +1,45 @@
+package sdkclient
+
+import (
+	"encoding/json"
+	"net/http"
+	"runtime"
+)
+
+func initUserAgentHeader(header http.Header, providerVersion string) {
+	header.Add("User-Agent", getUserAgent(providerVersion))
+	header.Add("X-Hookdeck-Client-User-Agent", getHookdeckUserAgent(providerVersion))
+}
+
+func getUserAgent(providerVersion string) string {
+	return "Hookdeck/v1 terraform-provider-hookdeck/" + providerVersion
+}
+
+// hookdeckClientUserAgent contains information about the current runtime which
+// is serialized and sent in the `X-Hookdeck-Client-User-Agent` as additional
+// debugging information.
+type hookdeckClientUserAgent struct {
+	Name      string `json:"name"`
+	OS        string `json:"os"`
+	Publisher string `json:"publisher"`
+	Uname     string `json:"uname"`
+	Version   string `json:"version"`
+}
+
+func getHookdeckUserAgent(providerVersion string) string {
+	hookdeckUserAgent := &hookdeckClientUserAgent{
+		Name:      "terraform-provider-hookdeck",
+		Version:   providerVersion,
+		Publisher: "hookdeck",
+		OS:        runtime.GOOS,
+		Uname:     getUname(),
+	}
+	marshaled, err := json.Marshal(hookdeckUserAgent)
+	// Encoding this struct should never be a problem, so we're okay to panic
+	// in case it is for some reason.
+	if err != nil {
+		panic(err)
+	}
+
+	return string(marshaled)
+}