fix: only set sentry.trace.parent_span_id when Span was active

Author: Flash0ver

CHANGELOG.md

@@ -8,6 +8,7 @@
 
 ### Fixes
 
+- Parent-Span-IDs are no longer sent with Structured Logs when recorded without an active Span ([#4565](https://github.com/getsentry/sentry-dotnet/pull/4565))
 - Upload linked PDBs to fix non-IL-stripped symbolication for iOS ([#4527](https://github.com/getsentry/sentry-dotnet/pull/4527))
 - In MAUI Android apps, generate and inject UUID to APK and upload ProGuard mapping to Sentry with the UUID ([#4532](https://github.com/getsentry/sentry-dotnet/pull/4532))
 - Fixed WASM0001 warning when building Blazor WebAssembly projects ([#4519](https://github.com/getsentry/sentry-dotnet/pull/4519))

src/Sentry/SentryLog.cs

@@ -1,13 +1,19 @@
 using Sentry.Extensibility;
 using Sentry.Infrastructure;
+using Sentry.Internal;
 using Sentry.Protocol;
 
 namespace Sentry;
 
 /// <summary>
-/// Represents the Sentry Log protocol.
+/// Represents a Sentry Structured Log.
 /// <para>This API is experimental and it may change in the future.</para>
 /// </summary>
+/// <remarks>
+/// Sentry Docs: <see href="https://docs.sentry.io/product/explore/logs/"/>.
+/// Sentry Developer Documentation: <see href="https://develop.sentry.dev/sdk/telemetry/logs/"/>.
+/// Sentry .NET SDK Docs: <see href="https://docs.sentry.io/platforms/dotnet/logs/"/>.
+/// </remarks>
 [Experimental(DiagnosticId.ExperimentalFeature)]
 [DebuggerDisplay(@"SentryLog \{ Level = {Level}, Message = '{Message}' \}")]
 public sealed class SentryLog
@@ -260,23 +266,26 @@ internal void WriteTo(Utf8JsonWriter writer, IDiagnosticLogger? logger)
 
     internal static void GetTraceIdAndSpanId(IHub hub, out SentryId traceId, out SpanId? spanId)
     {
-        var span = hub.GetSpan();
-        if (span is not null)
+        var activeSpan = hub.GetSpan();
+        if (activeSpan is not null)
         {
-            traceId = span.TraceId;
-            spanId = span.SpanId;
+            traceId = activeSpan.TraceId;
+            spanId = activeSpan.SpanId;
             return;
         }
 
+        // set "sentry.trace.parent_span_id" to the ID of the Span that was active when the Log was collected
+        // do not set "sentry.trace.parent_span_id" if there was no active Span
+        spanId = null;
+
         var scope = hub.GetScope();
         if (scope is not null)
         {
             traceId = scope.PropagationContext.TraceId;
-            spanId = scope.PropagationContext.SpanId;
             return;
         }
 
+        Debug.Assert(hub is not Hub, "In case of a 'full' Hub, there is always a Scope. Otherwise (disabled) there is no Scope, but this branch should be unreachable.");
         traceId = SentryId.Empty;
-        spanId = null;
     }
 }

test/Sentry.Extensions.Logging.Tests/SentryStructuredLoggerTests.cs

@@ -140,7 +140,7 @@ public void Log_WithoutActiveSpan_CaptureLog()
 
         var log = _fixture.CapturedLogs.Dequeue();
         log.TraceId.Should().Be(scope.PropagationContext.TraceId);
-        log.ParentSpanId.Should().Be(scope.PropagationContext.SpanId);
+        log.ParentSpanId.Should().BeNull();
     }
 
     [Fact]

test/Sentry.Serilog.Tests/SentrySinkTests.Structured.cs

@@ -112,7 +112,7 @@ public void Emit_StructuredLogging_LogEvent(bool withActiveSpan)
         log.Parameters[1].Should().BeEquivalentTo(new KeyValuePair<string, string>("Sequence", "[41, 42, 43]"));
         log.Parameters[2].Should().BeEquivalentTo(new KeyValuePair<string, string>("Dictionary", """[("key": "value")]"""));
         log.Parameters[3].Should().BeEquivalentTo(new KeyValuePair<string, string>("Structure", """[42, "42"]"""));
-        log.ParentSpanId.Should().Be(withActiveSpan ? _fixture.Hub.GetSpan()!.SpanId : _fixture.Scope.PropagationContext.SpanId);
+        log.ParentSpanId.Should().Be(withActiveSpan ? _fixture.Hub.GetSpan()!.SpanId : null);
 
         log.TryGetAttribute("sentry.environment", out object? environment).Should().BeTrue();
         environment.Should().Be("test-environment");

test/Sentry.Tests/SentryLogTests.cs

@@ -384,7 +384,7 @@ public void WriteTo_Attributes_AsJson()
     }
 
     [Fact]
-    public void GetTraceIdAndSpanId_WithActiveSpan_ReturnAsOut()
+    public void GetTraceIdAndSpanId_WithActiveSpan_HasBothTraceIdAndSpanId()
     {
         // Arrange
         var span = Substitute.For<ISpan>();
@@ -403,7 +403,7 @@ public void GetTraceIdAndSpanId_WithActiveSpan_ReturnAsOut()
     }
 
     [Fact]
-    public void GetTraceIdAndSpanId_WithoutActiveSpan_ReturnAsOut()
+    public void GetTraceIdAndSpanId_WithoutActiveSpan_HasOnlyTraceIdButNoSpanId()
     {
         // Arrange
         var hub = Substitute.For<IHub>();
@@ -417,11 +417,11 @@ public void GetTraceIdAndSpanId_WithoutActiveSpan_ReturnAsOut()
 
         // Assert
         traceId.Should().Be(scope.PropagationContext.TraceId);
-        spanId.Should().Be(scope.PropagationContext.SpanId);
+        spanId.Should().BeNull();
     }
 
     [Fact]
-    public void GetTraceIdAndSpanId_WithoutIds_ReturnAsOut()
+    public void GetTraceIdAndSpanId_WithoutIds_ShouldBeUnreachable()
     {
         // Arrange
         var hub = Substitute.For<IHub>();

test/Sentry.Tests/SentryStructuredLoggerTests.cs

@@ -55,7 +55,7 @@ public void WithoutActiveSpan()
             var scope = new Scope();
             Hub.SubstituteConfigureScope(scope);
             TraceId = scope.PropagationContext.TraceId;
-            ParentSpanId = scope.PropagationContext.SpanId;
+            ParentSpanId = null;
         }
 
         public SentryStructuredLogger GetSut() => SentryStructuredLogger.Create(Hub, Options, Clock, BatchSize, BatchTimeout);