Add observability feature IDs to User Agent header (#3760)

Author: muhammad-othman

generator/.DevConfigs/7d427a71-cb57-42d2-89db-f5b08b5fb559.json

@@ -0,0 +1,9 @@
+{
+  "core": {
+    "changeLogMessages": [
+      "Add observability feature IDs to User Agent header"
+    ],
+    "type": "patch",
+    "updateMinimum": false
+  }
+}

generator/ServiceClientGeneratorLib/Generators/SourceFiles/CoreAssemblyInfo.cs

@@ -15,7 +15,7 @@ namespace ServiceClientGenerator.Generators.SourceFiles
     /// Class to produce the template output
     /// </summary>
 
-    #line 1 "C:\Projects\aws-sdk-net-v4\generator\ServiceClientGeneratorLib\Generators\SourceFiles\CoreAssemblyInfo.tt"
+    #line 1 "C:\repos\aws-sdk-net-v4\generator\ServiceClientGeneratorLib\Generators\SourceFiles\CoreAssemblyInfo.tt"
     [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.TextTemplating", "17.0.0.0")]
     public partial class CoreAssemblyInfo : BaseGenerator
     {
@@ -30,7 +30,7 @@ public override string TransformText()
                     "bly is controlled through the following \r\n// set of attributes. Change these att" +
                     "ribute values to modify the information\r\n// associated with an assembly.\r\n[assem" +
                     "bly: AssemblyTitle(\"AWSSDK.Core\")]\r\n#if BCL\r\n[assembly: AssemblyDescription(\"The" +
-                    " Amazon Web Services SDK for .NET (4.6.2) - Core Runtime\")]\r\n#elif NETSTANDARD20" +
+                    " Amazon Web Services SDK for .NET (4.7.2) - Core Runtime\")]\r\n#elif NETSTANDARD20" +
                     "\r\n[assembly: AssemblyDescription(\"The Amazon Web Services SDK for .NET (NetStand" +
                     "ard 2.0) - Core Runtime\")]\r\n#elif NETCOREAPP3_1\r\n[assembly: AssemblyDescription(" +
                     "\"The Amazon Web Services SDK for .NET (.NET Core 3.1) - Core Runtime\")]\r\n#elif N" +
@@ -41,56 +41,65 @@ public override string TransformText()
                     "004000001000100db5f59f098d27276c7833875a6263a3cc74ab17ba9a9df0b52aedbe7252745db7" +
                     "274d5271fd79c1f08f668ecfa8eaab5626fa76adc811d3c8fc55859b0d09d3bc0a84eecd0ba891f2" +
                     "b8a2fc55141cdcc37c2053d53491e650a479967c3622762977900eddbf1252ed08a2413f00a28f3a" +
-                    "0752a81203f03ccb7f684db373518b4\")]\r\n// Assembly name of UnitTests.NetStandard\r\n[" +
-                    "assembly: InternalsVisibleTo(\"UnitTests, PublicKey=00240000048000009400000006020" +
-                    "00000240000525341310004000001000100db5f59f098d27276c7833875a6263a3cc74ab17ba9a9d" +
-                    "f0b52aedbe7252745db7274d5271fd79c1f08f668ecfa8eaab5626fa76adc811d3c8fc55859b0d09" +
-                    "d3bc0a84eecd0ba891f2b8a2fc55141cdcc37c2053d53491e650a479967c3622762977900eddbf12" +
-                    "52ed08a2413f00a28f3a0752a81203f03ccb7f684db373518b4\")]\r\n[assembly: InternalsVisi" +
-                    "bleTo(\"AWSSDK.UnitTests.Custom.NetStandard, PublicKey=00240000048000009400000006" +
-                    "02000000240000525341310004000001000100db5f59f098d27276c7833875a6263a3cc74ab17ba9" +
-                    "a9df0b52aedbe7252745db7274d5271fd79c1f08f668ecfa8eaab5626fa76adc811d3c8fc55859b0" +
-                    "d09d3bc0a84eecd0ba891f2b8a2fc55141cdcc37c2053d53491e650a479967c3622762977900eddb" +
-                    "f1252ed08a2413f00a28f3a0752a81203f03ccb7f684db373518b4\")]\r\n[assembly: InternalsV" +
-                    "isibleTo(\"UnitTests.NetStandard.CoreOnly, PublicKey=0024000004800000940000000602" +
-                    "000000240000525341310004000001000100db5f59f098d27276c7833875a6263a3cc74ab17ba9a9" +
-                    "df0b52aedbe7252745db7274d5271fd79c1f08f668ecfa8eaab5626fa76adc811d3c8fc55859b0d0" +
-                    "9d3bc0a84eecd0ba891f2b8a2fc55141cdcc37c2053d53491e650a479967c3622762977900eddbf1" +
-                    "252ed08a2413f00a28f3a0752a81203f03ccb7f684db373518b4\")]\r\n// Allows moq to access" +
-                    " internals for testing\r\n[assembly: InternalsVisibleTo(\"DynamicProxyGenAssembly2," +
-                    " PublicKey=0024000004800000940000000602000000240000525341310004000001000100c547c" +
-                    "ac37abd99c8db225ef2f6c8a3602f3b3606cc9891605d02baa56104f4cfc0734aa39b93bf7852f7d" +
-                    "9266654753cc297e7d2edfe0bac1cdcf9f717241550e0a7b191195b7667bb4f64bcb8e2121380fd1" +
-                    "d9d46ad2d92d2d15605093924cceaf74c4861eff62abf69b9291ed0a340e113be11e6a7d3113e924" +
-                    "84cf7045cc7\")]\r\n[assembly: AssemblyConfiguration(\"\")]\r\n[assembly: AssemblyProduc" +
-                    "t(\"Amazon Web Services SDK for .NET\")]\r\n[assembly: AssemblyCompany(\"Amazon.com, " +
-                    "Inc\")]\r\n[assembly: AssemblyCopyright(\"Copyright Amazon.com, Inc. or its affiliat" +
-                    "es. All Rights Reserved.\")]\r\n[assembly: AssemblyTrademark(\"\")]\r\n[assembly: Assem" +
-                    "blyCulture(\"\")]\r\n\r\n// Setting ComVisible to false makes the types in this assemb" +
-                    "ly not visible \r\n// to COM components.  If you need to access a type in this ass" +
-                    "embly from \r\n// COM, set the ComVisible attribute to true on that type.\r\n[assemb" +
-                    "ly: ComVisible(false)]\r\n\r\n// Version information for an assembly consists of the" +
-                    " following four values:\r\n//\r\n//      Major Version\r\n//      Minor Version \r\n//  " +
-                    "    Build Number\r\n//      Revision\r\n//\r\n// You can specify all the values or you" +
-                    " can default the Build and Revision Numbers \r\n// by using the \'*\' as shown below" +
-                    ":\r\n// [assembly: AssemblyVersion(\"1.0.*\")]\r\n#if BCL\r\n[assembly: AssemblyVersion(" +
-                    "\"");
+                    "0752a81203f03ccb7f684db373518b4\")]\r\n[assembly: InternalsVisibleTo(\"AWSSDK.UnitTe" +
+                    "stUtilities, PublicKey=002400000480000094000000060200000024000052534131000400000" +
+                    "1000100db5f59f098d27276c7833875a6263a3cc74ab17ba9a9df0b52aedbe7252745db7274d5271" +
+                    "fd79c1f08f668ecfa8eaab5626fa76adc811d3c8fc55859b0d09d3bc0a84eecd0ba891f2b8a2fc55" +
+                    "141cdcc37c2053d53491e650a479967c3622762977900eddbf1252ed08a2413f00a28f3a0752a812" +
+                    "03f03ccb7f684db373518b4\")]\r\n// Assembly name of UnitTests.NetStandard\r\n[assembly" +
+                    ": InternalsVisibleTo(\"UnitTests, PublicKey=0024000004800000940000000602000000240" +
+                    "000525341310004000001000100db5f59f098d27276c7833875a6263a3cc74ab17ba9a9df0b52aed" +
+                    "be7252745db7274d5271fd79c1f08f668ecfa8eaab5626fa76adc811d3c8fc55859b0d09d3bc0a84" +
+                    "eecd0ba891f2b8a2fc55141cdcc37c2053d53491e650a479967c3622762977900eddbf1252ed08a2" +
+                    "413f00a28f3a0752a81203f03ccb7f684db373518b4\")]\r\n[assembly: InternalsVisibleTo(\"A" +
+                    "WSSDK.UnitTestUtilities.NetStandard, PublicKey=002400000480000094000000060200000" +
+                    "0240000525341310004000001000100db5f59f098d27276c7833875a6263a3cc74ab17ba9a9df0b5" +
+                    "2aedbe7252745db7274d5271fd79c1f08f668ecfa8eaab5626fa76adc811d3c8fc55859b0d09d3bc" +
+                    "0a84eecd0ba891f2b8a2fc55141cdcc37c2053d53491e650a479967c3622762977900eddbf1252ed" +
+                    "08a2413f00a28f3a0752a81203f03ccb7f684db373518b4\")]\r\n[assembly: InternalsVisibleT" +
+                    "o(\"AWSSDK.UnitTests.Custom.NetStandard, PublicKey=002400000480000094000000060200" +
+                    "0000240000525341310004000001000100db5f59f098d27276c7833875a6263a3cc74ab17ba9a9df" +
+                    "0b52aedbe7252745db7274d5271fd79c1f08f668ecfa8eaab5626fa76adc811d3c8fc55859b0d09d" +
+                    "3bc0a84eecd0ba891f2b8a2fc55141cdcc37c2053d53491e650a479967c3622762977900eddbf125" +
+                    "2ed08a2413f00a28f3a0752a81203f03ccb7f684db373518b4\")]\r\n[assembly: InternalsVisib" +
+                    "leTo(\"UnitTests.NetStandard.CoreOnly, PublicKey=00240000048000009400000006020000" +
+                    "00240000525341310004000001000100db5f59f098d27276c7833875a6263a3cc74ab17ba9a9df0b" +
+                    "52aedbe7252745db7274d5271fd79c1f08f668ecfa8eaab5626fa76adc811d3c8fc55859b0d09d3b" +
+                    "c0a84eecd0ba891f2b8a2fc55141cdcc37c2053d53491e650a479967c3622762977900eddbf1252e" +
+                    "d08a2413f00a28f3a0752a81203f03ccb7f684db373518b4\")]\r\n// Allows moq to access int" +
+                    "ernals for testing\r\n[assembly: InternalsVisibleTo(\"DynamicProxyGenAssembly2, Pub" +
+                    "licKey=0024000004800000940000000602000000240000525341310004000001000100c547cac37" +
+                    "abd99c8db225ef2f6c8a3602f3b3606cc9891605d02baa56104f4cfc0734aa39b93bf7852f7d9266" +
+                    "654753cc297e7d2edfe0bac1cdcf9f717241550e0a7b191195b7667bb4f64bcb8e2121380fd1d9d4" +
+                    "6ad2d92d2d15605093924cceaf74c4861eff62abf69b9291ed0a340e113be11e6a7d3113e92484cf" +
+                    "7045cc7\")]\r\n[assembly: AssemblyConfiguration(\"\")]\r\n[assembly: AssemblyProduct(\"A" +
+                    "mazon Web Services SDK for .NET\")]\r\n[assembly: AssemblyCompany(\"Amazon.com, Inc\"" +
+                    ")]\r\n[assembly: AssemblyCopyright(\"Copyright Amazon.com, Inc. or its affiliates. " +
+                    "All Rights Reserved.\")]\r\n[assembly: AssemblyTrademark(\"\")]\r\n[assembly: AssemblyC" +
+                    "ulture(\"\")]\r\n\r\n// Setting ComVisible to false makes the types in this assembly n" +
+                    "ot visible \r\n// to COM components.  If you need to access a type in this assembl" +
+                    "y from \r\n// COM, set the ComVisible attribute to true on that type.\r\n[assembly: " +
+                    "ComVisible(false)]\r\n\r\n// Version information for an assembly consists of the fol" +
+                    "lowing four values:\r\n//\r\n//      Major Version\r\n//      Minor Version \r\n//      " +
+                    "Build Number\r\n//      Revision\r\n//\r\n// You can specify all the values or you can" +
+                    " default the Build and Revision Numbers \r\n// by using the \'*\' as shown below:\r\n/" +
+                    "/ [assembly: AssemblyVersion(\"1.0.*\")]\r\n#if BCL\r\n[assembly: AssemblyVersion(\"");
 
-            #line 54 "C:\Projects\aws-sdk-net-v4\generator\ServiceClientGeneratorLib\Generators\SourceFiles\CoreAssemblyInfo.tt"
+            #line 56 "C:\repos\aws-sdk-net-v4\generator\ServiceClientGeneratorLib\Generators\SourceFiles\CoreAssemblyInfo.tt"
             this.Write(this.ToStringHelper.ToStringWithCulture(this.Session["Version"]));
 
             #line default
             #line hidden
             this.Write("\")]\r\n#else\r\n[assembly: AssemblyVersion(\"");
 
-            #line 56 "C:\Projects\aws-sdk-net-v4\generator\ServiceClientGeneratorLib\Generators\SourceFiles\CoreAssemblyInfo.tt"
+            #line 58 "C:\repos\aws-sdk-net-v4\generator\ServiceClientGeneratorLib\Generators\SourceFiles\CoreAssemblyInfo.tt"
             this.Write(this.ToStringHelper.ToStringWithCulture(this.Session["FileVersion"]));
 
             #line default
             #line hidden
             this.Write("\")]\r\n#endif\r\n[assembly: AssemblyFileVersion(\"");
 
-            #line 58 "C:\Projects\aws-sdk-net-v4\generator\ServiceClientGeneratorLib\Generators\SourceFiles\CoreAssemblyInfo.tt"
+            #line 60 "C:\repos\aws-sdk-net-v4\generator\ServiceClientGeneratorLib\Generators\SourceFiles\CoreAssemblyInfo.tt"
             this.Write(this.ToStringHelper.ToStringWithCulture(this.Session["FileVersion"]));
 
             #line default

generator/ServiceClientGeneratorLib/Generators/SourceFiles/CoreAssemblyInfo.tt

@@ -11,7 +11,7 @@ using System.Runtime.CompilerServices;
 // associated with an assembly.
 [assembly: AssemblyTitle("AWSSDK.Core")]
 #if BCL
-[assembly: AssemblyDescription("The Amazon Web Services SDK for .NET (4.6.2) - Core Runtime")]
+[assembly: AssemblyDescription("The Amazon Web Services SDK for .NET (4.7.2) - Core Runtime")]
 #elif NETSTANDARD20
 [assembly: AssemblyDescription("The Amazon Web Services SDK for .NET (NetStandard 2.0) - Core Runtime")]
 #elif NETCOREAPP3_1
@@ -22,8 +22,10 @@ using System.Runtime.CompilerServices;
 #error Unknown platform constant - unable to set correct AssemblyDescription
 #endif
 [assembly: InternalsVisibleTo("AWSSDK.UnitTests.NetFramework, PublicKey=0024000004800000940000000602000000240000525341310004000001000100db5f59f098d27276c7833875a6263a3cc74ab17ba9a9df0b52aedbe7252745db7274d5271fd79c1f08f668ecfa8eaab5626fa76adc811d3c8fc55859b0d09d3bc0a84eecd0ba891f2b8a2fc55141cdcc37c2053d53491e650a479967c3622762977900eddbf1252ed08a2413f00a28f3a0752a81203f03ccb7f684db373518b4")]
+[assembly: InternalsVisibleTo("AWSSDK.UnitTestUtilities, PublicKey=0024000004800000940000000602000000240000525341310004000001000100db5f59f098d27276c7833875a6263a3cc74ab17ba9a9df0b52aedbe7252745db7274d5271fd79c1f08f668ecfa8eaab5626fa76adc811d3c8fc55859b0d09d3bc0a84eecd0ba891f2b8a2fc55141cdcc37c2053d53491e650a479967c3622762977900eddbf1252ed08a2413f00a28f3a0752a81203f03ccb7f684db373518b4")]
 // Assembly name of UnitTests.NetStandard
 [assembly: InternalsVisibleTo("UnitTests, PublicKey=0024000004800000940000000602000000240000525341310004000001000100db5f59f098d27276c7833875a6263a3cc74ab17ba9a9df0b52aedbe7252745db7274d5271fd79c1f08f668ecfa8eaab5626fa76adc811d3c8fc55859b0d09d3bc0a84eecd0ba891f2b8a2fc55141cdcc37c2053d53491e650a479967c3622762977900eddbf1252ed08a2413f00a28f3a0752a81203f03ccb7f684db373518b4")]
+[assembly: InternalsVisibleTo("AWSSDK.UnitTestUtilities.NetStandard, PublicKey=0024000004800000940000000602000000240000525341310004000001000100db5f59f098d27276c7833875a6263a3cc74ab17ba9a9df0b52aedbe7252745db7274d5271fd79c1f08f668ecfa8eaab5626fa76adc811d3c8fc55859b0d09d3bc0a84eecd0ba891f2b8a2fc55141cdcc37c2053d53491e650a479967c3622762977900eddbf1252ed08a2413f00a28f3a0752a81203f03ccb7f684db373518b4")]
 [assembly: InternalsVisibleTo("AWSSDK.UnitTests.Custom.NetStandard, PublicKey=0024000004800000940000000602000000240000525341310004000001000100db5f59f098d27276c7833875a6263a3cc74ab17ba9a9df0b52aedbe7252745db7274d5271fd79c1f08f668ecfa8eaab5626fa76adc811d3c8fc55859b0d09d3bc0a84eecd0ba891f2b8a2fc55141cdcc37c2053d53491e650a479967c3622762977900eddbf1252ed08a2413f00a28f3a0752a81203f03ccb7f684db373518b4")]
 [assembly: InternalsVisibleTo("UnitTests.NetStandard.CoreOnly, PublicKey=0024000004800000940000000602000000240000525341310004000001000100db5f59f098d27276c7833875a6263a3cc74ab17ba9a9df0b52aedbe7252745db7274d5271fd79c1f08f668ecfa8eaab5626fa76adc811d3c8fc55859b0d09d3bc0a84eecd0ba891f2b8a2fc55141cdcc37c2053d53491e650a479967c3622762977900eddbf1252ed08a2413f00a28f3a0752a81203f03ccb7f684db373518b4")]
 // Allows moq to access internals for testing

sdk/src/Core/Amazon.Runtime/Internal/UserAgent/UserAgentFeatureId.cs

@@ -240,6 +240,26 @@ public class UserAgentFeatureId : ConstantClass
         /// </summary>
         public static readonly UserAgentFeatureId SSO_LOGIN_AUTH = new UserAgentFeatureId("2");
 
+        /// <summary>
+        /// Indicates that an AWS SDK client has been configured with a non-null, non-NoOp tracing provider.
+        /// </summary>
+        public static readonly UserAgentFeatureId OBSERVABILITY_TRACING = new UserAgentFeatureId("4");
+
+        /// <summary>
+        /// Indicates that an AWS SDK client has been configured with a non-null, non-NoOp metrics provider.
+        /// </summary>
+        public static readonly UserAgentFeatureId OBSERVABILITY_METRICS = new UserAgentFeatureId("5");
+
+        /// <summary>
+        /// Indicates that an AWS SDK client has been configured with an OpenTelemetry tracing provider.
+        /// </summary>
+        public static readonly UserAgentFeatureId OBSERVABILITY_OTEL_TRACING = new UserAgentFeatureId("6");
+
+        /// <summary>
+        /// Indicates that an AWS SDK client has been configured with an OpenTelemetry metrics provider.
+        /// </summary>
+        public static readonly UserAgentFeatureId OBSERVABILITY_OTEL_METRICS = new UserAgentFeatureId("7");
+
         public UserAgentFeatureId(string value) : base(value) { }
 
         public static UserAgentFeatureId FindValue(string value)

sdk/src/Core/Amazon.Runtime/Pipeline/Handlers/Marshaller.cs

@@ -21,6 +21,8 @@
 using Amazon.Runtime.Internal.UserAgent;
 using Amazon.Runtime.Telemetry;
 using Amazon.Runtime.Telemetry.Metrics;
+using Amazon.Runtime.Telemetry.Metrics.NoOp;
+using Amazon.Runtime.Telemetry.Tracing.NoOp;
 using Amazon.Util;
 using Amazon.Util.Internal;
 
@@ -143,6 +145,35 @@ private static void UpdateUserAgentDetails(IRequestContext requestContext)
             requestContext.UserAgentDetails.AddUserAgentComponent($"md/{(requestContext.IsAsync ? "ClientAsync" : "ClientSync")}");
 
             requestContext.UserAgentDetails.AddUserAgentComponent($"cfg/init-coll#{(AWSConfigs.InitializeCollections ? '1' : '0')}");
+
+            SetObservabilityFeatureIds(requestContext);
+        }
+
+        private static void SetObservabilityFeatureIds(IRequestContext requestContext)
+        {
+            var config = requestContext.ClientConfig;
+
+            if (!(config.TelemetryProvider.TracerProvider is NoOpTracerProvider))
+            {
+                requestContext.UserAgentDetails.AddFeature(UserAgentFeatureId.OBSERVABILITY_TRACING);
+
+                var tracerType = config.TelemetryProvider.TracerProvider.GetType();
+                if (tracerType.Namespace.StartsWith("OpenTelemetry.Instrumentation.AWS"))
+                {
+                    requestContext.UserAgentDetails.AddFeature(UserAgentFeatureId.OBSERVABILITY_OTEL_TRACING);
+                }
+            }
+
+            if (!(config.TelemetryProvider.MeterProvider is NoOpMeterProvider))
+            {
+                requestContext.UserAgentDetails.AddFeature(UserAgentFeatureId.OBSERVABILITY_METRICS);
+
+                var meterType = config.TelemetryProvider.MeterProvider.GetType();
+                if (meterType.Namespace.StartsWith("OpenTelemetry.Instrumentation.AWS"))
+                {
+                    requestContext.UserAgentDetails.AddFeature(UserAgentFeatureId.OBSERVABILITY_OTEL_METRICS);
+                }
+            }
         }
     }
 }