Enable Roslyn analysis - final

Common.props

@@ -7,6 +7,7 @@
     <NuGetAudit>true</NuGetAudit>
     <NuGetAuditMode>all</NuGetAuditMode>
     <NuGetAuditLevel>low</NuGetAuditLevel>
+    <AnalysisLevel>latest-All</AnalysisLevel>
   </PropertyGroup>
 
   <!-- StyleCop -->

build/_build.csproj

@@ -5,7 +5,7 @@
     <TargetFramework Condition=" '$(IsLegacyUbuntu)' == '' " >net10.0</TargetFramework>
     <TargetFramework Condition=" '$(IsLegacyUbuntu)' != '' " >net9.0</TargetFramework>
     <RootNamespace></RootNamespace>
-    <NoWarn>CS0649;CS0169</NoWarn>
+    <NoWarn>$(NoWarn);CS0649;CS0169</NoWarn>
     <NukeRootDirectory>..\</NukeRootDirectory>
     <NukeScriptDirectory>..\</NukeScriptDirectory>
     <NukeTelemetryVersion>1</NukeTelemetryVersion>

examples/demo/Service/LoggingExtensions.cs

@@ -0,0 +1,10 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+namespace Examples.Service;
+
+internal static partial class LoggingExtensions
+{
+    [LoggerMessage(Level = LogLevel.Information, Message = "Success! Today is: {Date:MMMM dd, yyyy}")]
+    public static partial void Success(this ILogger logger, DateTimeOffset date);
+}

examples/demo/Service/Program.cs

@@ -3,6 +3,7 @@
 
 using System.Diagnostics;
 using System.Diagnostics.Metrics;
+using Examples.Service;
 using Microsoft.Data.SqlClient;
 
 // .NET Diagnostics: create the span factory
@@ -29,7 +30,9 @@ async Task<string> Handler(ILogger<Program> logger)
         activity?.SetTag("bar", "Hello, World!");
         activity?.SetTag("baz", (int[])[1, 2, 3]);
 
+#pragma warning disable CA5394 // Do not use insecure randomness. Not related to security, just a demo.
         var waitTime = Random.Shared.NextDouble(); // max 1 seconds
+#pragma warning restore CA5394 // Do not use insecure randomness. Not related to security, just a demo.
         await Task.Delay(TimeSpan.FromSeconds(waitTime)).ConfigureAwait(false);
 
         activity?.SetStatus(ActivityStatusCode.Ok);
@@ -39,7 +42,7 @@ async Task<string> Handler(ILogger<Program> logger)
     }
 
     // .NET ILogger: create a log
-    logger.LogInformation("Success! Today is: {Date:MMMM dd, yyyy}", DateTimeOffset.UtcNow);
+    logger.Success(DateTimeOffset.UtcNow);
 
     return "Hello there";
 }

src/Directory.Build.props

@@ -30,7 +30,6 @@
     <NoWarn>$(NoWarn);NU5104</NoWarn>
 
     <EmbedUntrackedSources Condition=" '$(TargetFramework)' == 'net462' ">true</EmbedUntrackedSources>
-    <AnalysisLevel>latest-All</AnalysisLevel>
   </PropertyGroup>
 
   <ItemGroup>

src/OpenTelemetry.AutoInstrumentation/Configurations/ConfigurationExtensions.cs

@@ -2,12 +2,19 @@
 // SPDX-License-Identifier: Apache-2.0
 
 using System.Globalization;
