Mute CA1031

Kielek · Kielek · commit 802c07b1cf50 · 2025-12-02T08:05:10.000+01:00
diff --git a/src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/ApplicationInExcludeListRule.cs b/src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/ApplicationInExcludeListRule.cs
@@ -45,7 +45,9 @@ 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;
@@ -58,7 +60,9 @@ 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;
diff --git a/src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/AssemblyFileVersionRule.cs b/src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/AssemblyFileVersionRule.cs
@@ -59,9 +59,11 @@ 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.
+            // 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}");
         }
 
diff --git a/src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/NativeProfilerDiagnosticsRule.cs b/src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/NativeProfilerDiagnosticsRule.cs
@@ -49,7 +49,9 @@ 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.");
diff --git a/src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/OpenTelemetrySdkMinimumVersionRule.cs b/src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/OpenTelemetrySdkMinimumVersionRule.cs
@@ -40,7 +40,9 @@ 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}");
diff --git a/src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/RuleEngine.cs b/src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/RuleEngine.cs
@@ -70,7 +70,9 @@ 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}");
         }
diff --git a/src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/RuntimeStoreDiagnosticRule.cs b/src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/RuntimeStoreDiagnosticRule.cs
@@ -49,7 +49,9 @@ 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;
@@ -84,7 +86,9 @@ 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.");
diff --git a/src/OpenTelemetry.AutoInstrumentation/Logging/InternalLogger.cs b/src/OpenTelemetry.AutoInstrumentation/Logging/InternalLogger.cs
@@ -228,7 +228,9 @@ private void WriteImpl(LogLevel level, Exception? exception, string messageTempl
                 WriteEventSourceLog(level, rawMessage);
             }
         }
+#pragma warning disable CA1031 // Do not catch general exception
         catch (Exception)
+#pragma warning restore CA1031 // Do not catch general exception
         {
             try
             {
@@ -238,7 +240,9 @@ private void WriteImpl(LogLevel level, Exception? exception, string messageTempl
                     : "; " + string.Join(", ", args);
                 Console.Error.WriteLine($"{messageTemplate}{properties}{ex}");
             }
-            catch
+#pragma warning disable CA1031 // Do not catch general exception
+            catch (Exception)
+#pragma warning restore CA1031 // Do not catch general exception
             {
                 // ignore
             }
diff --git a/src/OpenTelemetry.AutoInstrumentation/Logging/OtelLogging.cs b/src/OpenTelemetry.AutoInstrumentation/Logging/OtelLogging.cs
@@ -54,7 +54,9 @@ public static void CloseLogger(string suffix, IOtelLogger otelLogger)
                 otelLogger.Close();
             }
         }
+#pragma warning disable CA1031 // Do not catch general exception
         catch (Exception)
+#pragma warning restore CA1031 // Do not catch general exception
         {
             // intentionally empty
         }
@@ -85,7 +87,9 @@ internal static void Reset()
                 _ => logLevel
             };
         }
+#pragma warning disable CA1031 // Do not catch general exception
         catch (Exception)
+#pragma warning restore CA1031 // Do not catch general exception
         {
             // theoretically, can happen when process has no privileges to check env
         }
@@ -110,7 +114,9 @@ internal static LogSink GetConfiguredLogSink()
                 _ => logSink
             };
         }
+#pragma warning disable CA1031 // Do not catch general exception
         catch (Exception)
+#pragma warning restore CA1031 // Do not catch general exception
         {
             // theoretically, can happen when process has no privileges to check env
         }
@@ -132,7 +138,9 @@ internal static long GetConfiguredFileSizeLimitBytes()
 
             return long.TryParse(configuredFileSizeLimit, out var limit) && limit > 0 ? limit : defaultFileSizeLimitBytes;
         }
+#pragma warning disable CA1031 // Do not catch general exception
         catch (Exception)
