Added trace origin to distinguish Sentry traces from custom instrumented traces (#3400)

Author: jamescrosswell

Sentry.sln.DotSettings

@@ -1,4 +1,5 @@
 <wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=EF/@EntryIndexedValue">EF</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=IO/@EntryIndexedValue">IO</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=OS/@EntryIndexedValue">OS</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=QL/@EntryIndexedValue">QL</s:String>

src/Sentry.AspNet/HttpContextExtensions.cs

@@ -1,4 +1,5 @@
 using Sentry.Extensibility;
+using Sentry.Protocol;
 
 namespace Sentry.AspNet;
 
@@ -9,6 +10,7 @@ namespace Sentry.AspNet;
 public static class HttpContextExtensions
 {
     private const string HttpContextTransactionItemName = "__SentryTransaction";
+    internal const string AspNetOrigin = "auto.http.aspnet";
 
     private static SentryTraceHeader? TryGetSentryTraceHeader(HttpContext context, SentryOptions? options)
     {
@@ -114,6 +116,7 @@ public static ITransactionTracer StartSentryTransaction(this HttpContext httpCon
         }
 
         var transaction = SentrySdk.StartTransaction(transactionContext, customSamplingContext, dynamicSamplingContext);
+        transaction.Contexts.Trace.Origin = AspNetOrigin;
 
         SentrySdk.ConfigureScope(scope => scope.Transaction = transaction);
         httpContext.Items[HttpContextTransactionItemName] = transaction;

src/Sentry.AspNetCore/SentryTracingMiddleware.cs

@@ -12,6 +12,7 @@ namespace Sentry.AspNetCore;
 internal class SentryTracingMiddleware
 {
     private const string OperationName = "http.server";
+    internal const string AspNetCoreOrigin = "auto.http.aspnetcore";
 
     private readonly RequestDelegate _next;
     private readonly Func<IHub> _getHub;
@@ -78,6 +79,7 @@ public SentryTracingMiddleware(
             }
 
             var transaction = _getHub().StartTransaction(transactionContext, customSamplingContext, dynamicSamplingContext);
+            transaction.Contexts.Trace.Origin = AspNetCoreOrigin;
 
             _options.LogInfo(
                 "Started transaction with span ID '{0}' and trace ID '{1}'.",

src/Sentry.Azure.Functions.Worker/SentryFunctionsWorkerMiddleware.cs

@@ -8,6 +8,7 @@ namespace Sentry.Azure.Functions.Worker;
 internal class SentryFunctionsWorkerMiddleware : IFunctionsWorkerMiddleware
 {
     private const string Operation = "function";
+    internal const string AzureFunctionsOrigin = "auto.function.azure";
 
     private readonly IHub _hub;
     private readonly IDiagnosticLogger? _logger;
@@ -23,6 +24,7 @@ public async Task Invoke(FunctionContext context, FunctionExecutionDelegate next
     {
         var transactionContext = await StartOrContinueTraceAsync(context);
         var transaction = _hub.StartTransaction(transactionContext);
+        transaction.Contexts.Trace.Origin = AzureFunctionsOrigin;
         Exception? unhandledException = null;
 
         try
@@ -98,7 +100,7 @@ private async Task<TransactionContext> StartOrContinueTraceAsync(FunctionContext
         // Note that, when Trimming is enabled, we can't use reflection to read route data from the HttpTrigger
         // attribute. In that case the route name will always be /api/<FUNCTION_NAME>
         // If this is ever a problem for customers, we can potentially see if there are alternate ways to get this info
-        // from route tables or something. We're not even sure if anyone will use this functionality for now though. 
+        // from route tables or something. We're not even sure if anyone will use this functionality for now though.
         if (!AotHelper.IsNativeAot && !TransactionNameCache.TryGetValue(transactionNameKey, out transactionName))
         {
             // Find the HTTP Trigger attribute via reflection

src/Sentry.DiagnosticSource/Internal/DiagnosticSource/EFDiagnosticSourceHelper.cs

@@ -59,6 +59,7 @@ internal void AddSpan(object? diagnosticSourceValue)
         // 2. Sentry's performance errors functionality only works when all queries have the same parent span.
         var parent = Transaction.GetDbParentSpan();
         var child = parent.StartChild(Operation, GetDescription(diagnosticSourceValue));
+        child.SetOrigin(SentryEFCoreListener.EFCoreListenerOrigin);
 
         SetDbData(child, diagnosticSourceValue);
         SetSpanReference(child, diagnosticSourceValue);

src/Sentry.DiagnosticSource/Internal/DiagnosticSource/SentryEFCoreListener.cs

@@ -13,6 +13,8 @@ internal class SentryEFCoreListener : IObserver<KeyValuePair<string, object?>>
     internal const string EFCommandExecuted = "Microsoft.EntityFrameworkCore.Database.Command.CommandExecuted";
     internal const string EFCommandFailed = "Microsoft.EntityFrameworkCore.Database.Command.CommandError";
 
+    internal const string EFCoreListenerOrigin = "auto.db.ef_core_listener";
+
     /// <summary>
     /// Used for EF Core 2.X and 3.X.
     /// <seealso href="https://docs.microsoft.com/dotnet/api/microsoft.entityframeworkcore.diagnostics.coreeventid.querymodelcompiling?view=efcore-3.1"/>

src/Sentry.DiagnosticSource/Internal/DiagnosticSource/SentrySqlListener.cs

@@ -11,6 +11,8 @@ private enum SentrySqlSpanType
         Execution
     };
 
+    internal const string SqlListenerOrigin = "auto.db.sql_listener";
+
     internal const string SqlDataWriteConnectionOpenBeforeCommand = "System.Data.SqlClient.WriteConnectionOpenBefore";
     internal const string SqlMicrosoftWriteConnectionOpenBeforeCommand = "Microsoft.Data.SqlClient.WriteConnectionOpenBefore";
 
@@ -80,6 +82,7 @@ private void AddSpan(string operation, object? value)
 
         var parent = transaction.GetDbParentSpan();
         var span = parent.StartChild(operation);
+        span.SetOrigin(SqlListenerOrigin);
         span.SetExtra(OTelKeys.DbSystem, "sql");
         SetOperationId(span, value?.GetGuidProperty("OperationId", _options.DiagnosticLogger));
         SetConnectionId(span, value?.GetGuidProperty("ConnectionId", _options.DiagnosticLogger));

src/Sentry.EntityFramework/SentryQueryPerformanceListener.cs

@@ -1,3 +1,5 @@
+using Sentry.Internal;
+
 namespace Sentry.EntityFramework;
 
 internal class SentryQueryPerformanceListener : IDbCommandInterceptor
@@ -7,6 +9,8 @@ internal class SentryQueryPerformanceListener : IDbCommandInterceptor
     internal const string DbNonQueryKey = "db.execute";
     internal const string DbScalarKey = "db.query.scalar";
 
+    internal static readonly string EntityFrameworkOrigin = "auto.db.entity_framework";
+
     private SentryOptions _options;
     private IHub _hub;
 
@@ -39,6 +43,7 @@ private void CreateSpan<T>(string key, string? command,
     {
         if (_hub.GetSpan()?.StartChild(key, command) is { } span)
         {
+            span.SetOrigin(EntityFrameworkOrigin);
             interceptionContext.AttachSpan(span);
         }
     }

src/Sentry.OpenTelemetry/SentrySpanProcessor.cs

@@ -13,6 +13,7 @@ public class SentrySpanProcessor : BaseProcessor<Activity>
 {
     private readonly IHub _hub;
     internal readonly IEnumerable<IOpenTelemetryEnricher> _enrichers;
+    internal const string OpenTelemetryOrigin = "auto.otel";
 
     // ReSharper disable once MemberCanBePrivate.Global - Used by tests
     internal readonly ConcurrentDictionary<ActivitySpanId, ISpan> _map = new();
@@ -123,6 +124,7 @@ private void CreateChildSpan(Activity data, ISpan parentSpan, SpanId? parentSpan
         };
 
         var span = (SpanTracer)parentSpan.StartChild(context);
+        span.Origin = OpenTelemetryOrigin;
         span.StartTimestamp = data.StartTimeUtc;
         // Used to filter out spans that are not recorded when finishing a transaction.
         span.SetFused(data);
@@ -152,6 +154,7 @@ private void CreateRootSpan(Activity data)
         var transaction = (TransactionTracer)_hub.StartTransaction(
             transactionContext, new Dictionary<string, object?>(), dynamicSamplingContext
         );
+        transaction.Contexts.Trace.Origin = OpenTelemetryOrigin;
         transaction.StartTimestamp = data.StartTimeUtc;
         _hub.ConfigureScope(scope => scope.Transaction = transaction);
         transaction.SetFused(data);

src/Sentry/IBaseTracer.cs

@@ -1,6 +1,6 @@
 namespace Sentry;
 
-internal interface IBaseTracer
+internal interface IBaseTracer : ITraceContextInternal
 {
     internal bool IsOtelInstrumenter { get; }
 }