Merge branch 'main' into update-sample-tfms

Flash0ver · Flash0ver · commit 9148ca9b7715 · 2025-12-04T13:07:36.000+01:00
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -48,7 +48,7 @@ body:
     attributes:
       label: .NET Version
       description: If using .NET Core, please copy the output of 'dotnet --version' here
-      placeholder: 9.0.200 ← should look like this
+      placeholder: 10.0.100 ← should look like this
     validations:
       required: true
 
@@ -81,11 +81,13 @@ body:
       label: Development Environment
       description: What development environment are you using
       options:
-        - Visual Studio v17.x
+        - Visual Studio v18.x
         - Visual Studio Code (Windows)
-        - Visual Studio Code (MacOS)
-        - Rider 2024 (Windows)
-        - Rider 2024 (MacOS)
+        - Visual Studio Code (macOS)
+        - Visual Studio Code (Linux)
+        - Rider 2025.x (Windows)
+        - Rider 2025.x (macOS)
+        - Rider 2025.x (Linux)
         - Other
     validations:
       required: true
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -265,8 +265,10 @@ jobs:
           path: src
 
       - name: Integration test
-#       # Note that when upgsading .NET versions, linux-musl may need special handling... see comments below
+#       # Note that when upgrading .NET versions, linux-musl may need special handling... see comments below
 #        if: ${{ (matrix.rid != 'linux-musl-x64') && (matrix.rid != 'linux-musl-arm64') }}
+        # TODO: Re-enable once we have resolved https://github.com/getsentry/sentry-dotnet/issues/4788
+        if: ${{ (matrix.rid != 'linux-musl-x64') }}
         uses: getsentry/github-workflows/sentry-cli/integration-test/@a5e409bd5bad4c295201cdcfe862b17c50b29ab7 # v2.14.1
         with:
           path: integration-test
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -35,7 +35,7 @@ jobs:
         uses: ./.github/actions/environment
 
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@e12f0178983d466f2f6028f5cc7a6d786fd97f4b # v4.31.4
+        uses: github/codeql-action/init@fdbfb4d2750291e159f0156def62b853c2798ca2 # v4.31.5
         with:
           languages: csharp
 