+#pragma warning restore CA1031 // Do not catch general exception
         {
             // theoretically, can happen when process has no privileges to check env
             return defaultFileSizeLimitBytes;
@@ -188,7 +196,9 @@ private static ISink CreateSink(string suffix)
                 return new PeriodicFlushToDiskSink(rollingFileSink, TimeSpan.FromSeconds(5));
             }
         }
+#pragma warning disable CA1031 // Do not catch general exception
         catch (Exception)
+#pragma warning restore CA1031 // Do not catch general exception
         {
             // unable to configure logging to a file
         }
@@ -208,7 +218,9 @@ private static string GetLogFileName(string suffix)
                 ? $"otel-dotnet-auto-{process.Id}-{appDomainName}-.log"
                 : $"otel-dotnet-auto-{process.Id}-{appDomainName}-{suffix}-.log";
         }
-        catch
+#pragma warning disable CA1031 // Do not catch general exception
+        catch (Exception)
+#pragma warning restore CA1031 // Do not catch general exception
         {
             // We can't get the process info
             return string.IsNullOrEmpty(suffix)
@@ -250,7 +262,9 @@ private static string GetEncodedAppDomainName()
 
             logDirectory = CreateDirectoryIfMissing(logDirectory) ?? Path.GetTempPath();
         }
-        catch
+#pragma warning disable CA1031 // Do not catch general exception
+        catch (Exception)
+#pragma warning restore CA1031 // Do not catch general exception
         {
             // The try block may throw a SecurityException if not granted the System.Security.Permissions.FileIOPermission
             // because of the following API calls
@@ -272,7 +286,9 @@ private static string GetEncodedAppDomainName()
             Directory.CreateDirectory(pathToCreate);
             return pathToCreate;
         }
-        catch
+#pragma warning disable CA1031 // Do not catch general exception
+        catch (Exception)
+#pragma warning restore CA1031 // Do not catch general exception
         {
             // Unable to create the directory meaning that the user will have to create it on their own.
             // It is unsafe to log here, so return null to defer deciding what the path is

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,9 @@ private static string GetProcessModuleName()`
`45`	`45`	`{`
`46`	`46`	`return Process.GetCurrentProcess().MainModule.ModuleName;`
`47`	`47`	`}`
	`48`	`+#pragma warning disable CA1031 // Do not catch general exception`
`48`	`49`	`catch (Exception ex)`
	`50`	`+#pragma warning restore CA1031 // Do not catch general exception`
`49`	`51`	`{`
`50`	`52`	`Logger.Error($"Error getting Process.MainModule.ModuleName: {ex}");`
`51`	`53`	`return string.Empty;`
`@@ -58,7 +60,9 @@ private static string GetAppDomainName()`
`58`	`60`	`{`
`59`	`61`	`return AppDomain.CurrentDomain.FriendlyName;`
`60`	`62`	`}`
	`63`	`+#pragma warning disable CA1031 // Do not catch general exception`
`61`	`64`	`catch (Exception ex)`
	`65`	`+#pragma warning restore CA1031 // Do not catch general exception`
`62`	`66`	`{`
`63`	`67`	`Logger.Error($"Error getting AppDomain.CurrentDomain.FriendlyName: {ex}");`
`64`	`68`	`return string.Empty;`
Original file line number	Diff line number	Diff line change
`@@ -59,9 +59,11 @@ internal override bool Evaluate()`
`59`	`59`	`}`
`60`	`60`	`}`
`61`	`61`	`}`
	`62`	`+#pragma warning disable CA1031 // Do not catch general exception`
`62`	`63`	`catch (Exception ex)`
	`64`	`+#pragma warning restore CA1031 // Do not catch general exception`
`63`	`65`	`{`
`64`		`- // Exception in rule evaluation should not impact the result of the rule.`
	`66`	`+ // An exception in rule evaluation should not impact the result of the rule.`
`65`	`67`	`Logger.Warning($"Rule Engine: Couldn't evaluate assembly reference file version. Exception: {ex}");`
`66`	`68`	`}`
`67`	`69`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,9 @@ internal override bool Evaluate()`
`49`	`49`
`50`	`50`	`Logger.Error("IsProfilerAttached returned false, the native log should describe the root cause.");`
`51`	`51`	`}`
	`52`	`+#pragma warning disable CA1031 // Do not catch general exception`
