Skip to content

[Internal] Client Telemetry: Refactors code to use base useragent string #3653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ealsur merged 1 commit into from
Jan 17, 2023
Merged

[Internal] Client Telemetry: Refactors code to use base useragent string #3653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Microsoft.Azure.Cosmos/src/DocumentClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1036,7 +1036,7 @@ private void InitializeClientTelemetry()
this.clientTelemetry = ClientTelemetry.CreateAndStartBackgroundTelemetry(
clientId: this.clientId,
httpClient: this.httpClient,
userAgent: this.ConnectionPolicy.UserAgentContainer.UserAgent,
userAgent: this.ConnectionPolicy.UserAgentContainer.BaseUserAgent,
connectionMode: this.ConnectionPolicy.ConnectionMode,
authorizationTokenProvider: this.cosmosAuthorization,
diagnosticsHelper: DiagnosticsHandlerHelper.Instance,
Expand Down
4 changes: 3 additions & 1 deletion Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.EmulatorTests/ClientTelemetryTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -974,6 +974,7 @@ private static void AssertAccountLevelInformation(
Assert.IsNotNull(telemetryInfo.ProcessId);
Assert.AreEqual(HashingExtension.ComputeHash(System.Diagnostics.Process.GetCurrentProcess().ProcessName), telemetryInfo.ProcessId);
Assert.IsNotNull(telemetryInfo.UserAgent);
Assert.IsFalse(telemetryInfo.UserAgent.Contains("userAgentSuffix"), "Useragent should not have suffix appended"); // Useragent should not contain useragentsuffix as it can have PII
Assert.IsNotNull(telemetryInfo.ConnectionMode);

if(!string.IsNullOrEmpty(telemetryInfo.MachineId))
Expand Down Expand Up @@ -1090,7 +1091,8 @@ private async Task<Container> CreateClientAndContainer(ConnectionMode mode,
}

this.cosmosClientBuilder = this.cosmosClientBuilder
.WithHttpClientFactory(() => new HttpClient(handlerHelper));
.WithHttpClientFactory(() => new HttpClient(handlerHelper))
.WithApplicationName("userAgentSuffix");

this.cosmosClient = mode == ConnectionMode.Gateway
? this.cosmosClientBuilder.WithConnectionModeGateway().Build()
Expand Down