@@ -49,6 +49,6 @@ jobs:
         run: dotnet build Sentry-CI-CodeQL.slnf --no-restore --nologo
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@e12f0178983d466f2f6028f5cc7a6d786fd97f4b # v4.31.4
+        uses: github/codeql-action/analyze@fdbfb4d2750291e159f0156def62b853c2798ca2 # v4.31.5
         with:
           category: '/language:csharp'
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,7 @@
 
 - Remove `SentryLoggingOptions.ExperimentalLogging.MinimumLogLevel`. _Structured Logs_ can now be configured via the `"Sentry"` logging provider (e.g. in `appsettings.json` and `appsettings.{HostEnvironment}.json`) ([#4700](https://github.com/getsentry/sentry-dotnet/pull/4700))
 - All logging provider types are _internal_ now in order to ensure configuration as intended ([#4700](https://github.com/getsentry/sentry-dotnet/pull/4700))
+- Rename `SentryLog.ParentSpanId` to `SentryLog.SpanId` reflecting the protocol change ([#4778](https://github.com/getsentry/sentry-dotnet/pull/4778))
 
 ### Features
 
diff --git a/samples/Sentry.Samples.Console.Basic/Program.cs b/samples/Sentry.Samples.Console.Basic/Program.cs
@@ -91,10 +91,12 @@ async Task SecondFunction()
     {
         // This is an example of capturing a handled exception.
         SentrySdk.CaptureException(exception);
-        span.Finish(exception);
 
+        // This is an example of capturing a structured log.
         SentrySdk.Logger.LogError(static log => log.SetAttribute("method", nameof(SecondFunction)),
             "Error with message: {0}", exception.Message);
+
+        span.Finish(exception);
     }
     finally
     {
@@ -112,9 +114,10 @@ async Task ThirdFunction()
     // Simulate doing some work
     await Task.Delay(100);
 
+    // This is an example of a structured log that is filtered via the 'SetBeforeSendLog' delegate above.
     SentrySdk.Logger.LogFatal(static log => log.SetAttribute("suppress", true),
         "Crash imminent!");
 
-    // This is an example of an unhandled exception.  It will be captured automatically.
+    // This is an example of an unhandled exception. It will be captured automatically.
     throw new InvalidOperationException("Something happened that crashed the app!");
 }
diff --git a/samples/Sentry.Samples.OpenTelemetry.AzureFunctions/Program.cs b/samples/Sentry.Samples.OpenTelemetry.AzureFunctions/Program.cs
@@ -1,16 +1,20 @@
+using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
-using OpenTelemetry;
 using OpenTelemetry.Trace;
 using Sentry.OpenTelemetry;
 
-using var tracerProvider = Sdk.CreateTracerProviderBuilder()
-    .AddSentry() // <-- Configure OpenTelemetry to send traces to Sentry
-    .AddHttpClientInstrumentation() // From OpenTelemetry.Instrumentation.Http... adds automatic tracing for outgoing HTTP requests
-    .Build();
-
 var host = new HostBuilder()
     .ConfigureFunctionsWorkerDefaults()
+    .ConfigureServices(services =>
+    {
+        services.AddOpenTelemetry().WithTracing(builder =>
+        {
+            builder
+                .AddSentry() // <-- Configure OpenTelemetry to send traces to Sentry
+                .AddHttpClientInstrumentation(); // From OpenTelemetry.Instrumentation.Http... adds automatic tracing for outgoing HTTP requests
+        });
+    })
     .ConfigureLogging(logging =>
     {
         logging.AddSentry(options =>
diff --git a/samples/Sentry.Samples.OpenTelemetry.AzureFunctions/Sentry.Samples.OpenTelemetry.AzureFunctions.csproj b/samples/Sentry.Samples.OpenTelemetry.AzureFunctions/Sentry.Samples.OpenTelemetry.AzureFunctions.csproj
@@ -10,8 +10,9 @@
         <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Http" Version="3.3.0" />
         <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Timer" Version="4.3.1" />
         <PackageReference Include="Microsoft.Azure.Functions.Worker.Sdk" Version="2.0.7" />
-        <PackageReference Include="OpenTelemetry" Version="1.13.0" />
-        <PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.13.0" />
+        <PackageReference Include="OpenTelemetry" Version="1.14.0" />
+        <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.14.0" />
+        <PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.14.0" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/src/Sentry.Extensions.Logging/SentryStructuredLogger.cs b/src/Sentry.Extensions.Logging/SentryStructuredLogger.cs
@@ -84,7 +84,7 @@ public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Except
         {
             Template = template,
             Parameters = parameters.DrainToImmutable(),
-            ParentSpanId = spanId,
+            SpanId = spanId,
         };
 
         log.SetDefaultAttributes(_options, _sdk);
diff --git a/src/Sentry.Serilog/SentrySink.Structured.cs b/src/Sentry.Serilog/SentrySink.Structured.cs
@@ -14,7 +14,7 @@ private static void CaptureStructuredLog(IHub hub, SentryOptions options, LogEve
         {
             Template = template,
             Parameters = parameters,
-            ParentSpanId = spanId,
+            SpanId = spanId,
         };
 
         log.SetDefaultAttributes(options, Sdk);
diff --git a/src/Sentry/Internal/DefaultSentryStructuredLogger.cs b/src/Sentry/Internal/DefaultSentryStructuredLogger.cs
@@ -55,7 +55,7 @@ private protected override void CaptureLog(SentryLogLevel level, string template
         {
             Template = template,
             Parameters = @params,
-            ParentSpanId = spanId,
+            SpanId = spanId,
         };
 
         try
diff --git a/src/Sentry/SentryLog.cs b/src/Sentry/SentryLog.cs
@@ -64,7 +64,7 @@ internal SentryLog(DateTimeOffset timestamp, SentryId traceId, SentryLogLevel le
     /// <summary>
     /// The span id of the span that was active when the log was collected.
     /// </summary>
-    public SpanId? ParentSpanId { get; init; }
+    public SpanId? SpanId { get; init; }
 
     /// <summary>
     /// Gets the attribute value associated with the specified key.
@@ -207,6 +207,12 @@ internal void WriteTo(Utf8JsonWriter writer, IDiagnosticLogger? logger)
         writer.WritePropertyName("trace_id");
         TraceId.WriteTo(writer, logger);
 
+        if (SpanId.HasValue)
+        {
+            writer.WritePropertyName("span_id");
+            SpanId.Value.WriteTo(writer, logger);
+        }
+
         if (severityNumber.HasValue)
         {
             writer.WriteNumber("severity_number", severityNumber.Value);
@@ -235,16 +241,6 @@ internal void WriteTo(Utf8JsonWriter writer, IDiagnosticLogger? logger)
             SentryAttributeSerializer.WriteAttribute(writer, attribute.Key, attribute.Value, logger);
         }
 
-        if (ParentSpanId.HasValue)
-        {
-            writer.WritePropertyName("sentry.trace.parent_span_id");
-            writer.WriteStartObject();
-            writer.WritePropertyName("value");
-            ParentSpanId.Value.WriteTo(writer, logger);
-            writer.WriteString("type", "string");
-            writer.WriteEndObject();
-        }
-
         writer.WriteEndObject(); // attributes
 
         writer.WriteEndObject();
@@ -260,8 +256,8 @@ internal static void GetTraceIdAndSpanId(IHub hub, out SentryId traceId, out Spa
             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
+        // set "span_id" to the ID of the Span that was active when the Log was collected
+        // do not set "span_id" if there was no active Span
         spanId = null;
 
         var scope = hub.GetScope();
diff --git a/test/Sentry.Extensions.Logging.Tests/SentryStructuredLoggerTests.cs b/test/Sentry.Extensions.Logging.Tests/SentryStructuredLoggerTests.cs
@@ -49,11 +49,11 @@ public Fixture()
         public void EnableHub(bool isEnabled) => Hub.IsEnabled.Returns(isEnabled);
         public void EnableLogs(bool isEnabled) => Options.Value.EnableLogs = isEnabled;
 
-        public void WithActiveSpan(SentryId traceId, SpanId parentSpanId)
+        public void WithActiveSpan(SentryId traceId, SpanId spanId)
         {
             var span = Substitute.For<ISpan>();
             span.TraceId.Returns(traceId);
-            span.SpanId.Returns(parentSpanId);
+            span.SpanId.Returns(spanId);
             Hub.GetSpan().Returns(span);
         }
 
@@ -82,8 +82,8 @@ public void Dispose()
     public void Log_LogLevel_CaptureLog(LogLevel logLevel, SentryLogLevel expectedLevel)
     {
         var traceId = SentryId.Create();
-        var parentSpanId = SpanId.Create();
-        _fixture.WithActiveSpan(traceId, parentSpanId);
+        var spanId = SpanId.Create();
+        _fixture.WithActiveSpan(traceId, spanId);
         var logger = _fixture.GetSut();
 
         EventId eventId = new(123, "EventName");
@@ -106,7 +106,7 @@ public void Log_LogLevel_CaptureLog(LogLevel logLevel, SentryLogLevel expectedLe
         log.Message.Should().Be("Message with argument.");
         log.Template.Should().Be(message);
         log.Parameters.Should().BeEquivalentTo(new KeyValuePair<string, object>[] { new("Argument", "argument") });
-        log.ParentSpanId.Should().Be(parentSpanId);
+        log.SpanId.Should().Be(spanId);
         log.AssertAttribute("sentry.environment", "my-environment");
         log.AssertAttribute("sentry.release", "my-release");
         log.AssertAttribute("sentry.origin", "auto.log.extensions_logging");
@@ -139,7 +139,7 @@ public void Log_WithoutActiveSpan_CaptureLog()
 
         var log = _fixture.CapturedLogs.Dequeue();
         log.TraceId.Should().Be(scope.PropagationContext.TraceId);
-        log.ParentSpanId.Should().BeNull();
+        log.SpanId.Should().BeNull();
     }
 
     [Fact]
diff --git a/test/Sentry.Serilog.Tests/SentrySinkTests.Structured.cs b/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 : null);
+        log.SpanId.Should().Be(withActiveSpan ? _fixture.Hub.GetSpan()!.SpanId : null);
 
         log.TryGetAttribute("sentry.environment", out object? environment).Should().BeTrue();
         environment.Should().Be("test-environment");
diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.DotNet10_0.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.DotNet10_0.verified.txt
@@ -625,7 +625,7 @@ namespace Sentry
         [System.Runtime.CompilerServices.RequiredMember]
         public string Message { get; init; }
         public System.Collections.Immutable.ImmutableArray<System.Collections.Generic.KeyValuePair<string, object>> Parameters { get; init; }
-        public Sentry.SpanId? ParentSpanId { get; init; }
+        public Sentry.SpanId? SpanId { get; init; }
         public string? Template { get; init; }
         [System.Runtime.CompilerServices.RequiredMember]
         public System.DateTimeOffset Timestamp { get; init; }
diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.DotNet8_0.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.DotNet8_0.verified.txt
@@ -625,7 +625,7 @@ namespace Sentry
         [System.Runtime.CompilerServices.RequiredMember]
         public string Message { get; init; }
         public System.Collections.Immutable.ImmutableArray<System.Collections.Generic.KeyValuePair<string, object>> Parameters { get; init; }
-        public Sentry.SpanId? ParentSpanId { get; init; }
+        public Sentry.SpanId? SpanId { get; init; }
         public string? Template { get; init; }
         [System.Runtime.CompilerServices.RequiredMember]
         public System.DateTimeOffset Timestamp { get; init; }
diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.DotNet9_0.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.DotNet9_0.verified.txt
@@ -625,7 +625,7 @@ namespace Sentry
         [System.Runtime.CompilerServices.RequiredMember]
         public string Message { get; init; }
         public System.Collections.Immutable.ImmutableArray<System.Collections.Generic.KeyValuePair<string, object>> Parameters { get; init; }
-        public Sentry.SpanId? ParentSpanId { get; init; }
+        public Sentry.SpanId? SpanId { get; init; }
         public string? Template { get; init; }
         [System.Runtime.CompilerServices.RequiredMember]
         public System.DateTimeOffset Timestamp { get; init; }
diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.Net4_8.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.Net4_8.verified.txt
@@ -610,7 +610,7 @@ namespace Sentry
         public Sentry.SentryLogLevel Level { get; init; }
         public string Message { get; init; }
         public System.Collections.Immutable.ImmutableArray<System.Collections.Generic.KeyValuePair<string, object>> Parameters { get; init; }
-        public Sentry.SpanId? ParentSpanId { get; init; }
+        public Sentry.SpanId? SpanId { get; init; }
         public string? Template { get; init; }
         public System.DateTimeOffset Timestamp { get; init; }
         public Sentry.SentryId TraceId { get; init; }
diff --git a/test/Sentry.Tests/SentryLogTests.cs b/test/Sentry.Tests/SentryLogTests.cs
@@ -11,7 +11,7 @@ public class SentryLogTests
 {
     private static readonly DateTimeOffset Timestamp = new(2025, 04, 22, 14, 51, 00, 789, TimeSpan.FromHours(2));
     private static readonly SentryId TraceId = SentryId.Create();
-    private static readonly SpanId? ParentSpanId = SpanId.Create();
+    private static readonly SpanId? SpanId = Sentry.SpanId.Create();
 
     private static readonly ISystemClock Clock = new MockClock(Timestamp);
 
@@ -40,7 +40,7 @@ public void Protocol_Default_VerifyAttributes()
         {
             Template = "template",
             Parameters = ImmutableArray.Create(new KeyValuePair<string, object>("param", "params")),
-            ParentSpanId = ParentSpanId,
+            SpanId = SpanId,
         };
         log.SetAttribute("attribute", "value");
         log.SetDefaultAttributes(options, sdk);
@@ -51,7 +51,7 @@ public void Protocol_Default_VerifyAttributes()
         log.Message.Should().Be("message");
         log.Template.Should().Be("template");
         log.Parameters.Should().BeEquivalentTo(new KeyValuePair<string, object>[] { new("param", "params"), });
-        log.ParentSpanId.Should().Be(ParentSpanId);
+        log.SpanId.Should().Be(SpanId);
 
         // should only show up in sdk integrations
         log.TryGetAttribute("sentry.origin", out object origin).Should().BeFalse();
@@ -83,7 +83,7 @@ public void WriteTo_NoParameters_NoTemplate(bool hasParameters)
         {
             Template = "template",
             Parameters = parameters,
-            ParentSpanId = ParentSpanId,
+            SpanId = SpanId,
         };
 
         // Act
@@ -176,7 +176,7 @@ public void WriteTo_EnvelopeItem_MaximalSerializedSentryLog()
         {
             Template = "template",
             Parameters = ImmutableArray.Create(new KeyValuePair<string, object>("0", "string"), new KeyValuePair<string, object>("1", false), new KeyValuePair<string, object>("2", 1), new KeyValuePair<string, object>("3", 2.2)),
-            ParentSpanId = ParentSpanId,
+            SpanId = SpanId,
         };
         log.SetAttribute("string-attribute", "string-value");
         log.SetAttribute("boolean-attribute", true);
@@ -212,6 +212,7 @@ public void WriteTo_EnvelopeItem_MaximalSerializedSentryLog()
               "level": "fatal",
               "body": "message",
               "trace_id": "{{TraceId.ToString()}}",
+              "span_id": "{{SpanId.ToString()}}",
               "severity_number": 24,
               "attributes": {
                 "sentry.message.template": {
@@ -265,10 +266,6 @@ public void WriteTo_EnvelopeItem_MaximalSerializedSentryLog()
                 "sentry.sdk.version": {
                   "value": "1.2.3-test+Sentry",
                   "type": "string"
-                },
-                "sentry.trace.parent_span_id": {
-                  "value": "{{ParentSpanId.ToString()}}",
-                  "type": "string"
                 }
               }
             }
@@ -416,7 +413,7 @@ public void GetTraceIdAndSpanId_WithActiveSpan_HasBothTraceIdAndSpanId()
         // Arrange
         var span = Substitute.For<ISpan>();
         span.TraceId.Returns(SentryId.Create());
-        span.SpanId.Returns(SpanId.Create());
+        span.SpanId.Returns(Sentry.SpanId.Create());
 
         var hub = Substitute.For<IHub>();
         hub.GetSpan().Returns(span);
diff --git a/test/Sentry.Tests/SentryStructuredLoggerTests.cs b/test/Sentry.Tests/SentryStructuredLoggerTests.cs

Original file line number	Diff line number	Diff line change
`@@ -91,10 +91,12 @@ async Task SecondFunction()`
`91`	`91`	`{`
`92`	`92`	`// This is an example of capturing a handled exception.`
`93`	`93`	`SentrySdk.CaptureException(exception);`
`94`		`- span.Finish(exception);`
`95`	`94`
	`95`	`+ // This is an example of capturing a structured log.`
`96`	`96`	`SentrySdk.Logger.LogError(static log => log.SetAttribute("method", nameof(SecondFunction)),`
`97`	`97`	`"Error with message: {0}", exception.Message);`
	`98`	`+`
	`99`	`+ span.Finish(exception);`
`98`	`100`	`}`
`99`	`101`	`finally`
`100`	`102`	`{`
`@@ -112,9 +114,10 @@ async Task ThirdFunction()`
`112`	`114`	`// Simulate doing some work`
`113`	`115`	`await Task.Delay(100);`
`114`	`116`
	`117`	`+ // This is an example of a structured log that is filtered via the 'SetBeforeSendLog' delegate above.`
`115`	`118`	`SentrySdk.Logger.LogFatal(static log => log.SetAttribute("suppress", true),`
`116`	`119`	`"Crash imminent!");`
`117`	`120`
`118`		`- // This is an example of an unhandled exception. It will be captured automatically.`
	`121`	`+ // This is an example of an unhandled exception. It will be captured automatically.`
`119`	`122`	`throw new InvalidOperationException("Something happened that crashed the app!");`
`120`	`123`	`}`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Except`
`84`	`84`	`{`
`85`	`85`	`Template = template,`
`86`	`86`	`Parameters = parameters.DrainToImmutable(),`
`87`		`- ParentSpanId = spanId,`
	`87`	`+ SpanId = spanId,`
`88`	`88`	`};`
`89`	`89`
`90`	`90`	`log.SetDefaultAttributes(_options, _sdk);`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ private static void CaptureStructuredLog(IHub hub, SentryOptions options, LogEve`
`14`	`14`	`{`
`15`	`15`	`Template = template,`
`16`	`16`	`Parameters = parameters,`
`17`		`- ParentSpanId = spanId,`
	`17`	`+ SpanId = spanId,`
`18`	`18`	`};`
`19`	`19`
`20`	`20`	`log.SetDefaultAttributes(options, Sdk);`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ private protected override void CaptureLog(SentryLogLevel level, string template`
`55`	`55`	`{`
`56`	`56`	`Template = template,`
`57`	`57`	`Parameters = @params,`
`58`		`- ParentSpanId = spanId,`
	`58`	`+ SpanId = spanId,`
`59`	`59`	`};`
`60`	`60`
`61`	`61`	`try`