Enrich user-agent with runtime context

Microsoft.Azure.Cosmos/src/CosmosClientOptions.cs

@@ -40,15 +40,20 @@ public class CosmosClientOptions
  private static readonly CosmosSerializer propertiesSerializer = new CosmosJsonSerializerWrapper(new CosmosJsonDotNetSerializer());
 
  private readonly Collection<RequestHandler> customHandlers;
+ private readonly string currentEnvironmentInformation;
 
  private int gatewayModeMaxConnectionLimit;
+ private string applicationName;
 
  /// <summary>
  /// Creates a new CosmosClientOptions
  /// </summary>
  public CosmosClientOptions()
  {
  this.UserAgentContainer = new UserAgentContainer();
+ EnvironmentInformation environmentInformation = new EnvironmentInformation();
+ this.currentEnvironmentInformation = environmentInformation.ToString();
+ this.UserAgentContainer.Suffix = this.currentEnvironmentInformation;
  this.GatewayModeMaxConnectionLimit = ConnectionPolicy.Default.MaxConnectionLimit;
  this.RequestTimeout = ConnectionPolicy.Default.RequestTimeout;
  this.ConnectionMode = CosmosClientOptions.DefaultConnectionMode;
@@ -65,8 +70,12 @@ public CosmosClientOptions()
  /// </remarks>
  public string ApplicationName
  {
- get => this.UserAgentContainer.Suffix;
- set => this.UserAgentContainer.Suffix = value;
+ get => this.applicationName;
+ set
+ {
+ this.UserAgentContainer.Suffix = this.currentEnvironmentInformation + value;
+ this.applicationName = value;
+ }
  }
 
  /// <summary>

Microsoft.Azure.Cosmos/src/EnvironmentInformation.cs

@@ -0,0 +1,53 @@
+//------------------------------------------------------------
+// Copyright (c) Microsoft Corporation. All rights reserved.
+//------------------------------------------------------------
+namespace Microsoft.Azure.Cosmos
+{
+ using System;
+ using System.Reflection;
+ using System.Runtime.InteropServices;
+
+ internal sealed class EnvironmentInformation
+ {
+ internal static readonly string clientId;
+ internal static readonly string clientSDKVersion;
+ internal static readonly string framework;
+ internal static readonly string architecture;
+
+ static EnvironmentInformation()
+ {
+ Version sdkVersion = Assembly.GetAssembly(typeof(CosmosClient)).GetName().Version;
+ EnvironmentInformation.clientSDKVersion = $"{sdkVersion.Major}.{sdkVersion.Minor}.{sdkVersion.Build}";
+ EnvironmentInformation.framework = RuntimeInformation.FrameworkDescription;
+ EnvironmentInformation.architecture = RuntimeInformation.ProcessArchitecture.ToString();
+ EnvironmentInformation.clientId = DateTime.UtcNow.Ticks.ToString();
+ }
+
+ /// <summary>
+ /// Unique identifier of a client
+ /// </summary>
+ public string ClientId => EnvironmentInformation.clientId;
+
+ /// <summary>
+ /// Version of the current client.
+ /// </summary>
+ public string ClientVersion => EnvironmentInformation.clientSDKVersion;
+
+ /// <summary>
+ /// Identifier of the Framework.
+ /// </summary>
+ /// <seealso cref="RuntimeInformation.FrameworkDescription"/>
+ public string RuntimeFramework => EnvironmentInformation.framework;
+
+ /// <summary>
+ /// Type of architecture being used.
+ /// </summary>
+ /// <seealso cref="RuntimeInformation.ProcessArchitecture"/>
+ public string ProcessArchitecture => EnvironmentInformation.architecture;
+
+ public override string ToString()
+ {
+ return $" {this.ClientVersion}-{this.RuntimeFramework} {this.ProcessArchitecture} {this.ClientId}";
+ }
+ }
+}

Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.Tests/CosmosClientOptionsUnitTests.cs

@@ -90,7 +90,7 @@ public void VerifyCosmosConfigurationPropertiesGetUpdated()
  Assert.AreEqual(Protocol.Https, policy.ConnectionProtocol);
  Assert.AreEqual(maxConnections, policy.MaxConnectionLimit);
  Assert.AreEqual(requestTimeout, policy.RequestTimeout);
- Assert.AreEqual(userAgentSuffix, policy.UserAgentSuffix);
+ Assert.IsTrue(policy.UserAgentSuffix.Contains(userAgentSuffix));
  Assert.IsTrue(policy.UseMultipleWriteLocations);
  Assert.AreEqual(maxRetryAttemptsOnThrottledRequests, policy.RetryOptions.MaxRetryAttemptsOnThrottledRequests);
  Assert.AreEqual((int)maxRetryWaitTime.TotalSeconds, policy.RetryOptions.MaxRetryWaitTimeInSeconds);
@@ -116,6 +116,23 @@ public void ThrowOnNullEndpoint()
  new CosmosClientBuilder(null, "testKey");
  }
 
