Fix trace and logging user agent, and add tests (#714)

* prepend user agent to avoid overwriting provided options

* cloudmock records user agent header

* add user agent to text fixture protos

* update fixtures with user agent

* check user agent in integration tests

* set {{version}} in logging exporter

* add fixture case for custom user agent

exporter/collector/integrationtest/cmd/recordfixtures/main.go

@@ -97,6 +97,7 @@ func (fr fixtureRecorder) recordTraces(ctx context.Context, t *FakeTesting, star
 			require.NoError(t, err)
 			fixture := &protos.TraceExpectFixture{
 				BatchWriteSpansRequest: testServer.CreateBatchWriteSpansRequests(),
+				UserAgent:              testServer.UserAgent(),
 			}
 			test.SaveRecordedTraceFixtures(t, fixture)
 		}()
@@ -128,6 +129,7 @@ func (fr fixtureRecorder) recordLogs(ctx context.Context, t *FakeTesting, timest
 			require.NoError(t, err)
 			fixture := &protos.LogExpectFixture{
 				WriteLogEntriesRequests: testServer.CreateWriteLogEntriesRequests(),
+				UserAgent:               testServer.UserAgent(),
 			}
 			test.SaveRecordedLogFixtures(t, fixture)
 		}()
@@ -172,6 +174,7 @@ func (fr fixtureRecorder) recordMetrics(ctx context.Context, t *FakeTesting, sta
 				CreateTimeSeriesRequests:        testServer.CreateTimeSeriesRequests(),
 				CreateServiceTimeSeriesRequests: testServer.CreateServiceTimeSeriesRequests(),
 				SelfObservabilityMetrics:        selfObsMetrics,
+				UserAgent:                       testServer.UserAgent(),
 			}
 			test.SaveRecordedMetricFixtures(t, fixture)
 		}()

exporter/collector/integrationtest/inmemoryocexporter.go

@@ -188,6 +188,7 @@ func NewLogTestExporter(
 		ctx,
 		cfg,
 		logger,
+		"latest",
 	)
 	require.NoError(t, err)
 

exporter/collector/integrationtest/logs_integration_test.go

@@ -45,6 +45,7 @@ func createLogsExporter(
 		ctx,
 		cfg,
 		logger,
+		"latest",
 	)
 	exporter.ConfigureExporter(test.ConfigureLogsExporter)
 	require.NoError(t, err)

exporter/collector/integrationtest/logs_test.go

@@ -75,6 +75,7 @@ func TestLogs(t *testing.T) {
 
 			fixture := &protos.LogExpectFixture{
 				WriteLogEntriesRequests: testServer.CreateWriteLogEntriesRequests(),
+				UserAgent:               testServer.UserAgent(),
 			}
 			// sort the entries in each request
 			for listIndex := 0; listIndex < len(fixture.WriteLogEntriesRequests); listIndex++ {

exporter/collector/integrationtest/metrics_test.go

@@ -96,6 +96,7 @@ func TestCollectorMetrics(t *testing.T) {
 				CreateMetricDescriptorRequests:  testServer.CreateMetricDescriptorRequests(),
 				CreateServiceTimeSeriesRequests: testServer.CreateServiceTimeSeriesRequests(),
 				SelfObservabilityMetrics:        selfObsMetrics,
+				UserAgent:                       testServer.UserAgent(),
 			}
 			sort.Slice(fixture.CreateTimeSeriesRequests, func(i, j int) bool {
 				return fixture.CreateTimeSeriesRequests[i].Name < fixture.CreateTimeSeriesRequests[j].Name
@@ -183,6 +184,7 @@ func TestSDKMetrics(t *testing.T) {
 					apioption.WithEndpoint(testServer.Endpoint),
 					apioption.WithoutAuthentication(),
 					apioption.WithGRPCDialOption(grpc.WithTransportCredentials(insecure.NewCredentials())),
+					apioption.WithUserAgent("opentelemetry-collector-contrib latest"),
 				)},
 				test.MetricSDKExporterOptions...,
 			)
@@ -225,6 +227,7 @@ func TestSDKMetrics(t *testing.T) {
 				CreateTimeSeriesRequests:        testServer.CreateTimeSeriesRequests(),
 				CreateMetricDescriptorRequests:  testServer.CreateMetricDescriptorRequests(),
 				CreateServiceTimeSeriesRequests: testServer.CreateServiceTimeSeriesRequests(),
+				UserAgent:                       testServer.UserAgent(),
 				// Do not test self-observability metrics with SDK exporters
 			}
 			sort.Slice(fixture.CreateTimeSeriesRequests, func(i, j int) bool {

exporter/collector/integrationtest/protos/fixtures.proto

@@ -25,6 +25,7 @@ message MetricExpectFixture {
   repeated google.monitoring.v3.CreateMetricDescriptorRequest create_metric_descriptor_requests = 2;
   repeated google.monitoring.v3.CreateTimeSeriesRequest create_service_time_series_requests = 3;
   SelfObservabilityMetric self_observability_metrics = 4;
+  string user_agent = 5;
 }
 
 message SelfObservabilityMetric {
@@ -34,8 +35,10 @@ message SelfObservabilityMetric {
 
 message LogExpectFixture {
   repeated google.logging.v2.WriteLogEntriesRequest write_log_entries_requests = 1;
+  string user_agent = 2;
 }
 
 message TraceExpectFixture {
   repeated google.tracing.v2.BatchWriteSpansRequest batch_write_spans_request = 1;
+  string user_agent = 2;
 }

exporter/collector/integrationtest/testcases/testcases_logs.go

@@ -88,4 +88,12 @@ var LogsTestCases = []TestCase{
 			MaxRequestSize: 550,
 		},
 	},
+	{
+		Name:                 "Logs custom user-agent",
+		OTLPInputFixturePath: "testdata/fixtures/logs/logs_span_trace_id.json",
+		ExpectFixturePath:    "testdata/fixtures/logs/logs_user_agent_expected.json",
+		ConfigureCollector: func(cfg *collector.Config) {
+			cfg.UserAgent = "custom-user-agent {{version}}"
+		},
+	},
 }

exporter/collector/integrationtest/testcases/testcases_metrics.go

@@ -22,6 +22,7 @@ import (
 	"go.opentelemetry.io/collector/featuregate"
 	"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/sdk/metric/metricdata"
+	"google.golang.org/api/option"
 
 	"github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/collector"
 	"github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/collector/googlemanagedprometheus"
@@ -317,6 +318,17 @@ var MetricsTestCases = []TestCase{
 		// SDK exporter does not support CreateServiceTimeSeries
 		SkipForSDK: true,
 	},
+	{
+		Name:                 "Custom User Agent",
+		OTLPInputFixturePath: "testdata/fixtures/metrics/counter.json",
+		ExpectFixturePath:    "testdata/fixtures/metrics/counter_user_agent_expect.json",
+		ConfigureCollector: func(cfg *collector.Config) {
+			cfg.UserAgent = "custom-user-agent"
+		},
+		MetricSDKExporterOptions: []metric.Option{
+			metric.WithMonitoringClientOptions(option.WithUserAgent("custom-user-agent")),
+		},
+	},
 	// Tests for the GMP exporter
 	{
 		Name:                 "[GMP] prometheus receiver metrics",

exporter/collector/integrationtest/testcases/testcases_traces.go

@@ -14,10 +14,20 @@
 
 package testcases
 
+import "github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/collector"
+
 var TracesTestCases = []TestCase{
 	{
 		Name:                 "Basic traces",
 		OTLPInputFixturePath: "testdata/fixtures/traces/traces_basic.json",
 		ExpectFixturePath:    "testdata/fixtures/traces/traces_basic_expected.json",
 	},
+	{
+		Name:                 "Custom User Agent",
+		OTLPInputFixturePath: "testdata/fixtures/traces/traces_basic.json",
+		ExpectFixturePath:    "testdata/fixtures/traces/traces_user_agent_expected.json",
+		ConfigureCollector: func(cfg *collector.Config) {
+			cfg.UserAgent = "custom-user-agent {{version}}"
+		},
+	},
 }

exporter/collector/integrationtest/testdata/fixtures/logs/logs_apache_access_batches_expected.json

@@ -451,5 +451,6 @@
       ],
       "partialSuccess": true
     }
-  ]
+  ],
+  "userAgent": "opentelemetry-collector-contrib latest grpc-go/1.57.0"
 }

exporter/collector/integrationtest/testdata/fixtures/logs/logs_apache_access_expected.json

@@ -406,5 +406,6 @@
       ],
       "partialSuccess": true
     }
