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

        Log message template placeholders should be in the right order

        consistency - conventional
        maintainability
        Code Smell
        • logging

        The positions of arguments in a logging call should match the positions of their message template placeholders.

        Why is this an issue?

        How can I fix it?

        More Info

        The placeholders of a message template are defined by their name and their position. Log methods specify the values for the placeholder at runtime by passing them in a params array:

        logger.LogError("{First} placeholder and {Second} one.", first, second);
        

        This rule raises an issue if the position of an argument does not match the position of the corresponding placeholder:

        // 'first' and 'second' are swapped
        logger.LogError("{First} placeholder and {Second} one.", second, first);
        //                                                       ^^^^^^  ^^^^^
        

        What is the potential impact?

        Logging providers use placeholder names to create key/value pairs in the log entry. The key corresponds to the placeholder and the value is the argument passed in the log call.

        If the positions of the placeholder and the argument do not match, the value is associated with the wrong key. This corrupts the logs entry and makes log analytics unreliable.

          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