[SqlClient] Broken on .NET Framework?

[CodeBlanch]

I noticed working on open-telemetry/opentelemetry-dotnet#3900 that the .NET Framework integration test is failing.

On .NET Framework Sql instrumentation listens to SqlEventSource which uses keywords.

When SqlCommands are executing the EventSource code is writing this error instead of behaving normally (firing BeginExecute \ EndExecute):

ERROR: Exception in Command Processing for EventSource Microsoft-AdoNet-SystemData: Use of undefined keyword value 0x1 for event BeginExecute.

Working with @tarekgh it seems the nested public static class Keywords is not present in the final code. We suspect some kind of trimming issue. Waiting to hear back from some other folks.

Not sure when this started. We don't run the .NET Framework integration tests in our CI. But as far as I can tell, instrumentation is broken on .NET Framework. Could be only certain versions or OSes are impacted. I'm running 4.8.09032 on Windows 11.

[RassK]

Just discovered the same issue.

Windows 11 Pro (22621.819), .NET 4.8.1 (533320)

Quick test app
SqlClientTests.zip

Running dependencies (SQL Server on Linux Docker container)
docker run -p 1433:1433 -e SA_PASSWORD=Passw0rd -e ACCEPT_EULA=Y --name sql-server-1433 mcr.microsoft.com/mssql/server:2019-CU17-ubuntu-20.04

[CodeBlanch]

Update for anyone interested: It looks like this broke with the release of .NET 4.8.1. It should work in all prior versions but I haven't had a chance to verify yet.

[pellared]

@CodeBlanch Is this bug reported so that it will be eventually fixed in .NET 4.8.1 patch release? Is there any issue that we can track?

[tarekgh]

@pellared we are currently what is the best action to take here. We'll update you when we have more news. it is kind slow these days because of the holidays :-)

CC @ajcvickers

[ajcvickers]

Note that regardless of the holidays, getting a change into .NET Framework is a long process. Expect months.

[pellared]

The issue was also reported here: open-telemetry/opentelemetry-dotnet-instrumentation#2177

[Kronos11]

Just a note, but this is a pretty major blocker for us being able to adopt OTel within our large enterprise application. I hope it can be prioritized as such.

[cijothomas]

This was originally assumed to be broken only on .NET FW 4.8.1, but it looks like even Net462 is broken?

[tarekgh]

This was originally assumed to be broken only on .NET FW 4.8.1, but open-telemetry/opentelemetry-dotnet-instrumentation#2177 (comment) even Net462 is broken?

Note, the .NET Framework installs one version on the machine which supports multiple targets. So, most likely the installed version is 4.8 and the app is just targeting 4.6.2.

[dave-at-bits]

Has anyone been able to find a workaround for this? It's odd because this issue is only happening to my machine on our team. I went so far as to reformat and still encounter the issue. But I suspect that's just due to the fact that I had the latest version of .Net both times.

[tarekgh]

@ajcvickers you were the one looking at fixing this issue. Is there any update here?

[luizfbicalho]

So, if I have a .net framework webapp it doesn't generate the Trace for the sql client connections, is that?

[luizfbicalho]

Is this a case to use @ErikEJ Entity Framework 6 SQL Server provider based on Microsoft.Data.SqlClient?

https://github.com/ErikEJ/EntityFramework6PowerTools

UPDATE
I added this project and now the trace is correct

[josephedwardchang]

Just discovered the same issue.

Windows 11 Pro (22621.819), .NET 4.8.1 (533320)

Quick test app SqlClientTests.zip

Running dependencies (SQL Server on Linux Docker container) docker run -p 1433:1433 -e SA_PASSWORD=Passw0rd -e ACCEPT_EULA=Y --name sql-server-1433 mcr.microsoft.com/mssql/server:2019-CU17-ubuntu-20.04

i've also run into this issue generating Entity Framework storedproc and the call to ExecuteFunction <T> has this error on VS2019 but not in VS2022 (both updated latest). i'm using Win10 Pro 22H2 latest updates and .Net 4.8.1. I'm using separate folders on a single project: one in VS2019 and another exact same copy in VS2022. Since it is working on VS2022 i'll continue to use that instead of waiting for a fix on VS2019.

[CodeBlanch]

Update: The .NET Framework team is working on a fix and it should be available in the next month or two. I'll post more details when we have a more concrete date.

[CodeBlanch]

Happy to report that this will be fixed in the next .NET Framework Cumulative Update: https://devblogs.microsoft.com/dotnet/dotnet-framework-september-2023-cumulative-update-preview/#sqlclient

[pellared]

@CodeBlanch, I think we can close this bug.

I tested it here: open-telemetry/opentelemetry-dotnet-instrumentation#3412