-  ]
+  ],
+  "userAgent": "opentelemetry-collector-contrib latest grpc-go/1.57.0"
 }

exporter/collector/integrationtest/testdata/fixtures/logs/logs_apache_access_resource_attributes_expected.json

@@ -456,5 +456,6 @@
       ],
       "partialSuccess": true
     }
-  ]
+  ],
+  "userAgent": "opentelemetry-collector-contrib latest grpc-go/1.57.0"
 }

exporter/collector/integrationtest/testdata/fixtures/logs/logs_apache_error_expected.json

@@ -178,5 +178,6 @@
       ],
       "partialSuccess": true
     }
-  ]
+  ],
+  "userAgent": "opentelemetry-collector-contrib latest grpc-go/1.57.0"
 }

exporter/collector/integrationtest/testdata/fixtures/logs/logs_apache_error_scope_expected.json

@@ -26,5 +26,6 @@
       ],
       "partialSuccess": true
     }
-  ]
+  ],
+  "userAgent": "opentelemetry-collector-contrib latest grpc-go/1.57.0"
 }

exporter/collector/integrationtest/testdata/fixtures/logs/logs_apache_json_error_reporting_expected.json

@@ -179,5 +179,6 @@
       ],
       "partialSuccess": true
     }
-  ]
+  ],
+  "userAgent": "opentelemetry-collector-contrib latest grpc-go/1.57.0"
 }

exporter/collector/integrationtest/testdata/fixtures/logs/logs_apache_text_error_reporting_expected.json

@@ -43,5 +43,6 @@
       ],
       "partialSuccess": true
     }
-  ]
+  ],
+  "userAgent": "opentelemetry-collector-contrib latest grpc-go/1.57.0"
 }

exporter/collector/integrationtest/testdata/fixtures/logs/logs_multi_project_destination_quota_expected.json

@@ -776,5 +776,6 @@
       ],
       "partialSuccess": true
     }
-  ]
+  ],
+  "userAgent": "opentelemetry-collector-contrib latest grpc-go/1.57.0"
 }

exporter/collector/integrationtest/testdata/fixtures/logs/logs_multi_project_expected.json

@@ -771,5 +771,6 @@
       ],
       "partialSuccess": true
     }
-  ]
+  ],
+  "userAgent": "opentelemetry-collector-contrib latest grpc-go/1.57.0"
 }

exporter/collector/integrationtest/testdata/fixtures/logs/logs_span_trace_id_expected.json

@@ -127,5 +127,6 @@
       ],
       "partialSuccess": true
     }
-  ]
+  ],
+  "userAgent": "opentelemetry-collector-contrib latest grpc-go/1.57.0"
 }