`52`	`53`	`catch (Exception ex)`
	`54`	`+#pragma warning restore CA1031 // Do not catch general exception`
`53`	`55`	`{`
`54`	`56`	`/* Native profiler is not attached. Continue with diagnosis */`
`55`	`57`	`Logger.Debug(ex, "Error checking if native profiler is attached.");`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,9 @@ internal override bool Evaluate()`
`40`	`40`	`}`
`41`	`41`	`}`
`42`	`42`	`}`
	`43`	`+#pragma warning disable CA1031 // Do not catch general exception`
`43`	`44`	`catch (Exception ex)`
	`45`	`+#pragma warning restore CA1031 // Do not catch general exception`
`44`	`46`	`{`
`45`	`47`	`// Exception in evaluation should not throw or crash the process.`
`46`	`48`	`logger.Information($"Rule Engine: Couldn't evaluate reference to OpenTelemetry Sdk in an app. Exception: {ex}");`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,9 @@ private static bool EvaluateRule(Rule rule)`
`70`	`70`	`return false;`
`71`	`71`	`}`
`72`	`72`	`}`
	`73`	`+#pragma warning disable CA1031 // Do not catch general exception`
`73`	`74`	`catch (Exception ex)`
	`75`	`+#pragma warning restore CA1031 // Do not catch general exception`
`74`	`76`	`{`
`75`	`77`	`Logger.Warning($"Error evaluating rule '{rule.Name}': {ex.Message}");`
`76`	`78`	`}`
Original file line number	Diff line number	Diff line change
`@@ -228,7 +228,9 @@ private void WriteImpl(LogLevel level, Exception? exception, string messageTempl`
`228`	`228`	`WriteEventSourceLog(level, rawMessage);`
`229`	`229`	`}`
`230`	`230`	`}`
	`231`	`+#pragma warning disable CA1031 // Do not catch general exception`
`231`	`232`	`catch (Exception)`
	`233`	`+#pragma warning restore CA1031 // Do not catch general exception`
`232`	`234`	`{`
`233`	`235`	`try`
`234`	`236`	`{`
`@@ -238,7 +240,9 @@ private void WriteImpl(LogLevel level, Exception? exception, string messageTempl`
`238`	`240`	`: "; " + string.Join(", ", args);`
`239`	`241`	`Console.Error.WriteLine($"{messageTemplate}{properties}{ex}");`
`240`	`242`	`}`
`241`		`- catch`
	`243`	`+#pragma warning disable CA1031 // Do not catch general exception`
	`244`	`+ catch (Exception)`
	`245`	`+#pragma warning restore CA1031 // Do not catch general exception`
`242`	`246`	`{`
`243`	`247`	`// ignore`
`244`	`248`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,9 @@ public static void CloseLogger(string suffix, IOtelLogger otelLogger)`
`54`	`54`	`otelLogger.Close();`
`55`	`55`	`}`
`56`	`56`	`}`
	`57`	`+#pragma warning disable CA1031 // Do not catch general exception`
`57`	`58`	`catch (Exception)`
	`59`	`+#pragma warning restore CA1031 // Do not catch general exception`
`58`	`60`	`{`
`59`	`61`	`// intentionally empty`
`60`	`62`	`}`
`@@ -85,7 +87,9 @@ internal static void Reset()`
`85`	`87`	`_ => logLevel`
`86`	`88`	`};`
`87`	`89`	`}`
	`90`	`+#pragma warning disable CA1031 // Do not catch general exception`
`88`	`91`	`catch (Exception)`
	`92`	`+#pragma warning restore CA1031 // Do not catch general exception`
