Mute CA1031 on the project level

Author: Kielek

src/OpenTelemetry.AutoInstrumentation.AspNetCoreBootstrapper/BootstrapperHostingStartup.cs

@@ -75,9 +75,7 @@ private static string GetApplicationName()
         {
             return AppDomain.CurrentDomain.FriendlyName;
         }
-#pragma warning disable CA1031 // Do not catch general exception
         catch (Exception ex)
-#pragma warning restore CA1031 // Do not catch general exception
         {
             Logger.Error($"Error getting AppDomain.CurrentDomain.FriendlyName: {ex}");
             return string.Empty;

src/OpenTelemetry.AutoInstrumentation.StartupHook/OpenTelemetry.AutoInstrumentation.StartupHook.csproj

@@ -6,6 +6,8 @@
          Reference: https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/issues/1644 -->
     <TargetFrameworks>netcoreapp3.1</TargetFrameworks>
     <Description>StartupHook used by the OpenTelemetry.AutoInstrumentation project.</Description>
+    <!-- Suppress CA1031 warnings about catching general exception types. In this project we need to catch all exceptions to prevent the application from crashing. -->
+    <NoWarn>$(NoWarn);CA1031</NoWarn>
     <AnalysisLevel>latest-All</AnalysisLevel>
   </PropertyGroup>
 

src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/ApplicationInExcludeListRule.cs

@@ -45,9 +45,7 @@ private static string GetProcessModuleName()
         {
             return Process.GetCurrentProcess().MainModule.ModuleName;
         }
-#pragma warning disable CA1031 // Do not catch general exception
         catch (Exception ex)
-#pragma warning restore CA1031 // Do not catch general exception
         {
             Logger.Error($"Error getting Process.MainModule.ModuleName: {ex}");
             return string.Empty;
@@ -60,9 +58,7 @@ private static string GetAppDomainName()
         {
             return AppDomain.CurrentDomain.FriendlyName;
         }
-#pragma warning disable CA1031 // Do not catch general exception
         catch (Exception ex)
-#pragma warning restore CA1031 // Do not catch general exception
         {
             Logger.Error($"Error getting AppDomain.CurrentDomain.FriendlyName: {ex}");
             return string.Empty;

src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/AssemblyFileVersionRule.cs

@@ -59,9 +59,7 @@ internal override bool Evaluate()
                 }
             }
         }
-#pragma warning disable CA1031 // Do not catch general exception
         catch (Exception ex)
-#pragma warning restore CA1031 // Do not catch general exception
         {
             // An exception in rule evaluation should not impact the result of the rule.
             Logger.Warning($"Rule Engine: Couldn't evaluate assembly reference file version. Exception: {ex}");

src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/NativeProfilerDiagnosticsRule.cs

@@ -49,9 +49,7 @@ internal override bool Evaluate()
 
             Logger.Error("IsProfilerAttached returned false, the native log should describe the root cause.");
         }
-#pragma warning disable CA1031 // Do not catch general exception
         catch (Exception ex)
-#pragma warning restore CA1031 // Do not catch general exception
         {
             /* Native profiler is not attached. Continue with diagnosis */
             Logger.Debug(ex, "Error checking if native profiler is attached.");

src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/OpenTelemetrySdkMinimumVersionRule.cs

@@ -40,9 +40,7 @@ internal override bool Evaluate()
                 }
             }
         }
-#pragma warning disable CA1031 // Do not catch general exception
         catch (Exception ex)
-#pragma warning restore CA1031 // Do not catch general exception
         {
             // Exception in evaluation should not throw or crash the process.
             logger.Information($"Rule Engine: Couldn't evaluate reference to OpenTelemetry Sdk in an app. Exception: {ex}");

src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/RuleEngine.cs

@@ -70,9 +70,7 @@ private static bool EvaluateRule(Rule rule)
                 return false;
             }
         }
-#pragma warning disable CA1031 // Do not catch general exception
         catch (Exception ex)
-#pragma warning restore CA1031 // Do not catch general exception
         {
             Logger.Warning($"Error evaluating rule '{rule.Name}': {ex.Message}");
         }

src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/RuntimeStoreDiagnosticRule.cs

@@ -49,9 +49,7 @@ internal override bool Evaluate()
                 {
                     appInstrumentationAssembly = Assembly.Load(assemblyName);
                 }
-#pragma warning disable CA1031 // Do not catch general exception
                 catch (Exception ex)
-#pragma warning restore CA1031 // Do not catch general exception
                 {
                     Logger.Warning(ex, $"Rule Engine: Assembly load failed. Skipping rule evaluation for assembly - {assemblyName}");
                     continue;
@@ -86,9 +84,7 @@ internal override bool Evaluate()
                 }
             }
         }
-#pragma warning disable CA1031 // Do not catch general exception
         catch (Exception ex)
-#pragma warning restore CA1031 // Do not catch general exception
         {
             // Exception in rule evaluation should not impact the result of the rule.
             Logger.Warning(ex, "Rule Engine: Couldn't evaluate reference to runtime store assemblies in an app.");