.NET Framework support HighResolutionTimerEnabled (#740)

Author: Kielek

src/Splunk.OpenTelemetry.AutoInstrumentation/Helpers/WinApi.cs

@@ -14,8 +14,6 @@
 // limitations under the License.
 // </copyright>
 
-#if NET
-
 using System.Runtime.InteropServices;
 using Splunk.OpenTelemetry.AutoInstrumentation.Logging;
 
@@ -66,4 +64,3 @@ private static class Windows
         public static extern uint TimeEndPeriod(uint milliseconds);
     }
 }
-#endif

src/Splunk.OpenTelemetry.AutoInstrumentation/Plugin.cs

@@ -14,9 +14,7 @@
 // limitations under the License.
 // </copyright>
 
-using System.Diagnostics;
 using System.Runtime.InteropServices;
-using OpenTelemetry;
 using OpenTelemetry.Context.Propagation;
 using OpenTelemetry.Exporter;
 using OpenTelemetry.Resources;
@@ -47,10 +45,8 @@ public class Plugin
     private static readonly ILogger Log = new Logger();
 
     private static PprofInOtlpLogsExporter? _pprofInOtlpLogsExporter;
-#if NET
     private static int _highResTimerEnabled;
     private static int _highResTimerDisabled;
-#endif
 
     private readonly Metrics _metrics = new(Settings);
     private readonly Traces _traces = new(Settings);
@@ -70,13 +66,14 @@ public void Initializing()
             Log.LogConfigurationSetup();
         }
 
+        if (
 #if NET
-        if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows) &&
+            RuntimeInformation.IsOSPlatform(OSPlatform.Windows) &&
+#endif
             Settings is { SnapshotsEnabled: true, HighResolutionTimerEnabled: true })
         {
             EnableHighResTimer();
         }
-#endif
     }
 
     /// <summary>
@@ -113,7 +110,7 @@ public void ConfigureTracesOptions(OtlpExporterOptions options)
     /// <summary>
     /// Configures ASP.NET instrumentation options.
     /// </summary>
-    /// <param name="options">Otlp options.</param>
+    /// <param name="options">ASP.NET Trace InstrumentationO options.</param>
     public void ConfigureTracesOptions(AspNetTraceInstrumentationOptions options)
     {
         _traces.ConfigureTracesOptions(options);
@@ -124,7 +121,7 @@ public void ConfigureTracesOptions(AspNetTraceInstrumentationOptions options)
     /// <summary>
     /// Configures ASP.NET Core instrumentation options.
     /// </summary>
-    /// <param name="options">Otlp options.</param>
+    /// <param name="options">ASP.NET Core Trace InstrumentationO options.</param>
     public void ConfigureTracesOptions(AspNetCoreTraceInstrumentationOptions options)
     {
         _traces.ConfigureTracesOptions(options);
@@ -211,7 +208,6 @@ public TracerProviderBuilder BeforeConfigureTracerProvider(TracerProviderBuilder
         return builder;
     }
 
-#if NET
     private static void EnableHighResTimer()
     {
         if (Interlocked.Exchange(ref _highResTimerEnabled, value: 1) != 0)
@@ -239,7 +235,6 @@ private static void DisableHighResTimer(object? o, EventArgs args)
 
         WinApi.TryDisableHighResolutionTimer();
     }
-#endif
 
     private static TimeSpan GetSampleExportTimeout()
     {

test/Splunk.OpenTelemetry.AutoInstrumentation.Tests/SettingsTests.cs

@@ -96,15 +96,15 @@ internal void PluginSettings_DefaultValues()
             Assert.Equal("none", settings.Realm);
             Assert.Null(settings.AccessToken);
             Assert.True(settings.TraceResponseHeaderEnabled);
-#if NET
+            Assert.False(settings.HighResolutionTimerEnabled);
             Assert.Equal("http://localhost:4318/v1/logs", settings.ProfilerLogsEndpoint.ToString());
             Assert.False(settings.CpuProfilerEnabled);
-            Assert.False(settings.MemoryProfilerEnabled);
             Assert.False(settings.SnapshotsEnabled);
-            Assert.False(settings.HighResolutionTimerEnabled);
             Assert.Equal(10000u, settings.CpuProfilerCallStackInterval);
             Assert.Equal(3000u, settings.ProfilerHttpClientTimeout);
             Assert.Equal(500u, settings.ProfilerExportInterval);
+#if NET
+            Assert.False(settings.MemoryProfilerEnabled);
             Assert.Equal(200u, settings.MemoryProfilerMaxMemorySamplesPerMinute);
 #endif
         }
@@ -116,17 +116,17 @@ private static void ClearEnvVars()
             Environment.SetEnvironmentVariable(ConfigurationKeys.Splunk.Realm, null);
             Environment.SetEnvironmentVariable(ConfigurationKeys.Splunk.AccessToken, null);
             Environment.SetEnvironmentVariable(ConfigurationKeys.Splunk.TraceResponseHeaderEnabled, null);
-#if NET
             Environment.SetEnvironmentVariable(ConfigurationKeys.Splunk.AlwaysOnProfiler.CpuProfilerEnabled, null);
             Environment.SetEnvironmentVariable(ConfigurationKeys.Splunk.AlwaysOnProfiler.CallStackInterval, null);
-            Environment.SetEnvironmentVariable(ConfigurationKeys.Splunk.AlwaysOnProfiler.MemoryProfilerEnabled, null);
             Environment.SetEnvironmentVariable(ConfigurationKeys.Splunk.AlwaysOnProfiler.ProfilerLogsEndpoint, null);
             Environment.SetEnvironmentVariable(ConfigurationKeys.Splunk.AlwaysOnProfiler.ProfilerExportTimeout, null);
             Environment.SetEnvironmentVariable(ConfigurationKeys.Splunk.AlwaysOnProfiler.ProfilerExportInterval, null);
-            Environment.SetEnvironmentVariable(ConfigurationKeys.Splunk.AlwaysOnProfiler.ProfilerMaxMemorySamples, null);
             Environment.SetEnvironmentVariable(ConfigurationKeys.Splunk.Snapshots.Enabled, null);
             Environment.SetEnvironmentVariable(ConfigurationKeys.Splunk.Snapshots.SamplingIntervalMs, null);
             Environment.SetEnvironmentVariable(ConfigurationKeys.Splunk.Snapshots.SelectionRate, null);
+#if NET
+            Environment.SetEnvironmentVariable(ConfigurationKeys.Splunk.AlwaysOnProfiler.MemoryProfilerEnabled, null);
+            Environment.SetEnvironmentVariable(ConfigurationKeys.Splunk.AlwaysOnProfiler.ProfilerMaxMemorySamples, null);
 #endif
         }
     }