[bug] Instrumentation packages reference .NET 9 framework assemblies

[david-chandler-cko]

Component

OpenTelemetry.Instrumentation.AWS

Package Version

Package Name	Version
OpenTelemetry.Instrumentation.AWS	1.10.0-beta.1

Runtime Version

net8.0

Description

The common package versions have been updated for OpenTelemetry.NET and they now specify a minimum version of 9.0 for Microsoft.Extensions packages.
This means that projects targeting earlier framework versions can no longer be built using the .NET 8 SDK.

Steps to Reproduce

Try to include OpenTelemetry.Instrumentation.AWS library at version 1.10.0-beta.1 in a project targeting .net 8.

Expected Result

The library should target the extensions libraries with the same major version as the current .NET framework.

Actual Result

The library requires a reference to .NET 9 framework assemblies.

Additional Context

No response

[github-actions]

Tagging component owner(s).

@srprash @ppittle @muhammad-othman @rypdal @Oberon00

[Dreamescaper]

Using Microsoft.Extensions.Configuration 9.0.0 does not prevent from using .NET 8 SDK. net8.0 is fully supported by that package.

https://www.nuget.org/packages/microsoft.extensions.configuration/#supportedframeworks-body-tab

[ppittle]

@david-chandler-cko - can you elaborate further on your setup?

Looking at the GitHub Actions, OpenTelemetry.Instrumentation.AWS is rebuilt as part of any PR, including for .NET 8 on both windows and ubuntu, and has been succeeding as recently as today:

https://github.com/open-telemetry/opentelemetry-dotnet-contrib/actions/runs/12380042591/job/34555585408

[david-chandler-cko]

Hi @ppittle and @Dreamescaper, thanks for your replies.

There's nothing inherently wrong or broken, but we are targeting .NET 8 as it's the LTS version of .NET. This transitive dependency forces us to update the Microsoft SDK libraries to the 9.0 major version as semantic versioning treats the 8.0 to 9.0 upgrade as a breaking change. Since nothing in the AWS contrib actually needs anything new in 9.0 when targeting .NET 8 it should be possible to avoid this breaking change by making the major version align with the .NET version (e.g.,

opentelemetry-dotnet-contrib/build/Common.targets

Line 18 in c4a56e0

<PackageReference Include="System.Text.Json"

).

It's not a huge deal but I wondered if it was intentional?

[ppittle]

@david-chandler-cko - I'm afraid I still don't grok your issue.

For background, the version of System.Text.Json has special handling depending on which target is being built (ie 4.7.2, 6, 8 or 9):

opentelemetry-dotnet-contrib/build/Common.props

Line 58 in 5512176

<SystemTextJsonLatestNet8OutOfBandPkgVer>[8.0.5,)</SystemTextJsonLatestNet8OutOfBandPkgVer>

     <!-- Note: Special handling is performed for System.Text.Json. -->
    <SystemTextEncodingsWebMinimumOutOfBandPkgVer>[4.7.2,)</SystemTextEncodingsWebMinimumOutOfBandPkgVer>
    <SystemTextJsonMinimumOutOfBandPkgVer>[4.7.2,)</SystemTextJsonMinimumOutOfBandPkgVer>
    <SystemTextJsonLatestNet6OutOfBandPkgVer>[6.0.10,)</SystemTextJsonLatestNet6OutOfBandPkgVer>
    <SystemTextJsonLatestNet8OutOfBandPkgVer>[8.0.5,)</SystemTextJsonLatestNet8OutOfBandPkgVer>

I wondered if it was intentional?

The handling of System.Text.Json has been pretty intentional. For example, have a look at this PR: #2196

To be honest, I don't fully understand it. If you want a more in-depth understanding, I'd recommend pinging @CodeBlanch on the [Open Telemetry Slack] or asking in the #otel-dotnet channel.

[david-chandler-cko]

We were trying to build a .NET 8 project using ReadyToRun. If we attempt to target .NET 9 assemblies then at runtime the application fails with an MVID mismatch error because the version of the Microsoft.Extensions.Configuration.Abstractions.dll assembly referenced by the Otel AWS contrib library references a > 9.0 version and the framework supplies an 8.x version. Even if you explicitly reference the 9.x version of the Abstractions.dll the linker excludes this when publishing the app - not sure why. My mention of System.Text.Json was to point out that for .net8 you reference an 8.x version and for .net9 you reference a 9.x version. My suggestion is that this what a consumer should expect; if you target .net8, it should reference Microsoft.Extensions.*.dll 8.x.

[david-chandler-cko]

Hi @CodeBlanch! Is this something you're able to help out with at all? I can't find a definitive answer on whether using a .NET 9 version of a reference is supported, but in general .NET 8 is in LTS and .NET 9 is not, and therefore it doesn't seem like clients should be forced to reference versions across frameworks like this. Is there a particular reason that at least 9.0 is required?
Is it possible that this has been tested using 8.x versions as well? I notice that Common.props is using [9.0.0,) and Common.nonprod.props is using 8.0.1:

opentelemetry-dotnet-contrib/build/Common.props

Line 38 in dd0f51f

<MicrosoftExtensionsConfigurationPkgVer>[9.0.0,)</MicrosoftExtensionsConfigurationPkgVer>

opentelemetry-dotnet-contrib/build/Common.nonprod.props

Line 28 in dd0f51f

<MicrosoftExtensionsConfigurationJsonPkgVer>8.0.1</MicrosoftExtensionsConfigurationJsonPkgVer>

Apart from testing using .NET 9 rather than .NET 8, perhaps this is hiding the problem for local testing? At any rate, we've managed to build our project by using self-contained deployment but our API behaves erratically (it ran for several hours but then several containers hit 100% CPU. The only change was to update this library).