`89`	`93`	`{`
`90`	`94`	`// theoretically, can happen when process has no privileges to check env`
`91`	`95`	`}`
`@@ -110,7 +114,9 @@ internal static LogSink GetConfiguredLogSink()`
`110`	`114`	`_ => logSink`
`111`	`115`	`};`
`112`	`116`	`}`
	`117`	`+#pragma warning disable CA1031 // Do not catch general exception`
`113`	`118`	`catch (Exception)`
	`119`	`+#pragma warning restore CA1031 // Do not catch general exception`
`114`	`120`	`{`
`115`	`121`	`// theoretically, can happen when process has no privileges to check env`
`116`	`122`	`}`
`@@ -132,7 +138,9 @@ internal static long GetConfiguredFileSizeLimitBytes()`
`132`	`138`
`133`	`139`	`return long.TryParse(configuredFileSizeLimit, out var limit) && limit > 0 ? limit : defaultFileSizeLimitBytes;`
`134`	`140`	`}`
	`141`	`+#pragma warning disable CA1031 // Do not catch general exception`
`135`	`142`	`catch (Exception)`
	`143`	`+#pragma warning restore CA1031 // Do not catch general exception`
`136`	`144`	`{`
`137`	`145`	`// theoretically, can happen when process has no privileges to check env`
`138`	`146`	`return defaultFileSizeLimitBytes;`
`@@ -188,7 +196,9 @@ private static ISink CreateSink(string suffix)`
`188`	`196`	`return new PeriodicFlushToDiskSink(rollingFileSink, TimeSpan.FromSeconds(5));`
`189`	`197`	`}`
`190`	`198`	`}`
	`199`	`+#pragma warning disable CA1031 // Do not catch general exception`
`191`	`200`	`catch (Exception)`
	`201`	`+#pragma warning restore CA1031 // Do not catch general exception`
`192`	`202`	`{`
`193`	`203`	`// unable to configure logging to a file`
`194`	`204`	`}`
`@@ -208,7 +218,9 @@ private static string GetLogFileName(string suffix)`
`208`	`218`	`? $"otel-dotnet-auto-{process.Id}-{appDomainName}-.log"`
`209`	`219`	`: $"otel-dotnet-auto-{process.Id}-{appDomainName}-{suffix}-.log";`
`210`	`220`	`}`
`211`		`- catch`
	`221`	`+#pragma warning disable CA1031 // Do not catch general exception`
	`222`	`+ catch (Exception)`
	`223`	`+#pragma warning restore CA1031 // Do not catch general exception`
`212`	`224`	`{`
`213`	`225`	`// We can't get the process info`
`214`	`226`	`return string.IsNullOrEmpty(suffix)`
`@@ -250,7 +262,9 @@ private static string GetEncodedAppDomainName()`
`250`	`262`
`251`	`263`	`logDirectory = CreateDirectoryIfMissing(logDirectory) ?? Path.GetTempPath();`
`252`	`264`	`}`
`253`		`- catch`
	`265`	`+#pragma warning disable CA1031 // Do not catch general exception`
	`266`	`+ catch (Exception)`
	`267`	`+#pragma warning restore CA1031 // Do not catch general exception`
`254`	`268`	`{`
`255`	`269`	`// The try block may throw a SecurityException if not granted the System.Security.Permissions.FileIOPermission`
`256`	`270`	`// because of the following API calls`
`@@ -272,7 +286,9 @@ private static string GetEncodedAppDomainName()`
`272`	`286`	`Directory.CreateDirectory(pathToCreate);`
`273`	`287`	`return pathToCreate;`
`274`	`288`	`}`
`275`		`- catch`
	`289`	`+#pragma warning disable CA1031 // Do not catch general exception`
	`290`	`+ catch (Exception)`
	`291`	`+#pragma warning restore CA1031 // Do not catch general exception`
`276`	`292`	`{`
`277`	`293`	`// Unable to create the directory meaning that the user will have to create it on their own.`
`278`	`294`	`// It is unsafe to log here, so return null to defer deciding what the path is`