Add native AoT annotations (#358)

martincostello · web-flow · commit c482466642b6 · 2025-11-25T16:06:05.000Z
* Add native AoT annotations

Bubble-up `[RequiresUnreferencedCode]` to the public API surface to enable the AoT analyzer, but not actually support native AoT.

* Update CHANGELOG

Add entries for native AoT.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -281,6 +281,8 @@
     ([#2880](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/2880))
   * Add support for .NET 10.0.
     ([#2822](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/2822))
+* Add native AoT annotations.
+  ([#358](https://github.com/grafana/grafana-opentelemetry-dotnet/pull/358))
 
 ### Bug Fixes
 
@@ -328,6 +330,8 @@
 * Use 1.14.0-beta.1 of OpenTelemetry.Instrumentation.Wcf ([#273](https://github.com/grafana/grafana-opentelemetry-dotnet/pull/273))
   * Fix possible infinite recursion when WCF is hosted in ASP.NET.
     ([#3248](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/3248))
+* Address some AoT warnings
+  ([#356](https://github.com/grafana/grafana-opentelemetry-dotnet/pull/356))
 
 ## 1.3.0
 
diff --git a/src/Grafana.OpenTelemetry.Base/Grafana.OpenTelemetry.Base.csproj b/src/Grafana.OpenTelemetry.Base/Grafana.OpenTelemetry.Base.csproj
@@ -47,9 +47,8 @@
     </AssemblyAttribute>
   </ItemGroup>
 
-  <!-- Not supported due to extensive use of reflection https://github.com/grafana/grafana-opentelemetry-dotnet/issues/97 -->
   <PropertyGroup Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net8.0'))">
-    <IsAotCompatible>false</IsAotCompatible>
+    <IsAotCompatible>true</IsAotCompatible>
   </PropertyGroup>
 
 </Project>
diff --git a/src/Grafana.OpenTelemetry.Base/Instrumentations/AWSInitializer.cs b/src/Grafana.OpenTelemetry.Base/Instrumentations/AWSInitializer.cs
@@ -7,6 +7,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class AWSInitializer : InstrumentationInitializer
     {
         public override Instrumentation Id { get; } = Instrumentation.AWS;
diff --git a/src/Grafana.OpenTelemetry.Base/Instrumentations/AWSLambdaInitializer.cs b/src/Grafana.OpenTelemetry.Base/Instrumentations/AWSLambdaInitializer.cs
@@ -7,6 +7,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class AWSLambdaInitializer : InstrumentationInitializer
     {
         public override Instrumentation Id { get; } = Instrumentation.AWSLambda;
diff --git a/src/Grafana.OpenTelemetry.Base/Instrumentations/AspNetCoreInitializer.cs b/src/Grafana.OpenTelemetry.Base/Instrumentations/AspNetCoreInitializer.cs
@@ -8,6 +8,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class AspNetCoreInitializer : InstrumentationInitializer
     {
         public override Instrumentation Id { get; } = Instrumentation.AspNetCore;
diff --git a/src/Grafana.OpenTelemetry.Base/Instrumentations/AspNetInitializer.cs b/src/Grafana.OpenTelemetry.Base/Instrumentations/AspNetInitializer.cs
@@ -8,6 +8,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class AspNetInitializer : InstrumentationInitializer
     {
         public override Instrumentation Id { get; } = Instrumentation.AspNet;
diff --git a/src/Grafana.OpenTelemetry.Base/Instrumentations/CassandraInitializer.cs b/src/Grafana.OpenTelemetry.Base/Instrumentations/CassandraInitializer.cs
@@ -8,6 +8,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class CassandraInitializer : InstrumentationInitializer
     {
         public override Instrumentation Id { get; } = Instrumentation.Cassandra;
diff --git a/src/Grafana.OpenTelemetry.Base/Instrumentations/ElasticsearchClientInitializer.cs b/src/Grafana.OpenTelemetry.Base/Instrumentations/ElasticsearchClientInitializer.cs
@@ -7,6 +7,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class ElasticsearchClientInitializer : InstrumentationInitializer
     {
         public override Instrumentation Id { get; } = Instrumentation.ElasticsearchClient;
diff --git a/src/Grafana.OpenTelemetry.Base/Instrumentations/EntityFrameworkCoreInitializer.cs b/src/Grafana.OpenTelemetry.Base/Instrumentations/EntityFrameworkCoreInitializer.cs
@@ -7,6 +7,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class EntityFrameworkCoreInitializer : InstrumentationInitializer
     {
         public override Instrumentation Id { get; } = Instrumentation.EntityFrameworkCore;
diff --git a/src/Grafana.OpenTelemetry.Base/Instrumentations/HangfireInitializer.cs b/src/Grafana.OpenTelemetry.Base/Instrumentations/HangfireInitializer.cs
@@ -7,6 +7,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class HangfireInitializer : InstrumentationInitializer
     {
         public override Instrumentation Id { get; } = Instrumentation.Hangfire;
diff --git a/src/Grafana.OpenTelemetry.Base/Instrumentations/MySqlDataInitializer.cs b/src/Grafana.OpenTelemetry.Base/Instrumentations/MySqlDataInitializer.cs
@@ -7,6 +7,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class MySqlDataInitializer : InstrumentationInitializer
     {
         public override Instrumentation Id { get; } = Instrumentation.MySqlData;
diff --git a/src/Grafana.OpenTelemetry.Base/Instrumentations/OwinInitializer.cs b/src/Grafana.OpenTelemetry.Base/Instrumentations/OwinInitializer.cs
@@ -7,6 +7,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class OwinInitializer : InstrumentationInitializer
     {
         public override Instrumentation Id { get; } = Instrumentation.Owin;
diff --git a/src/Grafana.OpenTelemetry.Base/Instrumentations/QuartzInitializer.cs b/src/Grafana.OpenTelemetry.Base/Instrumentations/QuartzInitializer.cs
@@ -7,6 +7,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class QuartzInitializer : InstrumentationInitializer
     {
         public override Instrumentation Id { get; } = Instrumentation.Quartz;
diff --git a/src/Grafana.OpenTelemetry.Base/Instrumentations/StackExchangeRedisInitializer.cs b/src/Grafana.OpenTelemetry.Base/Instrumentations/StackExchangeRedisInitializer.cs
@@ -7,6 +7,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class StackExchangeRedisInitializer : InstrumentationInitializer
     {
         public override Instrumentation Id { get; } = Instrumentation.StackExchangeRedis;
diff --git a/src/Grafana.OpenTelemetry.Base/Instrumentations/WcfInitializer.cs b/src/Grafana.OpenTelemetry.Base/Instrumentations/WcfInitializer.cs
@@ -7,6 +7,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class WcfInitializer : InstrumentationInitializer
     {
         public override Instrumentation Id { get; } = Instrumentation.Wcf;
diff --git a/src/Grafana.OpenTelemetry.Base/MeterProviderBuilderExtensions.cs b/src/Grafana.OpenTelemetry.Base/MeterProviderBuilderExtensions.cs
@@ -20,6 +20,9 @@ public static class MeterProviderBuilderExtensions
         /// <param name="builder">A <see cref="MeterProviderBuilder"/></param>
         /// <param name="configure">A callback for customizing default Grafana OpenTelemetry settings</param>
         /// <returns>A modified <see cref="MeterProviderBuilder"/> </returns>
+#if NET8_0_OR_GREATER
+        [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("The Grafana OpenTelemetry distribution for .NET does not support native AoT.")]
+#endif
         public static MeterProviderBuilder UseGrafana(this MeterProviderBuilder builder, Action<GrafanaOpenTelemetrySettings> configure = default)
         {
             GrafanaOpenTelemetrySettings settings = new GrafanaOpenTelemetrySettings();
@@ -66,6 +69,9 @@ internal static MeterProviderBuilder AddInstrumentations(this MeterProviderBuild
             return builder;
         }
 
+#if NET8_0_OR_GREATER
+        [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
         internal static MeterProviderBuilder AddResourceDetectors(this MeterProviderBuilder builder, HashSet<ResourceDetector> resourceDetectors)
         {
             if (resourceDetectors == null)
diff --git a/src/Grafana.OpenTelemetry.Base/ResourceDetectors/AWSEBSDetectorInitializer.cs b/src/Grafana.OpenTelemetry.Base/ResourceDetectors/AWSEBSDetectorInitializer.cs
@@ -8,6 +8,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class AWSEBSDetectorInitializer : ResourceDetectorInitializer
     {
         public override ResourceDetector Id { get; } = ResourceDetector.AWSEBS;
diff --git a/src/Grafana.OpenTelemetry.Base/ResourceDetectors/AWSEC2DetectorInitializer.cs b/src/Grafana.OpenTelemetry.Base/ResourceDetectors/AWSEC2DetectorInitializer.cs
@@ -8,6 +8,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class AWSEC2DetectorInitializer : ResourceDetectorInitializer
     {
         public override ResourceDetector Id { get; } = ResourceDetector.AWSEC2;
diff --git a/src/Grafana.OpenTelemetry.Base/ResourceDetectors/AWSECSDetectorInitializer.cs b/src/Grafana.OpenTelemetry.Base/ResourceDetectors/AWSECSDetectorInitializer.cs
@@ -8,6 +8,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class AWSECSDetectorInitializer : ResourceDetectorInitializer
     {
         public override ResourceDetector Id { get; } = ResourceDetector.AWSECS;
diff --git a/src/Grafana.OpenTelemetry.Base/ResourceDetectors/AWSEKSDetectorInitializer.cs b/src/Grafana.OpenTelemetry.Base/ResourceDetectors/AWSEKSDetectorInitializer.cs
@@ -8,6 +8,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class AWSEKSDetectorInitializer : ResourceDetectorInitializer
     {
         public override ResourceDetector Id { get; } = ResourceDetector.AWSEKS;
diff --git a/src/Grafana.OpenTelemetry.Base/ResourceDetectors/AzureAppServiceDetectorInitializer.cs b/src/Grafana.OpenTelemetry.Base/ResourceDetectors/AzureAppServiceDetectorInitializer.cs
@@ -7,6 +7,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class AzureAppServiceDetectorInitializer : ResourceDetectorInitializer
     {
         public override ResourceDetector Id { get; } = ResourceDetector.AzureAppService;
diff --git a/src/Grafana.OpenTelemetry.Base/ResourceDetectors/AzureContainerAppsDetectorInitializer.cs b/src/Grafana.OpenTelemetry.Base/ResourceDetectors/AzureContainerAppsDetectorInitializer.cs
@@ -7,6 +7,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class AzureContainerAppsDetectorInitializer : ResourceDetectorInitializer
     {
         public override ResourceDetector Id { get; } = ResourceDetector.AzureContainerApps;
diff --git a/src/Grafana.OpenTelemetry.Base/ResourceDetectors/AzureVMDetectorInitializer.cs b/src/Grafana.OpenTelemetry.Base/ResourceDetectors/AzureVMDetectorInitializer.cs
@@ -7,6 +7,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class AzureVMDetectorInitializer : ResourceDetectorInitializer
     {
         public override ResourceDetector Id { get; } = ResourceDetector.AzureVM;
diff --git a/src/Grafana.OpenTelemetry.Base/ResourceDetectors/ContainerResource.cs b/src/Grafana.OpenTelemetry.Base/ResourceDetectors/ContainerResource.cs
@@ -9,6 +9,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class ContainerResourceInitializer : ResourceDetectorInitializer
     {
         public override ResourceDetector Id { get; } = ResourceDetector.Container;
diff --git a/src/Grafana.OpenTelemetry.Base/ResourceDetectors/HostDetectorInitializer.cs b/src/Grafana.OpenTelemetry.Base/ResourceDetectors/HostDetectorInitializer.cs
@@ -9,6 +9,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class HostResourceInitializer : ResourceDetectorInitializer
     {
         public override ResourceDetector Id { get; } = ResourceDetector.Host;
diff --git a/src/Grafana.OpenTelemetry.Base/ResourceDetectors/OperatingSystemResourceInitializer.cs b/src/Grafana.OpenTelemetry.Base/ResourceDetectors/OperatingSystemResourceInitializer.cs
@@ -9,6 +9,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class OperatingSystemResourceInitializer : ResourceDetectorInitializer
     {
         public override ResourceDetector Id { get; } = ResourceDetector.OperatingSystem;
diff --git a/src/Grafana.OpenTelemetry.Base/ResourceDetectors/ProcessResourceInitializer.cs b/src/Grafana.OpenTelemetry.Base/ResourceDetectors/ProcessResourceInitializer.cs
@@ -9,6 +9,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class ProcessResourceInitializer : ResourceDetectorInitializer
     {
         public override ResourceDetector Id { get; } = ResourceDetector.Process;
diff --git a/src/Grafana.OpenTelemetry.Base/ResourceDetectors/ProcessRuntimeResource.cs b/src/Grafana.OpenTelemetry.Base/ResourceDetectors/ProcessRuntimeResource.cs
@@ -9,6 +9,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal sealed class ProcessRuntimeResourceInitializer : ResourceDetectorInitializer
     {
         public override ResourceDetector Id { get; } = ResourceDetector.ProcessRuntime;
diff --git a/src/Grafana.OpenTelemetry.Base/ResourceDetectors/ResourceDetectorInitializer.cs b/src/Grafana.OpenTelemetry.Base/ResourceDetectors/ResourceDetectorInitializer.cs
@@ -10,6 +10,9 @@
 
 namespace Grafana.OpenTelemetry
 {
+#if NET8_0_OR_GREATER
+    [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
     internal abstract class ResourceDetectorInitializer
     {
         public static readonly ResourceDetectorInitializer[] Initializers =
diff --git a/src/Grafana.OpenTelemetry.Base/TracerProviderBuilderExtensions.cs b/src/Grafana.OpenTelemetry.Base/TracerProviderBuilderExtensions.cs
@@ -20,6 +20,9 @@ public static class TracerProviderBuilderExtensions
         /// <param name="builder">A <see cref="TracerProviderBuilder"/></param>
         /// <param name="configure">A callback for customizing default Grafana OpenTelemetry settings</param>
         /// <returns>A modified <see cref="TracerProviderBuilder"/> </returns>
+#if NET8_0_OR_GREATER
+        [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("The Grafana OpenTelemetry distribution for .NET does not support native AoT.")]
+#endif
         public static TracerProviderBuilder UseGrafana(this TracerProviderBuilder builder, Action<GrafanaOpenTelemetrySettings> configure = default)
         {
             GrafanaOpenTelemetrySettings settings = new GrafanaOpenTelemetrySettings();
@@ -66,6 +69,9 @@ internal static TracerProviderBuilder AddInstrumentations(this TracerProviderBui
             return builder;
         }
 
+#if NET8_0_OR_GREATER
+        [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]
+#endif
         internal static TracerProviderBuilder AddResourceDetectors(this TracerProviderBuilder builder, HashSet<ResourceDetector> resourceDetectors)
         {
             if (resourceDetectors == null)
diff --git a/src/Grafana.OpenTelemetry/OpenTelemetryBuilderExtension.cs b/src/Grafana.OpenTelemetry/OpenTelemetryBuilderExtension.cs
@@ -24,6 +24,9 @@ public static class OpenTelemetryBuilderExtension
         /// <param name="builder">A <see cref="IOpenTelemetryBuilder"/></param>
         /// <param name="configure">A callback for customizing default Grafana OpenTelemetry settings</param>
         /// <returns>A modified <see cref="IOpenTelemetryBuilder"/> </returns>
+#if NET8_0_OR_GREATER
+        [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("The Grafana OpenTelemetry distribution for .NET does not support native AoT.")]
+#endif
         public static IOpenTelemetryBuilder UseGrafana(this IOpenTelemetryBuilder builder, Action<GrafanaOpenTelemetrySettings> configure = default)
         {
             return builder

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,9 @@`
`7`	`7`
`8`	`8`	`namespace Grafana.OpenTelemetry`
`9`	`9`	`{`
	`10`	`+#if NET8_0_OR_GREATER`
	`11`	`+ [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]`
	`12`	`+#endif`
`10`	`13`	`internal sealed class AWSInitializer : InstrumentationInitializer`
`11`	`14`	`{`
`12`	`15`	`public override Instrumentation Id { get; } = Instrumentation.AWS;`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,9 @@`
`8`	`8`
`9`	`9`	`namespace Grafana.OpenTelemetry`
`10`	`10`	`{`
	`11`	`+#if NET8_0_OR_GREATER`
	`12`	`+ [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Types might be removed")]`
	`13`	`+#endif`
`11`	`14`	`internal sealed class AspNetCoreInitializer : InstrumentationInitializer`
`12`	`15`	`{`
`13`	`16`	`public override Instrumentation Id { get; } = Instrumentation.AspNetCore;`