+#if NET
+using System.Text;
+#endif
 
 namespace OpenTelemetry.AutoInstrumentation.Configurations;
 
 internal static class ConfigurationExtensions
 {
+#if NET
+    public static IReadOnlyList<TEnum> ParseEnabledEnumList<TEnum>(this Configuration source, bool enabledByDefault, CompositeFormat enabledConfigurationTemplate)
+#else
     public static IReadOnlyList<TEnum> ParseEnabledEnumList<TEnum>(this Configuration source, bool enabledByDefault, string enabledConfigurationTemplate)
+#endif
         where TEnum : struct, Enum, IConvertible
     {
 #if NET

src/OpenTelemetry.AutoInstrumentation/Configurations/ConfigurationKeys.cs

@@ -3,6 +3,9 @@
 
 using System.Diagnostics;
 using System.Diagnostics.Metrics;
+#if NET
+using System.Text;
+#endif
 using OpenTelemetry.Logs;
 
 namespace OpenTelemetry.AutoInstrumentation.Configurations;
@@ -47,12 +50,7 @@ internal partial class ConfigurationKeys
     public const string ResourceDetectorEnabled = "OTEL_DOTNET_AUTO_RESOURCE_DETECTOR_ENABLED";
 
     /// <summary>
-    /// Configuration key template for enabling resource detectors.
-    /// </summary>
-    public const string EnabledResourceDetectorTemplate = "OTEL_DOTNET_AUTO_{0}_RESOURCE_DETECTOR_ENABLED";
-
-    /// <summary>
-    /// Configuration key template for resource attributes.
+    /// Configuration key for resource attributes.
     /// </summary>
     public const string ResourceAttributes = "OTEL_RESOURCE_ATTRIBUTES";
 
@@ -61,6 +59,15 @@ internal partial class ConfigurationKeys
     /// </summary>
     public const string ServiceName = "OTEL_SERVICE_NAME";
 
+    /// <summary>
+    /// Configuration key template for enabling resource detectors.
+    /// </summary>
+#if NET
+    public static readonly CompositeFormat EnabledResourceDetectorTemplate = CompositeFormat.Parse("OTEL_DOTNET_AUTO_{0}_RESOURCE_DETECTOR_ENABLED");
+#else
+    public const string EnabledResourceDetectorTemplate = "OTEL_DOTNET_AUTO_{0}_RESOURCE_DETECTOR_ENABLED";
+#endif
+
     /// <summary>
     /// Configuration keys for file based configuration.
     /// </summary>
@@ -104,11 +111,6 @@ public static class Traces
         /// </summary>
         public const string TracesInstrumentationEnabled = "OTEL_DOTNET_AUTO_TRACES_INSTRUMENTATION_ENABLED";
 
-        /// <summary>
-        /// Configuration key template for disabled trace instrumentations.
-        /// </summary>
-        public const string EnabledTracesInstrumentationTemplate = "OTEL_DOTNET_AUTO_TRACES_{0}_INSTRUMENTATION_ENABLED";
-
         /// <summary>
         /// Configuration key for additional <see cref="ActivitySource"/> names to be added to the tracer at the startup.
         /// </summary>
@@ -119,6 +121,15 @@ public static class Traces
         /// </summary>
         public const string AdditionalLegacySources = "OTEL_DOTNET_AUTO_TRACES_ADDITIONAL_LEGACY_SOURCES";
 
+        /// <summary>
+        /// Configuration key template for disabled trace instrumentations.
+        /// </summary>
+#if NET
+        public static readonly CompositeFormat EnabledTracesInstrumentationTemplate = CompositeFormat.Parse("OTEL_DOTNET_AUTO_TRACES_{0}_INSTRUMENTATION_ENABLED");
+#else
+        public const string EnabledTracesInstrumentationTemplate = "OTEL_DOTNET_AUTO_TRACES_{0}_INSTRUMENTATION_ENABLED";
+#endif
+
         /// <summary>
         /// Configuration keys for instrumentation options.
         /// </summary>
@@ -207,14 +218,18 @@ public static class Metrics
         public const string MetricsInstrumentationEnabled = "OTEL_DOTNET_AUTO_METRICS_INSTRUMENTATION_ENABLED";
 
         /// <summary>
-        /// Configuration key template for enabled metric instrumentations.
+        /// Configuration key for additional <see cref="Meter"/> names to be added to the meter at the startup.
         /// </summary>
-        public const string EnabledMetricsInstrumentationTemplate = "OTEL_DOTNET_AUTO_METRICS_{0}_INSTRUMENTATION_ENABLED";
+        public const string AdditionalSources = "OTEL_DOTNET_AUTO_METRICS_ADDITIONAL_SOURCES";
 
         /// <summary>
-        /// Configuration key for additional <see cref="Meter"/> names to be added to the meter at the startup.
+        /// Configuration key template for enabled metric instrumentations.
         /// </summary>
-        public const string AdditionalSources = "OTEL_DOTNET_AUTO_METRICS_ADDITIONAL_SOURCES";
+#if NET
+        public static readonly CompositeFormat EnabledMetricsInstrumentationTemplate = CompositeFormat.Parse("OTEL_DOTNET_AUTO_METRICS_{0}_INSTRUMENTATION_ENABLED");
+#else
+        public const string EnabledMetricsInstrumentationTemplate = "OTEL_DOTNET_AUTO_METRICS_{0}_INSTRUMENTATION_ENABLED";
+#endif
     }
 
     /// <summary>
@@ -259,7 +274,11 @@ public static class Logs
         /// <summary>
         /// Configuration key template for enabled log instrumentations.
         /// </summary>
+#if NET
+        public static readonly CompositeFormat EnabledLogsInstrumentationTemplate = CompositeFormat.Parse("OTEL_DOTNET_AUTO_LOGS_{0}_INSTRUMENTATION_ENABLED");
+#else
         public const string EnabledLogsInstrumentationTemplate = "OTEL_DOTNET_AUTO_LOGS_{0}_INSTRUMENTATION_ENABLED";
+#endif
     }
 
     /// <summary>