+ [TestMethod]
+ public void UserAgentContainsEnvironmentInformation()
+ {
+ var environmentInformation = new EnvironmentInformation();
+ var expectedValue = environmentInformation.ToString();
+ CosmosClientOptions cosmosClientOptions = new CosmosClientOptions();
+ string userAgentSuffix = "testSuffix";
+ cosmosClientOptions.ApplicationName = userAgentSuffix;
+
+ Assert.IsTrue(cosmosClientOptions.UserAgentContainer.Suffix.EndsWith(userAgentSuffix));
+ Assert.IsTrue(cosmosClientOptions.UserAgentContainer.Suffix.Contains(expectedValue));
+
+ ConnectionPolicy connectionPolicy = cosmosClientOptions.GetConnectionPolicy();
+ Assert.IsTrue(connectionPolicy.UserAgentSuffix.EndsWith(userAgentSuffix));
+ Assert.IsTrue(connectionPolicy.UserAgentSuffix.Contains(expectedValue));
+ }
+
  [TestMethod]
  [ExpectedException(typeof(ArgumentNullException))]
  public void ThrowOnNullConnectionString()

Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.Tests/EnvironmentInformationTests.cs

@@ -0,0 +1,56 @@
+//------------------------------------------------------------
+// Copyright (c) Microsoft Corporation. All rights reserved.
+//------------------------------------------------------------
+
+namespace Microsoft.Azure.Cosmos.Tests
+{
+ using System;
+ using System.Reflection;
+ using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+ [TestClass]
+ public class EnvironmentInformationTests
+ {
+ [TestMethod]
+ public void ClientVersionIsNotNull()
+ {
+ var envInfo = new EnvironmentInformation();
+ Assert.IsNotNull(envInfo.ClientVersion);
+
+ Version sdkVersion = Assembly.GetAssembly(typeof(CosmosClient)).GetName().Version;
+ Assert.AreEqual($"{sdkVersion.Major}.{sdkVersion.Minor}.{sdkVersion.Build}", envInfo.ClientVersion, "Version format differs");
+ }
+
+ [TestMethod]
+ public void ProcessArchitectureIsNotNull()
+ {
+ var envInfo = new EnvironmentInformation();
+ Assert.IsNotNull(envInfo.ProcessArchitecture);
+ }
+
+ [TestMethod]
+ public void FrameworkIsNotNull()
+ {
+ var envInfo = new EnvironmentInformation();
+ Assert.IsNotNull(envInfo.RuntimeFramework);
+ }
+
+ [TestMethod]
+ public void ClientIdIsNotNull()
+ {
+ var envInfo = new EnvironmentInformation();
+ Assert.IsNotNull(envInfo.ClientId);
+ }
+
+ [TestMethod]
+ public void ToStringContainsAll()
+ {
+ var envInfo = new EnvironmentInformation();
+ var serialization = envInfo.ToString();
+ Assert.IsTrue(serialization.Contains(envInfo.ClientVersion));
+ Assert.IsTrue(serialization.Contains(envInfo.ProcessArchitecture));
+ Assert.IsTrue(serialization.Contains(envInfo.RuntimeFramework));
+ Assert.IsTrue(serialization.Contains(envInfo.ClientId));
+ }
+ }
+}

changelog.md

@@ -5,6 +5,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Added
+- [#630](https://github.com/Azure/azure-cosmos-dotnet-v3/pull/630) Added environment information to the User Agent
+
 ### Fixed
 
 - [#612](https://github.com/Azure/azure-cosmos-dotnet-v3/pull/612) Bug fix for ReadFeed with partition-key