[Extensions.AWS] Add net6.0 target framework, optimize AWSXRayIdGenerator

src/OpenTelemetry.Extensions.AWS/.publicApi/net6.0/PublicAPI.Shipped.txt

@@ -0,0 +1 @@
+#nullable enable

src/OpenTelemetry.Extensions.AWS/.publicApi/net6.0/PublicAPI.Unshipped.txt

@@ -0,0 +1,11 @@
+OpenTelemetry.Extensions.AWS.AWSXRayIdGenerator
+OpenTelemetry.Extensions.AWS.Trace.AWSXRayPropagator
+OpenTelemetry.Extensions.AWS.Trace.AWSXRayPropagator.AWSXRayPropagator() -> void
+OpenTelemetry.Trace.TracerProviderBuilderExtensions
+override OpenTelemetry.Extensions.AWS.Trace.AWSXRayPropagator.Extract<T>(OpenTelemetry.Context.Propagation.PropagationContext context, T carrier, System.Func<T, string!, System.Collections.Generic.IEnumerable<string!>!>! getter) -> OpenTelemetry.Context.Propagation.PropagationContext
+override OpenTelemetry.Extensions.AWS.Trace.AWSXRayPropagator.Fields.get -> System.Collections.Generic.ISet<string!>!
+override OpenTelemetry.Extensions.AWS.Trace.AWSXRayPropagator.Inject<T>(OpenTelemetry.Context.Propagation.PropagationContext context, T carrier, System.Action<T, string!, string!>! setter) -> void
+static OpenTelemetry.Extensions.AWS.AWSXRayIdGenerator.ReplaceTraceId() -> void
+static OpenTelemetry.Extensions.AWS.AWSXRayIdGenerator.ReplaceTraceId(OpenTelemetry.Trace.Sampler! sampler) -> void
+static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddXRayTraceId(this OpenTelemetry.Trace.TracerProviderBuilder! builder) -> OpenTelemetry.Trace.TracerProviderBuilder!
+static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddXRayTraceIdWithSampler(this OpenTelemetry.Trace.TracerProviderBuilder! builder, OpenTelemetry.Trace.Sampler! sampler) -> OpenTelemetry.Trace.TracerProviderBuilder!

src/OpenTelemetry.Extensions.AWS/AWSXRayIdGenerator.cs

@@ -14,6 +14,7 @@
 // limitations under the License.
 // </copyright>
 
+#if !NET6_0_OR_GREATER
 using System;
 using System.Diagnostics;
 using System.Globalization;
@@ -50,7 +51,6 @@ internal static void ReplaceTraceId(Sampler? sampler = null)
                 {
                     var awsXRayTraceId = GenerateAWSXRayCompatibleTraceId();
 
-                    // TODO: Apply API to directly modify trace id once .NET runtime publicizes it.
                     activity.SetParentId(awsXRayTraceId, default, activity.ActivityTraceFlags);
 
                     // When not using instrumented library and creating root activity using ActivitySource.StartActivity(),
@@ -197,3 +197,4 @@ private static ActivitySamplingResult ComputeRootActivitySamplingResult(
         return ActivitySamplingResult.PropagationData;
     }
 }
+#endif

src/OpenTelemetry.Extensions.AWS/AWSXRayIdGenerator.net6.cs