test/Directory.Build.props

@@ -9,6 +9,9 @@
 
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)test-keypair.snk</AssemblyOriginatorKeyFile>
+
+    <!-- CA1707: Identifiers should not contain underscores. It is typical pattern for test methods. -->
+    <NoWarn>$(NoWarn);CA1707</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

test/IntegrationTests/AspNetTests.cs

@@ -12,6 +12,16 @@ public class AspNetTests
 {
     private const string ServiceName = "TestApplication.AspNet.NetFramework";
 
+    private static readonly HttpClient Client = new()
+    {
+        DefaultRequestHeaders =
+        {
+            { "Custom-Request-Test-Header1", "Test-Value1" },
+            { "Custom-Request-Test-Header2", "Test-Value2" },
+            { "Custom-Request-Test-Header3", "Test-Value3" }
+        }
+    };
+
     public AspNetTests(ITestOutputHelper output)
     {
         Output = output;
@@ -72,8 +82,10 @@ public async Task SubmitsTraces(AppPoolMode appPoolMode, Gac useGac)
         };
         var webPort = TcpPortProvider.GetOpenPort();
         var imageName = GetTestImageName(appPoolMode, useGac);
+#pragma warning disable CA2007 // Do not directly await a Task. https://github.com/dotnet/roslyn-analyzers/issues/7185
         await using var container = await IISContainerTestHelper.StartContainerAsync(imageName, webPort, environmentVariables, Output);
-        await CallTestApplicationEndpoint(webPort);
+#pragma warning restore CA2007 // Do not directly await a Task. https://github.com/dotnet/roslyn-analyzers/issues/7185
+        await CallTestApplicationEndpoint(webPort).ConfigureAwait(true);
 
         collector.AssertExpectations();
     }
@@ -144,8 +156,10 @@ public async Task SubmitTracesCapturesHttpHeaders(AppPoolMode appPoolMode, Gac u
         };
         var webPort = TcpPortProvider.GetOpenPort();
         var imageName = GetTestImageName(appPoolMode, useGac);
+#pragma warning disable CA2007 // Do not directly await a Task. https://github.com/dotnet/roslyn-analyzers/issues/7185
         await using var container = await IISContainerTestHelper.StartContainerAsync(imageName, webPort, environmentVariables, Output);
-        await CallTestApplicationEndpoint(webPort);
+#pragma warning restore CA2007 // Do not directly await a Task. https://github.com/dotnet/roslyn-analyzers/issues/7185
+        await CallTestApplicationEndpoint(webPort).ConfigureAwait(true);
 
         collector.AssertExpectations();
     }
@@ -176,8 +190,10 @@ public async Task TracesResource()
         };
 
         var webPort = TcpPortProvider.GetOpenPort();
+#pragma warning disable CA2007 // Do not directly await a Task. https://github.com/dotnet/roslyn-analyzers/issues/7185
         await using var container = await IISContainerTestHelper.StartContainerAsync("testapplication-aspnet-netframework-integrated", webPort, environmentVariables, Output);
-        await CallTestApplicationEndpoint(webPort);
+#pragma warning restore CA2007 // Do not directly await a Task. https://github.com/dotnet/roslyn-analyzers/issues/7185
+        await CallTestApplicationEndpoint(webPort).ConfigureAwait(true);
 
         collector.ResourceExpector.AssertExpectations();
     }
@@ -205,8 +221,10 @@ public async Task SubmitMetrics()
             ["OTEL_DOTNET_AUTO_METRICS_ASPNET_INSTRUMENTATION_ENABLED"] = "true" // Helps to reduce noise by enabling only AspNet metrics.
         };
         var webPort = TcpPortProvider.GetOpenPort();
