add privateMetadata fields

Author: BolajiOlajide

internal/telemetry/telemetry.go

@@ -67,23 +67,24 @@ func NewRecorder(client api.Client, logger log.Logger, clientVersion string) *re
 
 // Record sends an event on a best-effort basis. Feature and action identify the
 // event (for example, "srcCli.search" and "succeeded"). Metadata must contain
-// only numeric, PII-free facts. Network, GraphQL, timeout, and old-instance
-// failures are logged at debug level. Record applies its own timeout, so the
-// caller's context need not carry a deadline.
-func (r *recorder) Record(ctx context.Context, feature, action string, metadata map[string]float64) {
-	if err := r.record(ctx, feature, action, metadata); err != nil {
+// only numeric, PII-free facts. Private metadata may contain arbitrary JSON and
+// is not exported from Sourcegraph instances by default. Network, GraphQL,
+// timeout, and old-instance failures are logged at debug level. Record applies
+// its own timeout, so the caller's context need not carry a deadline.
+func (r *recorder) Record(ctx context.Context, feature, action string, metadata map[string]float64, privateMetadata map[string]any) {
+	if err := r.record(ctx, feature, action, metadata, privateMetadata); err != nil {
 		r.logger.Debug("recording telemetry event", log.String("feature", feature), log.String("action", action), log.Error(err))
 	}
 }
 
 // record does the work behind Record and returns any error, so it can be tested
 // directly. Callers outside tests should use Record.
-func (r *recorder) record(ctx context.Context, feature, action string, metadata map[string]float64) error {
+func (r *recorder) record(ctx context.Context, feature, action string, metadata map[string]float64, privateMetadata map[string]any) error {
 	ctx, cancel := context.WithTimeout(ctx, r.timeout)
 	defer cancel()
 
 	vars := map[string]any{
-		"events": []any{buildEventInput(r.clientVersion, feature, action, metadata)},
+		"events": []any{buildEventInput(r.clientVersion, feature, action, metadata, privateMetadata)},
 	}
 
 	payload, err := json.Marshal(map[string]any{
@@ -121,18 +122,22 @@ func (r *recorder) record(ctx context.Context, feature, action string, metadata
 }
 
 // buildEventInput builds a single TelemetryEventInput as a JSON-serializable map.
-func buildEventInput(clientVersion, feature, action string, metadata map[string]float64) map[string]any {
+func buildEventInput(clientVersion, feature, action string, metadata map[string]float64, privateMetadata map[string]any) map[string]any {
+	parameters := map[string]any{
+		"version":  eventParametersVersion,
+		"metadata": buildMetadata(metadata),
+	}
+	if privateMetadata != nil {
+		parameters["privateMetadata"] = privateMetadata
+	}
 	return map[string]any{
 		"feature": feature,
 		"action":  action,
 		"source": map[string]string{
 			"client":        clientName,
 			"clientVersion": clientVersion,
 		},
-		"parameters": map[string]any{
-			"version":  eventParametersVersion,
-			"metadata": buildMetadata(metadata),
-		},
+		"parameters": parameters,
 	}
 }
 

internal/telemetry/telemetry_test.go

@@ -77,6 +77,9 @@ func TestRecord_SendsWellFormedMutation(t *testing.T) {
 	rec.Record(context.Background(), "srcCli.search", "succeeded", map[string]float64{
 		"durationMs": 12,
 		"exitCode":   0,
+	}, map[string]any{
+		"queryType": "literal",
+		"streamed":  true,
 	})
 
 	assert.Equal(t, recordEventsMutation, gotPayload.Query)
@@ -99,6 +102,10 @@ func TestRecord_SendsWellFormedMutation(t *testing.T) {
 		map[string]any{"key": "durationMs", "value": float64(12)},
 		map[string]any{"key": "exitCode", "value": float64(0)},
 	}, parameters["metadata"])
+	assert.Equal(t, map[string]any{
+		"queryType": "literal",
+		"streamed":  true,
+	}, parameters["privateMetadata"])
 
 	client.AssertExpectations(t)
 }
@@ -121,12 +128,13 @@ func TestRecord_NilMetadataSendsEmptyList(t *testing.T) {
 
 	logger := log.NoOp()
 	rec := NewRecorder(client, logger, testClientVersion)
-	rec.Record(context.Background(), "srcCli.version", "succeeded", nil)
+	rec.Record(context.Background(), "srcCli.version", "succeeded", nil, nil)
 
 	event := gotPayload.Variables["events"].([]any)[0].(map[string]any)
 	parameters := event["parameters"].(map[string]any)
 	assert.Equal(t, float64(eventParametersVersion), parameters["version"])
 	assert.Equal(t, []any{}, parameters["metadata"])
+	assert.NotContains(t, parameters, "privateMetadata")
 }
 
 func TestRecord_NetworkErrorSwallowed(t *testing.T) {
@@ -140,7 +148,7 @@ func TestRecord_NetworkErrorSwallowed(t *testing.T) {
 
 	// Must not panic and must not surface the error.
 	assert.NotPanics(t, func() {
-		rec.Record(context.Background(), "srcCli.search", "failed", nil)
+		rec.Record(context.Background(), "srcCli.search", "failed", nil, nil)
 	})
 	logs := exportLogs()
 	if assert.Len(t, logs, 1) {
@@ -150,7 +158,7 @@ func TestRecord_NetworkErrorSwallowed(t *testing.T) {
 	}
 
 	// record itself reports the error for callers that want it.
-	err := rec.record(context.Background(), "srcCli.search", "failed", nil)
+	err := rec.record(context.Background(), "srcCli.search", "failed", nil, nil)
 	assert.Error(t, err)
 }
 
@@ -165,7 +173,7 @@ func TestRecord_GraphQLErrorSwallowed(t *testing.T) {
 	logger := log.NoOp()
 	rec := NewRecorder(client, logger, testClientVersion)
 	assert.NotPanics(t, func() {
-		rec.Record(context.Background(), "srcCli.search", "succeeded", nil)
+		rec.Record(context.Background(), "srcCli.search", "succeeded", nil, nil)
 	})
 }
 
@@ -203,7 +211,7 @@ func TestRecord_OAuthUnauthorizedDoesNotWriteToStdout(t *testing.T) {
 
 	logger := log.NoOp()
 	rec := NewRecorder(client, logger, testClientVersion)
-	rec.Record(context.Background(), "srcCli.search", "succeeded", nil)
+	rec.Record(context.Background(), "srcCli.search", "succeeded", nil, nil)
 
 	if err := stdoutWriter.Close(); err != nil {
 		t.Fatal(err)
@@ -237,7 +245,7 @@ func TestRecord_AppliesTimeout(t *testing.T) {
 	logger := log.NoOp()
 	rec := NewRecorder(client, logger, testClientVersion)
 	rec.timeout = 50 * time.Millisecond
-	rec.Record(context.Background(), "srcCli.search", "succeeded", nil)
+	rec.Record(context.Background(), "srcCli.search", "succeeded", nil, nil)
 
 	assert.True(t, hadDeadline, "expected Record to apply a context deadline")
 }
@@ -253,7 +261,7 @@ func TestRecord_TimeoutCancelsHTTPRequest(t *testing.T) {
 	defer cancel()
 	done := make(chan struct{})
 	go func() {
-		rec.Record(ctx, "srcCli.search", "succeeded", nil)
+		rec.Record(ctx, "srcCli.search", "succeeded", nil, nil)
 		close(done)
 	}()