@@ -0,0 +1,71 @@
+// <copyright file="AWSXRayIdGenerator.net6.cs" company="OpenTelemetry Authors">
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+
+#if NET6_0_OR_GREATER
+using System;
+using System.Buffers.Binary;
+using System.Diagnostics;
+using System.Security.Cryptography;
+using OpenTelemetry.Trace;
+
+namespace OpenTelemetry.Extensions.AWS;
+
+/// <summary>
+/// Generate AWS X-Ray compatible trace IDs.
+/// See https://docs.aws.amazon.com/xray/latest/devguide/xray-api-sendingdata.html#xray-api-traceids.
+/// </summary>
+public static class AWSXRayIdGenerator
+{
+    /// <summary>
+    /// Sets <see cref="Activity.TraceIdGenerator"/> to <see cref="GenerateAWSXRayCompatibleTraceId"/>.
+    /// </summary>
+    public static void ReplaceTraceId()
+    {
+        Activity.TraceIdGenerator = GenerateAWSXRayCompatibleTraceId;
+    }
+
+    /// <summary>
+    /// Sets <see cref="Activity.TraceIdGenerator"/> to <see cref="GenerateAWSXRayCompatibleTraceId"/>.
+    /// </summary>
+    /// <param name="sampler">Unused. (See deprecation message.)</param>
+    [Obsolete($"When targeting .NET 6.0 or later, the X-Ray ID generator does not need to update the sampling decision. Use ${nameof(ReplaceTraceId)}() instead.")]
+    public static void ReplaceTraceId(Sampler sampler)
+    {
+        ReplaceTraceId();
+    }
+
+    /// <summary>
+    /// Generates an AWS X-Ray compatible trace ID.
+    /// </summary>
+    /// <returns>
+    /// An <see cref="ActivityTraceId"/> whose first 4 bytes are the big-endian unix timestamp (in seconds) and whose
+    /// remaining 12 bytes are randomly generated.
+    /// </returns>
+    internal static ActivityTraceId GenerateAWSXRayCompatibleTraceId()
+    {
+        Span<byte> buffer = stackalloc byte[16];
+
+        // intentionally truncating to 4 bytes because AWS X-Ray requires 8 hex characters
+        var seconds = (uint)DateTimeOffset.UtcNow.ToUnixTimeSeconds();
+        _ = BinaryPrimitives.TryWriteUInt32BigEndian(buffer, seconds);
+
+        // fill the rest of the buffer with random bytes
+        RandomNumberGenerator.Fill(buffer.Slice(4, 12));
+
+        return ActivityTraceId.CreateFromBytes(buffer);
+    }
+}
+#endif

src/OpenTelemetry.Extensions.AWS/CHANGELOG.md

