Enrich user-agent with runtime context

Microsoft.Azure.Cosmos/src/CosmosClientOptions.cs

@@ -40,6 +40,7 @@ public class CosmosClientOptions
         private static readonly CosmosSerializer propertiesSerializer = new CosmosJsonSerializerWrapper(new CosmosJsonDotNetSerializer());
 
         private readonly Collection<RequestHandler> customHandlers;
+        private readonly string currentEnvironmentInformation;
 
         private int gatewayModeMaxConnectionLimit;
 
@@ -49,6 +50,9 @@ public class CosmosClientOptions
         public CosmosClientOptions()
         {
             this.UserAgentContainer = new UserAgentContainer();
+            this.EnvironmentInformation = new EnvironmentInformation();
+            this.currentEnvironmentInformation = this.EnvironmentInformation.ToString();
+            this.UserAgentContainer.Suffix = this.currentEnvironmentInformation;
             this.GatewayModeMaxConnectionLimit = ConnectionPolicy.Default.MaxConnectionLimit;
             this.RequestTimeout = ConnectionPolicy.Default.RequestTimeout;
             this.ConnectionMode = CosmosClientOptions.DefaultConnectionMode;
@@ -66,7 +70,7 @@ public CosmosClientOptions()
         public string ApplicationName
         {
             get => this.UserAgentContainer.Suffix;
-            set => this.UserAgentContainer.Suffix = value;
+            set => this.UserAgentContainer.Suffix = this.currentEnvironmentInformation + value;
         }
 
         /// <summary>
@@ -217,6 +221,8 @@ public Collection<RequestHandler> CustomHandlers
 
         internal UserAgentContainer UserAgentContainer { get; private set; }
 
+        internal EnvironmentInformation EnvironmentInformation { get; private set; }
+
         /// <summary>
         /// The event handler to be invoked before the request is sent.
         /// </summary>

Microsoft.Azure.Cosmos/src/EnvironmentInformation.cs

@@ -0,0 +1,48 @@
+//------------------------------------------------------------
+// Copyright (c) Microsoft Corporation.  All rights reserved.
+//------------------------------------------------------------
+namespace Microsoft.Azure.Cosmos
+{
+    using System;
+    using System.Reflection;
+    using System.Runtime.InteropServices;
+
+    //{SDK-id}-{process runtime}-{process-arch}-{host-rutnime}-{host-arch}
+    //{SDK-id}: Should include the name, version, direct version
+    internal sealed class EnvironmentInformation
+    {
+        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.Revision}";
+            EnvironmentInformation.framework = RuntimeInformation.FrameworkDescription;
+            EnvironmentInformation.architecture = RuntimeInformation.ProcessArchitecture.ToString();
+        }
+
+        /// <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}";
+        }
+    }
+}

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

@@ -0,0 +1,48 @@
+//------------------------------------------------------------
+// Copyright (c) Microsoft Corporation.  All rights reserved.
+//------------------------------------------------------------
+
+namespace Microsoft.Azure.Cosmos.Tests
+{
+    using System;
+    using System.Collections.Generic;
+    using System.Threading;
+    using System.Threading.Tasks;
+    using Microsoft.Azure.Cosmos.Common;
+    using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+    [TestClass]
+    public class EnvironmentInformationTests
+    {
+        [TestMethod]
+        public void ClientVersionIsNotNull()
+        {
+            var envInfo = new EnvironmentInformation();
+            Assert.IsNotNull(envInfo.ClientVersion);
+        }
+
+        [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 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));
+        }
+    }
+}