SonarSource Rules
  • Products

    In-IDE

    Code Quality and Security in your IDE with SonarQube Ide

    IDE extension that lets you fix coding issues before they exist!

    Discover SonarQube for IDE

    SaaS

    Code Quality and Security in the cloud with SonarQube Cloud

    Setup is effortless and analysis is automatic for most languages

    Discover SonarQube Cloud

    Self-Hosted

    Code Quality and Security Self-Hosted with SonarQube Server

    Fast, accurate analysis; enterprise scalability

    Discover SonarQube Server
  • SecretsSecrets
  • ABAPABAP
  • AnsibleAnsible
  • ApexApex
  • AzureResourceManagerAzureResourceManager
  • CC
  • C#C#
  • C++C++
  • CloudFormationCloudFormation
  • COBOLCOBOL
  • CSSCSS
  • DartDart
  • DockerDocker
  • FlexFlex
  • GitHub ActionsGitHub Actions
  • GoGo
  • HTMLHTML
  • JavaJava
  • JavaScriptJavaScript
  • JSONJSON
  • JCLJCL
  • KotlinKotlin
  • KubernetesKubernetes
  • Objective CObjective C
  • PHPPHP
  • PL/IPL/I
  • PL/SQLPL/SQL
  • PythonPython
  • RPGRPG
  • RubyRuby
  • RustRust
  • ScalaScala
  • SwiftSwift
  • TerraformTerraform
  • TextText
  • TypeScriptTypeScript
  • T-SQLT-SQL
  • VB.NETVB.NET
  • VB6VB6
  • XMLXML
  • YAMLYAML
C#

C# static code analysis

Unique rules to find Bugs, Vulnerabilities, Security Hotspots, and Code Smells in your C# code

  • All rules 493
  • Vulnerability46
  • Bug88
  • Security Hotspot24
  • Code Smell335

  • Quick Fix 61
Filtered: 15 rules found
logging
    Impact
      Clean code attribute
        1. Use PascalCase for named placeholders

           Code Smell
        2. Message template placeholders should be unique

           Bug
        3. "Trace.WriteLineIf" should not be used with "TraceSwitch" levels

           Code Smell
        4. Log message template should be syntactically correct

           Bug
        5. Log message template placeholders should be in the right order

           Code Smell
        6. Generic logger injection should match enclosing type

           Code Smell
        7. "Trace.Write" and "Trace.WriteLine" should not be used

           Code Smell
        8. Logger field or property name should comply with a naming convention

           Code Smell
        9. Logging arguments should be passed to the correct parameter

           Code Smell
        10. Logging in a catch clause should pass the caught exception as a parameter.

           Code Smell
        11. The code block contains too many logging calls

           Code Smell
        12. Loggers should be named for their enclosing types

           Code Smell
        13. Logging templates should be constant

           Code Smell
        14. Exceptions should be either logged or rethrown but not both

           Code Smell
        15. Logger fields should be "private static readonly"

           Code Smell

        The code block contains too many logging calls

        adaptability - focused
        maintainability
        Code Smell
        • logging

        A code block should not contain too many logging statements of a specific level.

        Why is this an issue?

        How can I fix it?

        More Info

        Excessive logging within a code block can lead to several problems:

        • Log file overload: generating an overwhelming number of log entries can fill up disk space quickly (thus increasing the storage space cost) and make it challenging to identify important log events promptly.
        • Performance degradation: writing a large number of log statements can impact the performance of an application, especially when the logs are placed in frequently executed paths.
        • Code readability and maintainability: excessive logging can clutter the code and increase the code’s complexity, making it difficult for developers to identify essential logic.

        Only the logging statements that are directly within the code block will be counted, and any logging statements within nested blocks will count towards their own. For example consider the snippet below:

        void MyMethod(List<MyObject> items)
        {
            logger.Debug("The operation started");
            foreach(var item in items)
            {
                logger.Debug($"Evaluating {item.Name}");
                var result = Evaluate(item);
                logger.Debug($"Evaluating resulted in {result}");
            }
            logger.Debug("The operation ended");
        }
        

        The rule will count 2 logging statements that are within the method block (namely logger.Debug("The operation started") and logger.Debug("The operation ended")). Any statements within nested blocks, such as the foreach block will be counted separately. The rule considers the log level of the calls, as follows:

        • Debug, Trace and Verbose logging level statements will count together and raise when the Debug threshold parameter is exceeded (default value: 4);
        • Information logging level statements will raise when the Information threshold parameter is exceeded (default value: 2);
        • Warning logging level statements will raise when the Warning threshold parameter is exceeded (default value: 1);
        • Error and Fatal logging level statements will count together and raise when the Error threshold parameter is exceeded (default value: 1);

        The most popular logging frameworks are supported:

        • Nuget package - Microsoft.Extensions.Logging
        • Nuget package - Serilog
        • Nuget package - Castle.Core
        • Nuget package - NLog
        • Nuget package - log4net
          Available In:
        • SonarQube IdeCatch issues on the fly,
          in your IDE
        • SonarQube CloudDetect issues in your GitHub, Azure DevOps Services, Bitbucket Cloud, GitLab repositories
        • SonarQube Community BuildAnalyze code in your
          on-premise CI
          Available Since
          10.5
        • SonarQube ServerAnalyze code in your
          on-premise CI
          Developer Edition
          Available Since
          10.5

        © 2008-2025 SonarSource SA. All rights reserved.

        Privacy Policy | Cookie Policy | Terms of Use