[.NET7.0] AspNetCore ActivitySource Migration

src/OpenTelemetry.Instrumentation.AspNetCore/AspNetCoreInstrumentation.cs

@@ -25,9 +25,33 @@ internal class AspNetCoreInstrumentation : IDisposable
     {
         private readonly DiagnosticSourceSubscriber diagnosticSourceSubscriber;
 
+        private readonly Func<string, object, object, bool> isEnabled = (activityName, obj1, obj2) =>
+        {
+            if (activityName.Equals("Microsoft.AspNetCore.Hosting.HttpRequestIn"))
+            {
+                return false;
+            }
+
+            return true;
+        };
+
         public AspNetCoreInstrumentation(HttpInListener httpInListener)
         {
-            this.diagnosticSourceSubscriber = new DiagnosticSourceSubscriber(httpInListener, null);
+            // For .NET7.0 activity will be created using activitySource.
+            // https://github.com/dotnet/aspnetcore/blob/main/src/Hosting/Hosting/src/Internal/HostingApplicationDiagnostics.cs#L327
+            // However, in case when activity creation returns null (due to sampling)
+            // the framework will fall back to creating activity anyways due to active diagnostic source listener
+            // To prevent this, isEnabled is implemented which will return false always
+            // so that the sampler's decision is respected.
+            if (HttpInListener.IsNet7OrGreater)
+            {
+                this.diagnosticSourceSubscriber = new DiagnosticSourceSubscriber(httpInListener, this.isEnabled);
+            }
+            else
+            {
+                this.diagnosticSourceSubscriber = new DiagnosticSourceSubscriber(httpInListener, null);
+            }
+
             this.diagnosticSourceSubscriber.Subscribe();
         }
 

src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInListener.cs

@@ -35,6 +35,10 @@ namespace OpenTelemetry.Instrumentation.AspNetCore.Implementation
     internal class HttpInListener : ListenerHandler
     {
         internal const string ActivityOperationName = "Microsoft.AspNetCore.Hosting.HttpRequestIn";
+        internal static readonly bool IsNet7OrGreater;
+
+        // https://github.com/dotnet/aspnetcore/blob/main/src/Hosting/Hosting/src/WebHostBuilder.cs#L291
+        internal static readonly string FrameworkActivitySourceName = "Microsoft.AspNetCore";
         internal static readonly AssemblyName AssemblyName = typeof(HttpInListener).Assembly.GetName();
         internal static readonly string ActivitySourceName = AssemblyName.Name;
         internal static readonly Version Version = AssemblyName.Version;
@@ -50,6 +54,18 @@ internal class HttpInListener : ListenerHandler
         private readonly PropertyFetcher<string> beforeActionTemplateFetcher = new("Template");
         private readonly AspNetCoreInstrumentationOptions options;
 
+        static HttpInListener()
+        {
+            try
+            {
+                IsNet7OrGreater = typeof(HttpRequest).Assembly.GetName().Version.Major >= 7;
+            }
+            catch (Exception)
+            {
+                IsNet7OrGreater = false;
+            }
+        }
+
         public HttpInListener(AspNetCoreInstrumentationOptions options)
             : base(DiagnosticSourceName)
         {
@@ -71,7 +87,7 @@ public override void OnStartActivity(Activity activity, object payload)
             // By this time, samplers have already run and
             // activity.IsAllDataRequested populated accordingly.
 
-            if (Sdk.SuppressInstrumentation)
+            if (Sdk.SuppressInstrumentation || (IsNet7OrGreater && string.IsNullOrEmpty(activity.Source.Name)))
             {
                 return;
             }
@@ -96,8 +112,15 @@ public override void OnStartActivity(Activity activity, object payload)
                     // Create a new activity with its parent set from the extracted context.
                     // This makes the new activity as a "sibling" of the activity created by
                     // Asp.Net Core.
+#if NET7_0_OR_GREATER
+                    // For NET7.0 onwards activity is created using ActivitySource so,
+                    // we will use the source of the activity to create the new one.
+                    Activity newOne;
+                    newOne = activity.Source.CreateActivity(ActivityOperationName, ActivityKind.Server, ctx.ActivityContext);
+#else
                     Activity newOne = new Activity(ActivityOperationName);
                     newOne.SetParentId(ctx.ActivityContext.TraceId, ctx.ActivityContext.SpanId, ctx.ActivityContext.TraceFlags);
+#endif
                     newOne.TraceStateString = ctx.ActivityContext.TraceState;
 
                     newOne.SetTag("IsCreatedByInstrumentation", bool.TrueString);
@@ -135,8 +158,11 @@ public override void OnStartActivity(Activity activity, object payload)
                     return;
                 }
 
-                ActivityInstrumentationHelper.SetActivitySourceProperty(activity, ActivitySource);
-                ActivityInstrumentationHelper.SetKindProperty(activity, ActivityKind.Server);
+                if (!IsNet7OrGreater)
+                {
+                    ActivityInstrumentationHelper.SetActivitySourceProperty(activity, ActivitySource);
+                    ActivityInstrumentationHelper.SetKindProperty(activity, ActivityKind.Server);
+                }
 
                 var path = (request.PathBase.HasValue || request.Path.HasValue) ? (request.PathBase + request.Path).ToString() : "/";
                 activity.DisplayName = path;
@@ -177,6 +203,11 @@ public override void OnStartActivity(Activity activity, object payload)
 
         public override void OnStopActivity(Activity activity, object payload)
         {
+            if (IsNet7OrGreater && string.IsNullOrEmpty(activity.Source.Name))
+            {
+                return;
+            }
+
             if (activity.IsAllDataRequested)
             {
                 _ = this.stopContextFetcher.TryFetch(payload, out HttpContext context);
@@ -244,6 +275,11 @@ public override void OnStopActivity(Activity activity, object payload)
 
         public override void OnCustom(string name, Activity activity, object payload)
         {
+            if (IsNet7OrGreater && string.IsNullOrEmpty(activity.Source.Name))
+            {
+                return;
+            }
+
             if (name == "Microsoft.AspNetCore.Mvc.BeforeAction")
             {
                 if (activity.IsAllDataRequested)
@@ -273,6 +309,11 @@ public override void OnCustom(string name, Activity activity, object payload)
 
         public override void OnException(Activity activity, object payload)
         {
+            if (IsNet7OrGreater && string.IsNullOrEmpty(activity.Source.Name))
+            {
+                return;
+            }
+
             if (activity.IsAllDataRequested)
             {
                 if (!this.stopExceptionFetcher.TryFetch(payload, out Exception exc) || exc == null)

src/OpenTelemetry.Instrumentation.AspNetCore/TracerProviderBuilderExtensions.cs

@@ -53,8 +53,16 @@ internal static TracerProviderBuilder AddAspNetCoreInstrumentation(
             this TracerProviderBuilder builder,
             AspNetCoreInstrumentation instrumentation)
         {
-            builder.AddSource(HttpInListener.ActivitySourceName);
-            builder.AddLegacySource(HttpInListener.ActivityOperationName); // for the activities created by AspNetCore
+            if (HttpInListener.IsNet7OrGreater)
+            {
+                builder.AddSource(HttpInListener.FrameworkActivitySourceName);
+            }
+            else
+            {
+                builder.AddSource(HttpInListener.ActivitySourceName);
+                builder.AddLegacySource(HttpInListener.ActivityOperationName); // for the activities created by AspNetCore
+            }
+
             return builder.AddInstrumentation(() => instrumentation);
         }
 

test/OpenTelemetry.Instrumentation.AspNetCore.Tests/BasicTests.cs

@@ -348,7 +348,7 @@ public async Task ExtractContextIrrespectiveOfSamplingDecision(SamplingDecision
                 var expectedTraceId = ActivityTraceId.CreateRandom();
                 var expectedParentSpanId = ActivitySpanId.CreateRandom();
                 var expectedTraceState = "rojo=1,congo=2";
-                var activityContext = new ActivityContext(expectedTraceId, expectedParentSpanId, ActivityTraceFlags.Recorded, expectedTraceState);
+                var activityContext = new ActivityContext(expectedTraceId, expectedParentSpanId, ActivityTraceFlags.Recorded, expectedTraceState, true);
                 var expectedBaggage = Baggage.SetBaggage("key1", "value1").SetBaggage("key2", "value2");
                 Sdk.SetDefaultTextMapPropagator(new ExtractOnlyPropagator(activityContext, expectedBaggage));
 
@@ -575,8 +575,13 @@ private static void WaitForActivityExport(List<Activity> exportedItems, int coun
         private static void ValidateAspNetCoreActivity(Activity activityToValidate, string expectedHttpPath)
         {
             Assert.Equal(ActivityKind.Server, activityToValidate.Kind);
+#if NET7_0_OR_GREATER
+            Assert.Equal(HttpInListener.FrameworkActivitySourceName, activityToValidate.Source.Name);
+            Assert.Empty(activityToValidate.Source.Version);
+#else
             Assert.Equal(HttpInListener.ActivitySourceName, activityToValidate.Source.Name);
             Assert.Equal(HttpInListener.Version.ToString(), activityToValidate.Source.Version);
+#endif
             Assert.Equal(expectedHttpPath, activityToValidate.GetTagValue(SemanticConventions.AttributeHttpTarget) as string);
         }