@@ -21,6 +21,9 @@
   supporting ResourceBuilderExtensions extension, and migrate all detectors to
   implement OpenTelemetry.Resources.IResourceDetector
   ([#875](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/875))
+* Add a `net6.0` build with optimized trace ID generation using the new
+  `Activity.TraceIdGenerator` API.
+  ([#1096](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/1096))
 * Drop support for `AWSLambdaResourceDetector`.
   AWS Lambda Resources are detected by `OpenTelemetry.Instrumentation.AWSLambda`
   package

src/OpenTelemetry.Extensions.AWS/OpenTelemetry.Extensions.AWS.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <!-- OmniSharp/VS Code requires TargetFrameworks to be in descending order for IntelliSense and analysis. -->
-    <TargetFrameworks>netstandard2.0</TargetFrameworks>
+    <TargetFrameworks>net6.0;netstandard2.0</TargetFrameworks>
     <TargetFrameworks Condition="$(OS) == 'Windows_NT'">$(TargetFrameworks);$(NetFrameworkMinimumSupportedVersion)</TargetFrameworks>
     <Description>OpenTelemetry extensions for AWS.</Description>
     <MinVerTagPrefix>Extensions.AWSXRay-</MinVerTagPrefix>

src/OpenTelemetry.Extensions.AWS/Trace/AWSXRayPropagator.cs

@@ -306,9 +306,9 @@ internal static string ToXRayTraceIdFormat(string traceId)
 
         sb.Append(Version);
         sb.Append(TraceIdDelimiter);
-        sb.Append(traceId.Substring(0, EpochHexDigits));
+        sb.Append(traceId, 0, EpochHexDigits);
         sb.Append(TraceIdDelimiter);
-        sb.Append(traceId.Substring(EpochHexDigits));
+        sb.Append(traceId, EpochHexDigits, traceId.Length - EpochHexDigits);
 
         return sb.ToString();
     }

src/OpenTelemetry.Extensions.AWS/TracerProviderBuilderExtensions.cs

@@ -37,13 +37,23 @@ public static TracerProviderBuilder AddXRayTraceId(this TracerProviderBuilder bu
         return builder;
     }
 
+#if NET6_0_OR_GREATER
+    /// <summary>
+    /// Replace the trace id of root activity.
+    /// </summary>
+    /// <param name="builder"><see cref="TracerProviderBuilder"/> being configured.</param>
+    /// <param name="sampler">Unused. (See deprecation message.)</param>
+    /// <returns>The instance of <see cref="TracerProviderBuilder"/>.</returns>
+    [System.Obsolete($"When targeting .NET 6.0 or later, the X-Ray ID generator does not need to update the sampling decision. Use ${nameof(AddXRayTraceId)} instead.")]
+#else
     /// <summary>
     /// 1. Replace the trace id of root activity.
     /// 2. Update the sampling decision for root activity when it's created through ActivitySource.StartActivity().
     /// </summary>
     /// <param name="builder"><see cref="TracerProviderBuilder"/> being configured.</param>
     /// <param name="sampler"><see cref="Sampler"/> being used.</param>
     /// <returns>The instance of <see cref="TracerProviderBuilder"/>.</returns>
+#endif
     public static TracerProviderBuilder AddXRayTraceIdWithSampler(this TracerProviderBuilder builder, Sampler sampler)
     {
         Guard.ThrowIfNull(builder);

test/OpenTelemetry.Extensions.AWS.Tests/AWSXRayIdGeneratorTests.cs

@@ -36,7 +36,12 @@ public void TestGenerateTraceIdForRootNode()
             activity.Start();
 
             Assert.NotEqual(originalTraceId, activity.TraceId);
+#if NET6_0_OR_GREATER
+            // the net6.0 version of AWSXRayIdGenerator uses Activity.TraceIdGenerator, which does not change the parent ID
+            Assert.Equal(originalParentSpanId, activity.ParentSpanId);
+#else
             Assert.NotEqual(originalParentSpanId, activity.ParentSpanId);
+#endif
             Assert.Equal("0000000000000000", activity.ParentSpanId.ToHexString());
             Assert.Equal(originalTraceFlag, activity.ActivityTraceFlags);
         }
@@ -81,11 +86,13 @@ public void TestGenerateTraceIdForNonRootNodeNotSampled()
     [Fact]
     public void TestGenerateTraceIdForRootNodeUsingActivitySourceWithTraceIdBasedSamplerOn()
     {
+#pragma warning disable CS0618 // Type or member is obsolete
         using (Sdk.CreateTracerProviderBuilder()
                    .AddXRayTraceIdWithSampler(new TraceIdRatioBasedSampler(1.0))
                    .AddSource("TestTraceIdBasedSamplerOn")
                    .SetSampler(new TraceIdRatioBasedSampler(1.0))
                    .Build())
+#pragma warning restore CS0618 // Type or member is obsolete
         {
             using (var activitySource = new ActivitySource("TestTraceIdBasedSamplerOn"))
             {
@@ -100,11 +107,13 @@ public void TestGenerateTraceIdForRootNodeUsingActivitySourceWithTraceIdBasedSam
     [Fact]
     public void TestGenerateTraceIdForRootNodeUsingActivitySourceWithTraceIdBasedSamplerOff()
     {
+#pragma warning disable CS0618 // Type or member is obsolete
         using (Sdk.CreateTracerProviderBuilder()
                    .AddXRayTraceIdWithSampler(new TraceIdRatioBasedSampler(0.0))
                    .AddSource("TestTraceIdBasedSamplerOff")
                    .SetSampler(new TraceIdRatioBasedSampler(0.0))
                    .Build())
+#pragma warning restore CS0618 // Type or member is obsolete
         {
             using (var activitySource = new ActivitySource("TestTraceIdBasedSamplerOff"))
             {