feat(servicediscovery): add telemetry header to all API requests

- Introduce SetTelementryRequestHeader to set X-Cybr-Telemetry header
- Ensure telemetry header is present in service discovery requests
- Update mock server to validate telemetry header presence

Signed-off-by: Richard Wall <[email protected]>

Author: wallrj-cyberark

internal/cyberark/api/telemetry.go

@@ -0,0 +1,34 @@
+package api
+
+import (
+	"encoding/base64"
+	"net/http"
+
+	"github.com/jetstack/preflight/pkg/version"
+)
+
+// Integrations working with the Identity Security Platform, should add metadata
+// in their API calls, to provide insights into how customers utilize each API.
+//
+// - IntegrationName (in): The vendor integration name (required)
+// - IntegrationType (it): Integration Type	(required)
+// - IntegrationVersion (iv): The plugin version being used (required)
+// - VendorName (vn): Vendor name (required)
+// - VendorVersion (vv): Version of the vendor product in which the plugin is used (if applicable)
+
+const (
+	// TelemetryHeaderKey is the name of the HTTP header to use for telemetry
+	TelemetryHeaderKey = "X-Cybr-Telemetry"
+	// staticHeaderPrefix is the static part of the telemetry header value
+	// The version is appended to this string before being base64 encoded
+	staticHeaderPrefix = "in=cyberark-disco-agent&vn=CyberArk&it=KubernetesAgent&iv="
+)
+
+// SetTelemetryRequestHeader adds the x-cybr-telemetry header to the given HTTP
+// request, with information about this integration.
+func SetTelemetryRequestHeader(req *http.Request) {
+	encodedValue := base64.URLEncoding.EncodeToString(
+		[]byte(staticHeaderPrefix + version.PreflightVersion),
+	)
+	req.Header.Set(TelemetryHeaderKey, encodedValue)
+}

internal/cyberark/api/telemetry_test.go

@@ -0,0 +1,24 @@
+package api
+
+import (
+	"encoding/base64"
+	"fmt"
+	"net/http"
+)
+
+// Test the SetTelemetryRequestHeader function
+func ExampleSetTelemetryRequestHeader() {
+	req, _ := http.NewRequest("GET", "http://example.com", nil)
+	SetTelemetryRequestHeader(req)
+	encodedValue := req.Header.Get("X-Cybr-Telemetry")
+	value, err := base64.StdEncoding.DecodeString(encodedValue)
+	fmt.Println(
+		"encodedValue:", encodedValue, "\n",
+		"value:", string(value), "\n",
+		"err:", err,
+	)
+	// Output: encodedValue: aW49Y3liZXJhcmstZGlzY28tYWdlbnQmdm49Q3liZXJBcmsmaXQ9S3ViZXJuZXRlc0FnZW50Jml2PWRldmVsb3BtZW50
+	//  value: in=cyberark-disco-agent&vn=CyberArk&it=KubernetesAgent&iv=development
+	//  err: <nil>
+	//
+}

internal/cyberark/servicediscovery/discovery.go

@@ -10,6 +10,7 @@ import (
 	"os"
 	"path"
 
+	arkapi "github.com/jetstack/preflight/internal/cyberark/api"
 	"github.com/jetstack/preflight/pkg/version"
 )
 
@@ -109,7 +110,8 @@ func (c *Client) DiscoverServices(ctx context.Context, subdomain string) (*Servi
 
 	request.Header.Set("Accept", "application/json")
 	version.SetUserAgent(request)
-
+	// Add telemetry headers
+	arkapi.SetTelemetryRequestHeader(request)
 	resp, err := c.client.Do(request)
 	if err != nil {
 		return nil, fmt.Errorf("failed to perform HTTP request: %s", err)

internal/cyberark/servicediscovery/mock.go

@@ -13,6 +13,7 @@ import (
 
 	"k8s.io/client-go/transport"
 
+	arkapi "github.com/jetstack/preflight/internal/cyberark/api"
 	"github.com/jetstack/preflight/pkg/version"
 
 	_ "embed"
@@ -92,6 +93,12 @@ func (mds *mockDiscoveryServer) ServeHTTP(w http.ResponseWriter, r *http.Request
 		return
 	}
 
+	if r.Header.Get(arkapi.TelemetryHeaderKey) == "" {
+		w.WriteHeader(http.StatusInternalServerError)
+		_, _ = w.Write([]byte("should set telemetry header on all requests"))
+		return
+	}
+
 	if r.Header.Get("Accept") != "application/json" {
 		w.WriteHeader(http.StatusInternalServerError)
 		_, _ = w.Write([]byte("should request JSON on all requests"))