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

        Loggers should be named for their enclosing types

        consistency - identifiable
        maintainability
        Code Smell
        • confusing
        • logging

        Why is this an issue?

        How can I fix it?

        More Info

        It is a well-established convention to name each logger after its enclosing type. This rule raises an issue when the convention is not respected.

        class EnclosingType
        {
            private readonly ILogger logger;
        
            public EnclosingType(ILoggerFactory loggerFactory)
            {
                logger = loggerFactory.CreateLogger<AnotherType>();   // Noncompliant
                logger = loggerFactory.CreateLogger<EnclosingType>(); // Compliant
            }
        }
        

        Not following such a convention can result in confusion and logging misconfiguration.

        For example, the person configuring the log may attempt to change the logging behavior for the MyNamespace.EnclosingType type, by overriding defaults for the logger named after that type.

        {
            "Logging": {
                "LogLevel": {
                    "Default": "Error",
                    "MyNamespace.EnclosingType": "Debug"
                }
            }
        }
        

        However, if the convention is not in place, the override would not affect logs from MyNamespace.EnclosingType, since they are made via a logger with a different name.

        Moreover, using the same logger name for multiple types prevents the granular configuration of each type’s logger, since there is no way to distinguish them in configuration.

        The rule targets the following logging frameworks: * Microsoft Extensions Logging * Apache log4net * NLog

        Exceptions

        The rule doesn’t raise issues when custom handling of logging names is in place, and the logger name is not derived from a Type.

        class EnclosingType
        {
            private readonly ILogger logger;
        
            EnclosingType(ILoggerFactory loggerFactory)
            {
                logger = loggerFactory.CreateLogger("My cross-type logging category");   // Compliant
                logger = loggerFactory.CreateLogger(AComplexLogicToFindTheRightType());  // Compliant
            }
        }
        
          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