+#pragma warning disable CA2007 // Do not directly await a Task. https://github.com/dotnet/roslyn-analyzers/issues/7185
         await using var container = await IISContainerTestHelper.StartContainerAsync("testapplication-aspnet-netframework-integrated", webPort, environmentVariables, Output);
-        await CallTestApplicationEndpoint(webPort);
+#pragma warning restore CA2007 // Do not directly await a Task. https://github.com/dotnet/roslyn-analyzers/issues/7185
+        await CallTestApplicationEndpoint(webPort).ConfigureAwait(true);
 
         collector.AssertExpectations();
     }
@@ -225,18 +243,12 @@ private static string GetTestImageName(AppPoolMode appPoolMode, Gac useGac)
 
     private async Task CallTestApplicationEndpoint(int webPort)
     {
-        var client = new HttpClient();
-
-        client.DefaultRequestHeaders.Add("Custom-Request-Test-Header1", "Test-Value1");
-        client.DefaultRequestHeaders.Add("Custom-Request-Test-Header2", "Test-Value2");
-        client.DefaultRequestHeaders.Add("Custom-Request-Test-Header3", "Test-Value3");
-
-        var response = await client.GetAsync(new Uri($"http://localhost:{webPort}")).ConfigureAwait(false);
+        var response = await Client.GetAsync(new Uri($"http://localhost:{webPort}")).ConfigureAwait(false);
         var content = await response.Content.ReadAsStringAsync().ConfigureAwait(false);
         Output.WriteLine("MVC Response:");
         Output.WriteLine(content);
 
-        response = await client.GetAsync(new Uri($"http://localhost:{webPort}/api/values")).ConfigureAwait(false);
+        response = await Client.GetAsync(new Uri($"http://localhost:{webPort}/api/values")).ConfigureAwait(false);
         content = await response.Content.ReadAsStringAsync().ConfigureAwait(false);
         Output.WriteLine("WebApi Response:");
         Output.WriteLine(content);

test/IntegrationTests/AzureCollection.cs → test/IntegrationTests/AzureCollectionFixture.cs

@@ -9,9 +9,9 @@
 namespace IntegrationTests;
 
 [CollectionDefinition(Name)]
-public class AzureCollection : ICollectionFixture<AzureFixture>
+public class AzureCollectionFixture : ICollectionFixture<AzureFixture>
 {
-    public const string Name = nameof(AzureCollection);
+    public const string Name = nameof(AzureCollectionFixture);
 }
 
 public class AzureFixture : IAsyncLifetime

test/IntegrationTests/AzureTests.cs

@@ -6,7 +6,7 @@
 
 namespace IntegrationTests;
 
-[Collection(AzureCollection.Name)]
+[Collection(AzureCollectionFixture.Name)]
 public class AzureTests : TestHelper
 {
     private readonly AzureFixture _azure;

test/IntegrationTests/ConsoleThreadSample.cs

@@ -3,7 +3,9 @@
 
 namespace IntegrationTests;
 
-internal class ConsoleThreadSample
+#pragma warning disable CA1812 // Avoid uninstantiated internal classes. This class is instantiated by deserializer.
+internal sealed class ConsoleThreadSample
+#pragma warning disable CA1812 // Avoid uninstantiated internal classes. This class is instantiated by deserializer.
 {
     public long TimestampNanoseconds { get; set; }
 

test/IntegrationTests/ContinuousProfilerTests.cs

@@ -158,6 +158,10 @@ private static bool ContainStackTraceForClassHierarchy(Profile profile, string e
 
         var stackTrace = string.Join("\n", frames);
 
+#if NET
+        return stackTrace.Contains(expectedStackTrace, StringComparison.Ordinal);
+#else
         return stackTrace.Contains(expectedStackTrace);
+#endif
     }
 }

test/IntegrationTests/CustomSdkTests.cs

@@ -9,7 +9,7 @@
 
 namespace IntegrationTests;
 
-[Collection(RedisCollection.Name)]
+[Collection(RedisCollectionFixture.Name)]
 public class CustomSdkTests : TestHelper
 {
     private readonly RedisFixture _redis;

test/IntegrationTests/EntityFrameworkCorePomeloMySqlTests.cs

@@ -8,7 +8,7 @@
 
 namespace IntegrationTests;
 
-[Collection(MySqlCollection.Name)]
+[Collection(MySqlCollectionFixture.Name)]
 public class EntityFrameworkCorePomeloMySqlTests : TestHelper
 {
     private readonly MySqlFixture _mySql;