Update from 5.10 to 5.11.1 "cannot be empty (Parameter 'traceId')"

[snailcatcher]

Package

Sentry.AspNetCore

.NET Flavor

.NET

.NET Version

9.0.300

OS

Linux

OS Version

latest dotnet container build

Development Environment

Rider 2024 (MacOS)

SDK Version

5.11.1

Self-Hosted Sentry Version

No response

Workload Versions

Installierte Workload-ID Manifestversion Installationsquelle

Verwenden Sie „dotnet workload search“, um zusätzliche zu installierende Workloads zu finden.

UseSentry or SentrySdk.Init call

builder.WebHost.UseSentry();

appsettings.json

"Sentry": {
    "Dsn": null,
    "IncludeRequestPayload": true,
    "IncludeActivityData": true,
    "MinimumBreadcrumbLevel": "Debug",
    "MinimumEventLevel": "Error",
    "AttachStackTrace": true,
    "MaxBreadcrumbs": 50
  },

Steps to Reproduce

Update from 5.10 to 5.11.1

Expected Result

everything should work as it worked before

Actual Result

fail: Microsoft.AspNetCore.Server.Kestrel[13]                                                                                                                                                                   │
│       Connection id "0HNDI53VNL6PT", Request id "0HNDI53VNL6PT:0000000E": An unhandled exception was thrown by the application.                                                                                 │
│       System.ArgumentOutOfRangeException: cannot be empty (Parameter 'traceId')                                                                                                                                 │
│          at Sentry.DynamicSamplingContext..ctor(SentryId traceId, String publicKey, Nullable`1 sampled, Nullable`1 sampleRate, Nullable`1 sampleRand, String release, String environment, String transactionNam │
│          at Sentry.DynamicSamplingContext.CreateFromPropagationContext(SentryPropagationContext propagationContext, SentryOptions options, IReplaySession replaySession)                                        │
│          at Sentry.SentryMessageHandler.AddBaggageHeader(HttpRequestMessage request)                                                                                                                            │
│          at Sentry.SentryMessageHandler.PropagateTraceHeaders(HttpRequestMessage request, String url, ISpan parentSpan)                                                                                         │
│          at Sentry.SentryMessageHandler.SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)                                                                                              │
│          at Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler.<SendCoreAsync>g__Core|4_0(HttpRequestMessage request, Boolean useAsync, CancellationToken cancellationToken)                      │
│          at System.Net.Http.HttpClient.<SendAsync>g__Core|83_0(HttpRequestMessage request, HttpCompletionOption completionOption, CancellationTokenSource cts, Boolean disposeCts, CancellationTokenSource pend │
│          at Refit.RequestBuilderImplementation.<>c__DisplayClass15_0`2.<<BuildCancellableTaskFuncForMethod>b__0>d.MoveNext() in c:\temp\releaser\refit\Refit\RequestBuilderImplementation.cs:line 331           │
│       --- End of stack trace from previous location ---                                                                                                                                                         │
│          at Refit.Implementation.Generated.XXX.global::XXX.ScanStreamAsync(MultipartItem stream, Cance │
│         ...                                           │
│       --- End of stack trace from previous location ---                                                                                                                                                         │
│          at XXX.ApplicationBuilderExtensions.<>c.<<UseTelemetryService>b__0_0>d.MoveNext() in /home/vsts/work/1/s/services/XXX/ │
│       --- End of stack trace from previous location ---                                                                                                                                                         │
│          at Microsoft.AspNetCore.Authorization.AuthorizationMiddleware.Invoke(HttpContext context)                                                                                                              │
│          at Sentry.AspNetCore.SentryTracingMiddleware.InvokeAsync(HttpContext context)                                                                                                                          │
│          at Sentry.AspNetCore.SentryTracingMiddleware.InvokeAsync(HttpContext context)                                                                                                                          │
│          at Sentry.AspNetCore.SentryTracingMiddleware.InvokeAsync(HttpContext context)                                                                                                                          │
│          at Microsoft.AspNetCore.Authentication.AuthenticationMiddleware.Invoke(HttpContext context)                                                                                                            │
│          at Sentry.AspNetCore.SentryMiddleware.InvokeAsync(HttpContext context, RequestDelegate next)                                                                                                           │
│          at Sentry.AspNetCore.SentryMiddleware.InvokeAsync(HttpContext context, RequestDelegate next)                                                                                                           │
│          at Microsoft.AspNetCore.Builder.UseMiddlewareExtensions.InterfaceMiddlewareBinder.<>c__DisplayClass2_0.<<CreateMiddleware>b__0>d.MoveNext()                                                            │
│       --- End of stack trace from previous location ---                                                                                                                                                         │
│          at Microsoft.AspNetCore.Server.Kestrel.Core.Internal.Http.HttpProtocol.ProcessRequests[TContext](IHttpApplication`1 application)

[bruno-garcia]

oh. do you have a repro by any chance? the sdk debug logs could help too

the related change in this version is:

The HTTP instrumentation uses the span created for the outgoing request in the sentry-trace header, fixing the parent-child relationship between client and server (#4264)

and it falls back to the original behavior so not sure how it fails.

Are you setting scope.Span?
do you use OTel SDK too?

[snailcatcher]

Hi @bruno-garcia
Just the project itself (which contains multiple microservices), so not really something I can provide as a repro.

Yes we use OTEL SDK (Version 1.12.0) for metrics and traces (and therefore I think this will include spans).

[bruno-garcia]

It's erroring out here:

sentry-dotnet/src/Sentry/DynamicSamplingContext.cs

Line 36 in 01c6b86

throw new ArgumentOutOfRangeException(nameof(traceId), "cannot be empty");

After having passed through:

sentry-dotnet/src/Sentry/SentryMessageHandler.cs

Lines 154 to 183 in 01c6b86

	private void AddBaggageHeader(HttpRequestMessage request)
	{
	var baggage = _hub.GetBaggage();
	if (baggage is null)
	{
	return;
	}
	if (request.Headers.TryGetValues(BaggageHeader.HttpHeaderName, out var baggageHeaders))
	{
	var headers = baggageHeaders.ToList();
	if (headers.Any(h => h.StartsWith(BaggageHeader.SentryKeyPrefix)))
	{
	// The Sentry headers have already been added to this request. Do nothing.
	return;
	}
	// Merge existing baggage headers with ours.
	var allBaggage = headers
	.Select(s => BaggageHeader.TryParse(s)).ExceptNulls()
	.Append(baggage);
	baggage = BaggageHeader.Merge(allBaggage);
	// Remove the existing header so we can replace it with the merged one.
	request.Headers.Remove(BaggageHeader.HttpHeaderName);
	}
	// Set the baggage header
	request.Headers.Add(BaggageHeader.HttpHeaderName, baggage.ToString());
	}

Which I don't see any references to DynamicSamplingContext. There's no implicit operator.

What my change did on 5.11.0 is:

sentry-dotnet/src/Sentry/SentryMessageHandler.cs

Line 148 in 01c6b86

(parentSpan?.GetTraceHeader() ?? _hub.GetTraceHeader()) is { } traceHeader)

So it should use the parent span trace header if there's one, otherwise fallback to the original behavior.
Not sure what's going on. @jamescrosswell any thoughts?