Does not support trimming or native aot in dotnet 8

[MartinCarpentier]

Bug Report

• Grafana.OpenTelemetry 0.8.1-beta

• net8.0 with asp.net

Symptom

When adding UseGrafana on the OpenTelemetry providers on trimmed or native aot compiled applications, the app fails during startup with the following exception.

2024-05-12 17:02:06 Unhandled Exception: System.InvalidOperationException: Reflection-based serialization has been disabled for this application. Either use the source generator APIs or explicitly configure the 'JsonSerializerOptions.TypeInfoResolver' property.
2024-05-12 17:02:06 at System.Text.Json.ThrowHelper.ThrowInvalidOperationException_JsonSerializerIsReflectionDisabled() + 0x27
2024-05-12 17:02:06 at System.Text.Json.JsonSerializerOptions.ConfigureForJsonSerializer() + 0x2e
2024-05-12 17:02:06 at System.Text.Json.JsonSerializer.GetTypeInfo(JsonSerializerOptions, Type) + 0x2d
2024-05-12 17:02:06 at System.Text.Json.JsonSerializer.GetTypeInfoT + 0x2b
2024-05-12 17:02:06 at Grafana.OpenTelemetry.TracerProviderBuilderExtensions.UseGrafana(TracerProviderBuilder, Action1) + 0x98 2024-05-12 17:02:06 at TestService.Program.<>c__DisplayClass1_0.<Main>b__2(TracerProviderBuilder tracing) + 0x58 2024-05-12 17:02:06 at OpenTelemetry.OpenTelemetryBuilderSdkExtensions.WithTracing(IOpenTelemetryBuilder, Action1) + 0x3c
2024-05-12 17:02:06 at TestService.Program.Main(String[] args) + 0x14c
2024-05-12 17:02:06 at TestService!+0xacf63c

What is the expected behavior?

That it works and does not fail

What is the actual behavior?

It fails as shown above.

Reproduce

From program.cs in an asp.net application with dotnet 8

...
builder.Logging.AddOpenTelemetry(options =>
{
options
.SetResourceBuilder(
ResourceBuilder.CreateDefault()
.AddService(serviceName))
.UseGrafana(config =>
{
config.ServiceName = serviceName;
});
});
builder.Services.AddOpenTelemetry()
.ConfigureResource(resource => resource.AddService(serviceName))
.WithTracing(tracing => tracing
.AddAspNetCoreInstrumentation()
.UseGrafana(config =>
{
config.ServiceName = serviceName;
}))
.WithMetrics(metrics => metrics
.AddAspNetCoreInstrumentation()
.AddRuntimeInstrumentation()
.AddProcessInstrumentation()
.UseGrafana(config =>
{
config.ServiceName = serviceName;
}));
...

Additional Context

Add any other context about the problem here.

[martincostello]

Newer versions of the OpenTelemetry libraries now support native AoT (with some exceptions).

After a few CI-related PRs have been merged and we update to the latest OTel NuGet packages, we can add add a native AoT validation leg and see if this has been resolved, or whether we need to make some fixes to our distro to ensure that we are also native AoT compatible.

[martincostello]

Had a quick look at this again.

We could trivially validate AoT (at least, in that there are no warnings) by adding <PublishAot>true</PublishAot> to the Dockerfile with the updates in #145, however the use of MVC and EntityFramework cause the build to fail because both of those technologies do not support native AoT.

Instead, we should add a separate application that only uses Minimal APIs and SqlClient that's specific to native AoT. As part of that, we could also add gRPC to validate we work correctly with that too.

[martincostello]

Above comment is related to testing, but the testing I did based on #145 suggests that there are no native AoT warnings coming from the distro itself.

[martincostello]

Spoke too soon, when enabling IsAotCompatible=true 7 errors happen. Will look to see if I can fix them (or reduce the number).

[martincostello]

Most warnings addressed in #184, though I think #145 is still needed for fuller compatibility.

The remaining warning concerns our use of reflection to call methods in various OpenTelemetry packages. These might be resolvable through relevant trimming annotations being added.