[BUG] ArgumentNullException when calling CreateIfNotExistsAsync with OpenTelemetry populating a tag with the response message

[saasen]

Library name and version

Azure.Data.Tables v12.8.0

Describe the bug

After adding OpenTelemetry to our app, we are getting the following exception and stack trace when calling CreateIfNotExistsAsync:

System.ArgumentNullException: Value cannot be null. (Parameter 'value')

Stack trace:

System.ArgumentNullException:
   at Azure.Data.Tables.Models.TableErrorCode..ctor (Azure.Data.Tables, Version=12.8.0.0, Culture=neutral, PublicKeyToken=92742159e12e44c8)
   at Azure.Data.Tables.Models.TableErrorCode.op_Implicit (Azure.Data.Tables, Version=12.8.0.0, Culture=neutral, PublicKeyToken=92742159e12e44c8)
   at Azure.Data.Tables.TableClient+<CreateIfNotExistsAsync>d__39.MoveNext (Azure.Data.Tables, Version=12.8.0.0, Culture=neutral, PublicKeyToken=92742159e12e44c8)
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw (System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e)
   at System.Runtime.CompilerServices.TaskAwaiter.ThrowForNonSuccess (System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e)
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification (System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e)
   <client code omitted>

We have the following OpenTelemetry setup in Program.cs:

builder.Services.AddOpenTelemetry()
       .UseAzureMonitor()
       .WithTracing(traceBuilder =>
           traceBuilder
               .AddHttpClientInstrumentation(c =>
                {
                    c.EnrichWithHttpResponseMessage = (ac, res) =>
                    {
                        var statusCode = (int)res.StatusCode;
                        if (statusCode is >= (int)HttpStatusCode.BadRequest and < (int)HttpStatusCode.InternalServerError)
                        {
                            var body = res.Content.ReadAsStringAsync().Result;
                            if (!string.IsNullOrWhiteSpace(body))
                            {
                                ac.SetTag("http.response.body", body);
                            }
                        }
                    };
                })
               .AddAspNetCoreInstrumentation(config =>
               {
                   config.Filter = httpContext =>
                   {
                       var unwantedSegments = new[] { "/v1/healthchecks", "/metrics" };
                       foreach (var unwantedSegment in unwantedSegments)
                       {
                           if (httpContext.Request.Path.Value.StartsWith(unwantedSegment))
                           {
                               return false;
                           }
                       }

                       return true;
                   };
               })
       );

Versions:

Azure.Data.Tables v12.8.0
OpenTelemetry.Extensions.Hosting v1.6.0
OpenTelemetry.Instrumentation.AspNetCore v1.6.0-beta.3
OpenTelemetry.Instrumentation.Http v1.6.0-beta.3
Azure.Monitor.OpenTelemetry.AspNetCore v1.0.0

Expected behavior

An exception to not be thrown.

Actual behavior

An ArgumentNullException is getting thrown.

Reproduction Steps

Clone the following repo.

Environment

We are running this in Azure, but it is reproducible on a Windows 11 machine.

6.0.417 [/usr/local/share/dotnet/sdk]
Microsoft.AspNetCore.App 6.0.25 [/usr/local/share/dotnet/shared/Microsoft.AspNetCore.App]

[jsquire]

Thank you for your feedback. Tagging and routing to the team member best able to assist.

[saasen]

Thanks!

I know that one shouldn't really call the .Result on an async method, but the EnrichWithHttpResponseMessage action in OpenTelemetry doesn't contain an async overload.

I don't understand why it would throw an exception by reading the response body.

[saasen]

As an FYI, this works fine against Azurite, but I guess that is not identical as going against the real storage tables.

[christothes]

Does it still throw if you change .Result to GetAwaiter().GetResult() ?

[github-actions]

Hi @saasen. Thank you for opening this issue and giving us the opportunity to assist. To help our team better understand your issue and the details of your scenario please provide a response to the question asked above or the information requested above. This will help us more accurately address your issue.

[saasen]

Does it still throw if you change .Result to GetAwaiter().GetResult() ?

Yes.